# Google Cloud Ai Platform V1 Client - Class IndexConfig (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 IndexConfig.

Configuration for vector indexing.

Generated from protobuf message `google.cloud.aiplatform.v1.FeatureView.IndexConfig`

## Namespace

Google \\ Cloud \\ AIPlatform \\ V1 \\ FeatureView

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ tree_ah_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.FeatureView.IndexConfig.TreeAHConfig` Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: <https://arxiv.org/abs/1908.10396> |
| `↳ brute_force_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.FeatureView.IndexConfig.BruteForceConfig` Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search. |
| `↳ embedding_column` | `string` Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search. |
| `↳ filter_columns` | `string[]` Optional. Columns of features that're used to filter vector search results. |
| `↳ crowding_column` | `string` Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by [FeatureOnlineStoreService.SearchNearestEntities](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.FeatureOnlineStoreServiceClient#_Google_Cloud_AIPlatform_V1_Client_FeatureOnlineStoreServiceClient__searchNearestEntities__) to diversify search results. If [NearestNeighborQuery.per_crowding_attribute_neighbor_count](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.NearestNeighborQuery#_Google_Cloud_AIPlatform_V1_NearestNeighborQuery__getPerCrowdingAttributeNeighborCount__) is set to K in [SearchNearestEntitiesRequest](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.SearchNearestEntitiesRequest), it's guaranteed that no more than K entities of the same crowding attribute are returned in the response. |
| `↳ embedding_dimension` | `int` Optional. The number of dimensions of the input embedding. |
| `↳ distance_measure_type` | `int` Optional. The distance measure used in nearest neighbor search. |

### getTreeAhConfig

Optional. Configuration options for the tree-AH algorithm (Shallow tree

- Asymmetric Hashing). Please refer to this paper for more details: <https://arxiv.org/abs/1908.10396>

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

### hasTreeAhConfig

### setTreeAhConfig

Optional. Configuration options for the tree-AH algorithm (Shallow tree

- Asymmetric Hashing). Please refer to this paper for more details: <https://arxiv.org/abs/1908.10396>

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

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

### getBruteForceConfig

Optional. Configuration options for using brute force search, which
simply implements the standard linear search in the database for each
query. It is primarily meant for benchmarking and to generate the
ground truth for approximate search.

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

### hasBruteForceConfig

### setBruteForceConfig

Optional. Configuration options for using brute force search, which
simply implements the standard linear search in the database for each
query. It is primarily meant for benchmarking and to generate the
ground truth for approximate search.

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

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

### getEmbeddingColumn

Optional. Column of embedding. This column contains the source data to
create index for vector search. embedding_column must be set when using
vector search.

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

### setEmbeddingColumn

Optional. Column of embedding. This column contains the source data to
create index for vector search. embedding_column must be set when using
vector search.

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

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

### getFilterColumns

Optional. Columns of features that're used to filter vector search
results.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setFilterColumns

Optional. Columns of features that're used to filter vector search
results.

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

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

### getCrowdingColumn

Optional. Column of crowding. This column contains crowding attribute
which is a constraint on a neighbor list produced by
[FeatureOnlineStoreService.SearchNearestEntities](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.FeatureOnlineStoreServiceClient#_Google_Cloud_AIPlatform_V1_Client_FeatureOnlineStoreServiceClient__searchNearestEntities__)
to diversify search results. If
[NearestNeighborQuery.per_crowding_attribute_neighbor_count](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.NearestNeighborQuery#_Google_Cloud_AIPlatform_V1_NearestNeighborQuery__getPerCrowdingAttributeNeighborCount__)
is set to K in
[SearchNearestEntitiesRequest](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.SearchNearestEntitiesRequest),
it's guaranteed that no more than K entities of the same crowding
attribute are returned in the response.

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

### setCrowdingColumn

Optional. Column of crowding. This column contains crowding attribute
which is a constraint on a neighbor list produced by
[FeatureOnlineStoreService.SearchNearestEntities](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.Client.FeatureOnlineStoreServiceClient#_Google_Cloud_AIPlatform_V1_Client_FeatureOnlineStoreServiceClient__searchNearestEntities__)
to diversify search results. If
[NearestNeighborQuery.per_crowding_attribute_neighbor_count](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.NearestNeighborQuery#_Google_Cloud_AIPlatform_V1_NearestNeighborQuery__getPerCrowdingAttributeNeighborCount__)
is set to K in
[SearchNearestEntitiesRequest](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.SearchNearestEntitiesRequest),
it's guaranteed that no more than K entities of the same crowding
attribute are returned in the response.

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

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

### getEmbeddingDimension

Optional. The number of dimensions of the input embedding.

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

### hasEmbeddingDimension

### clearEmbeddingDimension

### setEmbeddingDimension

Optional. The number of dimensions of the input embedding.

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

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

### getDistanceMeasureType

Optional. The distance measure used in nearest neighbor search.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [DistanceMeasureType](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.FeatureView.IndexConfig.DistanceMeasureType). |

### setDistanceMeasureType

Optional. The distance measure used in nearest neighbor search.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [DistanceMeasureType](https://docs.cloud.google.com/php/docs/reference/cloud-ai-platform/latest/V1.FeatureView.IndexConfig.DistanceMeasureType). |

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

### getAlgorithmConfig

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