# Google Cloud Ai Platform V1 Client - Class PairwiseMetricSpec (1.60.0)

1.60.0 (latest) 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.1 0.10.0 Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PairwiseMetricSpec.

Spec for pairwise metric.

Generated from protobuf message `google.cloud.aiplatform.v1.PairwiseMetricSpec`

## Namespace

Google \\ Cloud \\ AIPlatform \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ metric_prompt_template` | `string` Required. Metric prompt template for pairwise metric. |
| `↳ candidate_response_field_name` | `string` Optional. The field name of the candidate response. |
| `↳ baseline_response_field_name` | `string` Optional. The field name of the baseline response. |
| `↳ system_instruction` | `string` Optional. System instructions for pairwise metric. |
| `↳ custom_output_format_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CustomOutputFormatConfig` Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. |

### getMetricPromptTemplate

Required. Metric prompt template for pairwise metric.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasMetricPromptTemplate

### clearMetricPromptTemplate

### setMetricPromptTemplate

Required. Metric prompt template for pairwise metric.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCandidateResponseFieldName

Optional. The field name of the candidate response.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setCandidateResponseFieldName

Optional. The field name of the candidate response.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBaselineResponseFieldName

Optional. The field name of the baseline response.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setBaselineResponseFieldName

Optional. The field name of the baseline response.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSystemInstruction

Optional. System instructions for pairwise metric.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasSystemInstruction

### clearSystemInstruction

### setSystemInstruction

Optional. System instructions for pairwise metric.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCustomOutputFormatConfig

Optional. CustomOutputFormatConfig allows customization of metric output.

When this config is set, the default output is replaced with
the raw output string.
If a custom format is chosen, the `pairwise_choice` and `explanation`
fields in the corresponding metric result will be empty.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CustomOutputFormatConfig|null` |   |

### hasCustomOutputFormatConfig

### clearCustomOutputFormatConfig

### setCustomOutputFormatConfig

Optional. CustomOutputFormatConfig allows customization of metric output.

When this config is set, the default output is replaced with
the raw output string.
If a custom format is chosen, the `pairwise_choice` and `explanation`
fields in the corresponding metric result will be empty.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.CustomOutputFormatConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |