1.66.2 (latest) 1.63.0 1.60.0 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 Examples.

Example-based explainability that returns the nearest neighbors from the
provided dataset.

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

## Namespace

Google \\ Cloud \\ AIPlatform \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ example_gcs_source` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Examples.ExampleGcsSource` The Cloud Storage input instances. |
| `↳ nearest_neighbor_search_config` | `Google\Protobuf\Value` The full configuration for the generated index, the semantics are the same as [metadata](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Index#_Google_Cloud_AIPlatform_V1_Index__getMetadata__) and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). |
| `↳ presets` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Presets` Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality. |
| `↳ neighbor_count` | `int` The number of neighbors to return when querying for examples. |

### getExampleGcsSource

The Cloud Storage input instances.

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

### hasExampleGcsSource

### setExampleGcsSource

The Cloud Storage input instances.

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

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

### getNearestNeighborSearchConfig

The full configuration for the generated index, the semantics are the
same as [metadata](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Index#_Google_Cloud_AIPlatform_V1_Index__getMetadata__) and should
match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\Value|null` |   |

### hasNearestNeighborSearchConfig

### setNearestNeighborSearchConfig

The full configuration for the generated index, the semantics are the
same as [metadata](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Index#_Google_Cloud_AIPlatform_V1_Index__getMetadata__) and should
match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `Google\Protobuf\Value` |

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

### getPresets

Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.

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

### hasPresets

### setPresets

Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.

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

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

### getNeighborCount

The number of neighbors to return when querying for examples.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setNeighborCount

The number of neighbors to return when querying for examples.

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

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

### getSource

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

### getConfig

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