Expand description
API types
Modules§
- Nested message and enum types in
AliasOperations. - Generated client implementations.
- Generated server implementations.
- Nested message and enum types in
Condition. - Nested message and enum types in
FacetValue. - Nested message and enum types in
GroupId. - Nested message and enum types in
Match. - Nested message and enum types in
OrderValue. - Nested message and enum types in
PayloadIndexParams. - Nested message and enum types in
PointId. - Generated client implementations.
- Nested message and enum types in
PointsSelector. - Generated server implementations.
- Nested message and enum types in
PointsUpdateOperation. - Generated client implementations.
- Generated server implementations.
- Nested message and enum types in
QuantizationConfig. - Nested message and enum types in
QuantizationConfigDiff. - Nested message and enum types in
Query. - Nested message and enum types in
ReadConsistency. - Nested message and enum types in
ShardKey. - Generated client implementations.
- Generated server implementations.
- Nested message and enum types in
StartFrom. - Nested message and enum types in
TargetVector. - Nested message and enum types in
UpdateCollectionClusterSetupRequest. - Nested message and enum types in
Value. - Nested message and enum types in
VectorExample. - Nested message and enum types in
VectorInput. - Nested message and enum types in
Vectors. - Nested message and enum types in
VectorsConfig. - Nested message and enum types in
VectorsConfigDiff. - Nested message and enum types in
WithPayloadSelector. - Nested message and enum types in
WithVectorsSelector.
Structs§
- Builder for
AbortShardTransfer. - Builder for
BinaryQuantization. - Builder for
ClearPayloadPoints. - Builder for
CollectionParamsDiff. - Builder for
ContextExamplePair. - Builder for
ContextInput. - Builder for
ContextInputPair. - Builder for
CountPoints. - Builder for
CreateAlias. - Builder for
CreateCollection. - Builder for
CreateFieldIndexCollection. - Builder for
CreateShardKey. - Builder for
CreateShardKeyRequest. - Builder for
DatetimeIndexParams. - Builder for
DeleteCollection. - Builder for
DeleteFieldIndexCollection. - Builder for
DeletePayloadPoints. - Builder for
DeletePointVectors. - Builder for
DeletePoints. - Builder for
DeleteShardKeyRequest. - Builder for
DeleteSnapshotRequest. - Builder for
DiscoverBatchPoints. - Builder for
DiscoverInput. - Builder for
DiscoverPoints. - Builder for
FacetCounts. - Builder for
FloatIndexParams. - Builder for
GeoIndexParams. - For a valid GeoPolygon, both the exterior and interior GeoLineStrings must consist of a minimum of 4 points. Additionally, the first and last points of each GeoLineString must be the same.
- Builder for
GetPoints. - Builder for
HnswConfigDiff. - Builder for
IntegerIndexParams. - Builder for
KeywordIndexParams. ListValueis a wrapper around a repeated field of values.- Builder for
LookupLocation. - Builder for
MoveShard. - Builder for
MultiVectorConfig. - Builder for
OptimizersConfigDiff. - Builder for
OrderBy. - Builder for
PrefetchQuery. - Builder for
ProductQuantization. - Builder for
QuantizationSearchParams. - Builder for
QueryBatchPoints. - Builder for
QueryPointGroups. - Builder for
QueryPoints. - Builder for
RecommendBatchPoints. - Builder for
RecommendInput. - Builder for
RecommendPointGroups. - Builder for
RecommendPoints. - Builder for
RenameAlias. - Builder for
Replica. - Builder for
ReplicateShard. - Builder for
ScalarQuantization. - Builder for
ScrollPoints. - Builder for
SearchBatchPoints. - Builder for
SearchMatrixPoints. - Builder for
SearchParams. - Builder for
SearchPointGroups. - Builder for
SearchPoints. - Builder for
SetPayloadPoints. - Builder for
SnapshotDownload. - Builder for
SparseIndexConfig. - Builder for
SparseVectorParams. - Builder for
StrictModeConfig. Structrepresents a structured data value, consisting of fields which map to dynamically typed values. In some languages,Structmight be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.- Builder for
TextIndexParams. - A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
- Builder for
UpdateBatchPoints. - Builder for
UpdateCollection. - Builder for
UpdateCollectionClusterSetupRequest. - Builder for
UpdatePointVectors. - Builder for
UpsertPoints. - Builder for
UuidIndexParams. Valuerepresents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of those variants, absence of any variant indicates an error.- Legacy vector format, which determines the vector type by the configuration of its fields.
- Vector type to be used in queries. Ids will be substituted with their corresponding vectors from the collection.
- Builder for
VectorParams. - Builder for
VectorParamsDiff. - Builder for
WalConfigDiff. - Builder for
WithLookup.
Enums§
- Error type for AbortShardTransferBuilder
- Error type for BinaryQuantizationBuilder
- Error type for ClearPayloadPointsBuilder
- Error type for ContextInputPairBuilder
- Error type for CountPointsBuilder
- Error type for CreateAliasBuilder
- Error type for CreateFieldIndexCollectionBuilder
- Error type for CreateShardKeyRequestBuilder
- Error type for DeleteCollectionBuilder
- Error type for DeleteFieldIndexCollectionBuilder
- Error type for DeletePayloadPointsBuilder
- Error type for DeletePointVectorsBuilder
- Error type for DeletePointsBuilder
- Error type for DeleteShardKeyRequestBuilder
- Error type for DeleteSnapshotRequestBuilder
- Error type for DiscoverBatchPointsBuilder
- Error type for DiscoverInputBuilder
- Error type for DiscoverPointsBuilder
- Error type for FacetCountsBuilder
- Error type for GetPointsBuilder
- Error type for IntegerIndexParamsBuilder
- Error type for LookupLocationBuilder
- Error type for MoveShardBuilder
- Error type for MultiVectorConfigBuilder
NullValueis a singleton enumeration to represent the null value for theValuetype union.- Error type for OrderByBuilder
- Error type for ProductQuantizationBuilder
- Error type for QueryBatchPointsBuilder
- Error type for QueryPointGroupsBuilder
- Error type for QueryPointsBuilder
- Error type for RecommendBatchPointsBuilder
- Error type for RecommendPointGroupsBuilder
- Error type for RecommendPointsBuilder
- How to use positive and negative vectors to find the results, default is
AverageVector. - Error type for RenameAliasBuilder
- Error type for ReplicaBuilder
- Error type for ReplicateShardBuilder
- Sample points from the collection
- Error type for ScalarQuantizationBuilder
- Error type for ScrollPointsBuilder
- Error type for SearchBatchPointsBuilder
- Error type for SearchMatrixPointsBuilder
- Error type for SearchPointGroupsBuilder
- Error type for SearchPointsBuilder
- Error type for SetPayloadPointsBuilder
- Error type for SnapshotDownloadBuilder
- Error type for TextIndexParamsBuilder
- Error type for UpdateBatchPointsBuilder
- Error type for UpdateCollectionBuilder
- Error type for UpdateCollectionClusterSetupRequestBuilder
- Error type for UpdatePointVectorsBuilder
- Error type for UpsertPointsBuilder
- Error type for VectorParamsBuilder
- Error type for WithLookupBuilder