Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig.
The index configuration to support vector search operations
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#dimension
defdimension()->::Integer
Returns
(::Integer) — 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.
#dimension=
defdimension=(value)->::Integer
Parameter
value (::Integer) — 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.
Returns
(::Integer) — 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 Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig (v1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [1.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.6.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [1.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.5.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [1.4.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.4.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [1.3.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.3.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [1.2.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.2.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [1.1.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.1.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [1.0.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.0.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.18.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.18.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.17.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.17.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.16.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.16.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.15.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.15.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.14.3](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.14.3/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.13.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.13.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.12.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.12.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.11.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.11.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.10.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.10.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.9.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.9.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.8.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.8.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.7.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.7.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.6.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.5.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.4.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.4.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)\n- [0.3.5](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.3.5/Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig) \nReference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig.\n\nThe index configuration to support vector search operations \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #dimension\n\n def dimension() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Required. The vector dimension this configuration applies to.\n\n The resulting index will only include vectors of this dimension, and\n can be used for vector search with the same dimension.\n\n### #dimension=\n\n def dimension=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Required. The vector dimension this configuration applies to.\n\n\n The resulting index will only include vectors of this dimension, and\ncan be used for vector search with the same dimension. \n**Returns**\n\n- (::Integer) --- Required. The vector dimension this configuration applies to.\n\n The resulting index will only include vectors of this dimension, and\n can be used for vector search with the same dimension.\n\n### #flat\n\n def flat() -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig::FlatIndex\n\n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig::FlatIndex](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig-FlatIndex)) --- Indicates the vector index is a flat index.\n\n### #flat=\n\n def flat=(value) -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig::FlatIndex\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig::FlatIndex](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig-FlatIndex)) --- Indicates the vector index is a flat index. \n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig::FlatIndex](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig-FlatIndex)) --- Indicates the vector index is a flat index."]]