Reference documentation and code samples for the Cloud Firestore V1 Client class VectorConfig.
The index configuration to support vector search operations
Generated from protobuf message google.firestore.admin.v1.Index.IndexField.VectorConfig
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ Index \ IndexField
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ dimension
int
Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class VectorConfig (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.Index.IndexField.VectorConfig)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.Index.IndexField.VectorConfig)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.Index.IndexField.VectorConfig)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.Index.IndexField.VectorConfig)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.Index.IndexField.VectorConfig)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.Index.IndexField.VectorConfig)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.Index.IndexField.VectorConfig)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.Index.IndexField.VectorConfig)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.Index.IndexField.VectorConfig)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.Index.IndexField.VectorConfig) \nReference documentation and code samples for the Cloud Firestore V1 Client class VectorConfig.\n\nThe index configuration to support vector search operations\n\nGenerated from protobuf message `google.firestore.admin.v1.Index.IndexField.VectorConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1 \\\\ Index \\\\ IndexField\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDimension\n\nRequired. The vector dimension this configuration applies to.\n\nThe resulting index will only include vectors of this dimension, and\ncan be used for vector search with the same dimension.\n\n### setDimension\n\nRequired. The vector dimension this configuration applies to.\n\nThe resulting index will only include vectors of this dimension, and\ncan be used for vector search with the same dimension.\n\n### getFlat\n\nIndicates the vector index is a flat index.\n\n### hasFlat\n\n### setFlat\n\nIndicates the vector index is a flat index.\n\n### getType"]]