qdrant_client.http.models.models module

class AbortReshardingOperation(*, abort_resharding: Any)

基类: BaseModel

abort_resharding: Any

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class AbortShardTransfer(*, shard_id: int, to_peer_id: int, from_peer_id: int)

基类: BaseModel

from_peer_id: int

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_id: int

to_peer_id: int

class AbortTransferOperation(*, abort_transfer: AbortShardTransfer)

基类: BaseModel

abort_transfer: AbortShardTransfer

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class AbsExpression(*, abs: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition,NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression])

基类: BaseModel

abs: Expression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class AliasDescription(*, alias_name: str, collection_name: str)

基类: BaseModel

alias_name: str

collection_name: str

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class AppBuildTelemetry(*, name: str, version: str, features: Optional[AppFeaturesTelemetry] = None, system: Optional[RunningEnvironmentTelemetry] = None, jwt_rbac: Optional[bool] = None, hide_jwt_dashboard: Optional[bool] = None, startup: Union[datetime, date])

基类: BaseModel

features: Optional[AppFeaturesTelemetry]

hide_jwt_dashboard: Optional[bool]

jwt_rbac: Optional[bool]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

name: str

startup: Union[datetime, date]

system: Optional[RunningEnvironmentTelemetry]

version: str

class AppFeaturesTelemetry(*, debug: bool, web_feature: bool, service_debug_feature: bool, recovery_mode: bool, gpu: bool)

基类: BaseModel

debug: bool

gpu: bool

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

recovery_mode: bool

service_debug_feature: bool

web_feature: bool

class Batch(*, ids: List[Union[int, str]], vectors: Union[List[List[float]], List[List[List[float]]], Dict[str, List[Union[List[float], SparseVector, List[List[float]], Document, Image, InferenceObject]]], List[Document], List[Image], List[InferenceObject]], payloads: Optional[List[Dict[str, Any]]] = None)

基类: BaseModel

ids: List[ExtendedPointId]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

payloads: Optional[List[Payload]]

vectors: BatchVectorStruct

class BinaryQuantization(*, binary: BinaryQuantizationConfig)

基类: BaseModel

binary: BinaryQuantizationConfig

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class BinaryQuantizationConfig(*, always_ram: Optional[bool] = None)

基类: BaseModel

always_ram: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class BoolIndexParams(*, type: BoolIndexType, on_disk: Optional[bool] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

type: BoolIndexType

class BoolIndexType(value)

基类: str, Enum

一个枚举。

BOOL = 'bool'

class ChangeAliasesOperation(*, actions: List[Union[CreateAliasOperation, DeleteAliasOperation, RenameAliasOperation]])

基类: BaseModel

用于执行集合别名更改的操作。别名更改是原子性的，这意味着在别名操作期间不会发生集合修改。

actions: List[AliasOperations]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ClearPayloadOperation(*, clear_payload: Union[PointIdsList, FilterSelector])

基类: BaseModel

clear_payload: PointsSelector

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ClusterConfigTelemetry(*, grpc_timeout_ms: int, p2p: P2pConfigTelemetry, consensus: ConsensusConfigTelemetry)

基类: BaseModel

consensus: ConsensusConfigTelemetry

grpc_timeout_ms: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

p2p: P2pConfigTelemetry

class ClusterStatusOneOf(*, status: Literal['disabled'])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

status: Literal['disabled']

class ClusterStatusOneOf1(*, status: Literal['enabled'], peer_id: int, peers: Dict[str, PeerInfo], raft_info: RaftInfo, consensus_thread_status: Union[ConsensusThreadStatusOneOf, ConsensusThreadStatusOneOf1, ConsensusThreadStatusOneOf2], message_send_failures: Dict[str, MessageSendErrors])

基类: BaseModel

已启用集群的描述

consensus_thread_status: ConsensusThreadStatus

message_send_failures: Dict[str, MessageSendErrors]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peer_id: int

peers: Dict[str, PeerInfo]

raft_info: RaftInfo

status: Literal['enabled']

class ClusterStatusTelemetry(*, number_of_peers: int, term: int, commit: int, pending_operations: int, role: Optional[StateRole] = None, is_voter: bool, peer_id: Optional[int] = None, consensus_thread_status: Union[ConsensusThreadStatusOneOf, ConsensusThreadStatusOneOf1, ConsensusThreadStatusOneOf2])

基类: BaseModel

commit: int

consensus_thread_status: ConsensusThreadStatus

is_voter: bool

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

number_of_peers: int

peer_id: Optional[int]

pending_operations: int

role: Optional[StateRole]

term: int

class ClusterTelemetry(*, enabled: bool, status: Optional[ClusterStatusTelemetry] = None, config: Optional[ClusterConfigTelemetry] = None, peers: Optional[Dict[str, PeerInfo]] = None, metadata: Optional[Dict[str, Any]] = None)

基类: BaseModel

config: Optional[ClusterConfigTelemetry]

enabled: bool

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peers: Optional[Dict[str, PeerInfo]]

status: Optional[ClusterStatusTelemetry]

class CollectionClusterInfo(*, peer_id: int, shard_count: int, local_shards: List[LocalShardInfo], remote_shards: List[RemoteShardInfo], shard_transfers: List[ShardTransferInfo], resharding_operations: Optional[List[ReshardingInfo]] = None)

基类: BaseModel

集合的当前集群分布

local_shards: List[LocalShardInfo]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peer_id: int

remote_shards: List[RemoteShardInfo]

resharding_operations: Optional[List[ReshardingInfo]]

shard_count: int

shard_transfers: List[ShardTransferInfo]

class CollectionConfig(*, params: CollectionParams, hnsw_config: HnswConfig, optimizer_config: OptimizersConfig, wal_config: Optional[WalConfig] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, strict_mode_config: Optional[StrictModeConfigOutput] = None)

基类: BaseModel

关于集合配置的信息

hnsw_config: HnswConfig

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

optimizer_config: OptimizersConfig

params: CollectionParams

quantization_config: Optional[QuantizationConfig]

strict_mode_config: Optional[StrictModeConfigOutput]

wal_config: Optional[WalConfig]

class CollectionConfigTelemetry(*, params: CollectionParams, hnsw_config: HnswConfig, optimizer_config: OptimizersConfig, wal_config: WalConfig, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, strict_mode_config: Optional[StrictModeConfigOutput] = None, uuid: Optional[UUID] = None)

基类: BaseModel

hnsw_config: HnswConfig

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

optimizer_config: OptimizersConfig

params: CollectionParams

quantization_config: Optional[QuantizationConfig]

strict_mode_config: Optional[StrictModeConfigOutput]

uuid: Optional[UUID]

wal_config: WalConfig

class CollectionDescription(*, name: str)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

name: str

class CollectionExistence(*, exists: bool)

基类: BaseModel

集合的存在状态，true 表示存在，false 表示不存在

exists: bool

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CollectionInfo(*, status: CollectionStatus, optimizer_status: Union[OptimizersStatusOneOf, OptimizersStatusOneOf1], vectors_count: Optional[int] = None, indexed_vectors_count: Optional[int] = None, points_count: Optional[int] = None, segments_count: int, config: CollectionConfig, payload_schema: Dict[str, PayloadIndexInfo])

基类: BaseModel

集合的当前统计信息和配置

config: CollectionConfig

indexed_vectors_count: Optional[int]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

optimizer_status: OptimizersStatus

payload_schema: Dict[str, PayloadIndexInfo]

points_count: Optional[int]

segments_count: int

status: CollectionStatus

vectors_count: Optional[int]

class CollectionParams(*, vectors: Optional[Union[VectorParams, Dict[str, VectorParams]]] = None, shard_number: Optional[int] = 1, sharding_method: Optional[ShardingMethod] = None, replication_factor: Optional[int] = 1, write_consistency_factor: Optional[int] = 1, read_fan_out_factor: Optional[int] = None, on_disk_payload: Optional[bool] = True, sparse_vectors: Optional[Dict[str, SparseVectorParams]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk_payload: Optional[bool]

read_fan_out_factor: Optional[int]

replication_factor: Optional[int]

shard_number: Optional[int]

sharding_method: Optional[ShardingMethod]

sparse_vectors: Optional[Dict[str, SparseVectorParams]]

vectors: Optional[VectorsConfig]

write_consistency_factor: Optional[int]

class CollectionParamsDiff(*, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, read_fan_out_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk_payload: Optional[bool]

read_fan_out_factor: Optional[int]

replication_factor: Optional[int]

write_consistency_factor: Optional[int]

class CollectionStatus(value)

基类: str, Enum

集合的当前状态。Green - 一切正常。Yellow - 优化正在运行，'Grey' - 优化可能进行但尚未触发，Red - 某些操作失败且未恢复

GREEN = 'green'

GREY = 'grey'

RED = 'red'

YELLOW = 'yellow'

class CollectionTelemetry(*, id: str, init_time_ms: int, config: CollectionConfigTelemetry, shards: Optional[List[ReplicaSetTelemetry]] = None, transfers: Optional[List[ShardTransferInfo]] = None, resharding: Optional[List[ReshardingInfo]] = None, shard_clean_tasks: Optional[Dict[str, Union[ShardCleanStatusTelemetryOneOf, ShardCleanStatusTelemetryOneOf1,ShardCleanStatusTelemetryOneOf2]]] = None)

基类: BaseModel

config: CollectionConfigTelemetry

id: str

init_time_ms: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

resharding: Optional[List[ReshardingInfo]]

shard_clean_tasks: Optional[Dict[str, ShardCleanStatusTelemetry]]

shards: Optional[List[ReplicaSetTelemetry]]

transfers: Optional[List[ShardTransferInfo]]

class CollectionsAggregatedTelemetry(*, vectors: int, optimizers_status: Union[OptimizersStatusOneOf, OptimizersStatusOneOf1], params: CollectionParams)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

optimizers_status: OptimizersStatus

params: CollectionParams

vectors: int

class CollectionsAliasesResponse(*, aliases: List[AliasDescription])

基类: BaseModel

aliases: List[AliasDescription]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CollectionsResponse(*, collections: List[CollectionDescription])

基类: BaseModel

collections: List[CollectionDescription]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CollectionsTelemetry(*, number_of_collections: int, collections: Optional[List[Union[CollectionTelemetry, CollectionsAggregatedTelemetry]]] = None)

基类: BaseModel

collections: Optional[List[CollectionTelemetryEnum]]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

number_of_collections: int

class CompressionRatio(value)

基类: str, Enum

一个枚举。

X16 = 'x16'

X32 = 'x32'

X4 = 'x4'

X64 = 'x64'

X8 = 'x8'

class ConsensusConfigTelemetry(*, max_message_queue_size: int, tick_period_ms: int, bootstrap_timeout_sec: int)

基类: BaseModel

bootstrap_timeout_sec: int

max_message_queue_size: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

tick_period_ms: int

class ConsensusThreadStatusOneOf(*, consensus_thread_status: Literal['working'], last_update: Union[datetime, date])

基类: BaseModel

consensus_thread_status: Literal['working']

last_update: Union[datetime, date]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ConsensusThreadStatusOneOf1(*, consensus_thread_status: Literal['stopped'])

基类: BaseModel

consensus_thread_status: Literal['stopped']

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ConsensusThreadStatusOneOf2(*, consensus_thread_status: Literal['stopped_with_err'], err: str)

基类: BaseModel

consensus_thread_status: Literal['stopped_with_err']

err: str

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ContextExamplePair(*, positive: Union[int, str, List[float], SparseVector], negative: Union[int, str, List[float], SparseVector])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

negative: RecommendExample

positive: RecommendExample

class ContextPair(*, positive: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image,InferenceObject], negative: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image,InferenceObject])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

negative: VectorInput

positive: VectorInput

class ContextQuery(*, context: Union[ContextPair, List[ContextPair]])

基类: BaseModel

context: ContextInput

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CountRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, filter: Optional[Filter] = None, exact: Optional[bool] = True)

基类: BaseModel

计数请求。计算满足给定过滤条件的数据点的数量。如果未提供过滤条件，则返回集合中所有数据点的数量。

exact: Optional[bool]

filter: Optional[Filter]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_key: Optional[ShardKeySelector]

class CountResult(*, count: int)

基类: BaseModel

count: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CpuEndian(value)

基类: str, Enum

一个枚举。

BIG = 'big'

LITTLE = 'little'

OTHER = 'other'

class CreateAlias(*, collection_name: str, alias_name: str)

基类: BaseModel

为集合创建备用名称。集合将可以通过这两个名称进行搜索、检索等，

alias_name: str

collection_name: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CreateAliasOperation(*, create_alias: CreateAlias)

基类: BaseModel

create_alias: CreateAlias

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CreateCollection(*, vectors: Optional[Union[VectorParams, Dict[str, VectorParams]]] = None, shard_number: Optional[int] = None, sharding_method: Optional[ShardingMethod] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[HnswConfigDiff] = None, wal_config: Optional[WalConfigDiff] = None, optimizers_config: Optional[OptimizersConfigDiff] = None, init_from: Optional[InitFrom] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, sparse_vectors: Optional[Dict[str, SparseVectorParams]] = None, strict_mode_config: Optional[StrictModeConfig] = None)

基类: BaseModel

用于创建新集合并（可选地）指定索引参数的操作。

hnsw_config: Optional[HnswConfigDiff]

init_from: Optional[InitFrom]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk_payload: Optional[bool]

optimizers_config: Optional[OptimizersConfigDiff]

quantization_config: Optional[QuantizationConfig]

replication_factor: Optional[int]

shard_number: Optional[int]

sharding_method: Optional[ShardingMethod]

sparse_vectors: Optional[Dict[str, SparseVectorParams]]

strict_mode_config: Optional[StrictModeConfig]

vectors: Optional[VectorsConfig]

wal_config: Optional[WalConfigDiff]

write_consistency_factor: Optional[int]

class CreateFieldIndex(*, field_name: str, field_schema: Optional[Union[PayloadSchemaType, KeywordIndexParams,IntegerIndexParams, FloatIndexParams, GeoIndexParams, TextIndexParams, BoolIndexParams, DatetimeIndexParams, UuidIndexParams]] = None)

基类: BaseModel

field_name: str

field_schema: Optional[PayloadFieldSchema]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class CreateShardingKey(*, shard_key: Union[int, str], shards_number: Optional[int] = None, replication_factor: Optional[int] = None, placement: Optional[List[int]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

placement: Optional[List[int]]

replication_factor: Optional[int]

shard_key: ShardKey

shards_number: Optional[int]

class CreateShardingKeyOperation(*, create_sharding_key: CreateShardingKey)

基类: BaseModel

create_sharding_key: CreateShardingKey

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class Datatype(value)

基类: str, Enum

一个枚举。

FLOAT16 = 'float16'

FLOAT32 = 'float32'

UINT8 = 'uint8'

class DatetimeExpression(*, datetime: str)

基类: BaseModel

datetime: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DatetimeIndexParams(*, type: DatetimeIndexType, is_principal: Optional[bool] = None, on_disk: Optional[bool] = None)

基类: BaseModel

is_principal: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

type: DatetimeIndexType

class DatetimeIndexType(value)

基类: str, Enum

一个枚举。

DATETIME = 'datetime'

class DatetimeKeyExpression(*, datetime_key: str)

基类: BaseModel

datetime_key: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DatetimeRange(*, lt: Optional[Union[datetime, date]] = None, gt: Optional[Union[datetime, date]] = None, gte: Optional[Union[datetime, date]] = None, lte: Optional[Union[datetime, date]] = None)

基类: BaseModel

范围过滤请求

gt: Optional[Union[datetime, date]]

gte: Optional[Union[datetime, date]]

lt: Optional[Union[datetime, date]]

lte: Optional[Union[datetime, date]]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DecayParamsExpression(*, x: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression], target: Optional[Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression,GaussDecayExpression]] = None, scale: Optional[float] = None, midpoint: Optional[float] = None)

基类: BaseModel

midpoint: Optional[float]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

scale: Optional[float]

target: Optional[Expression]

x: Expression

class DeleteAlias(*, alias_name: str)

基类: BaseModel

如果别名存在，则删除

alias_name: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DeleteAliasOperation(*, delete_alias: DeleteAlias)

基类: BaseModel

如果别名存在，则删除

delete_alias: DeleteAlias

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DeleteOperation(*, delete: Union[PointIdsList, FilterSelector])

基类: BaseModel

delete: PointsSelector

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DeletePayload(*, keys: List[str], points: Optional[List[Union[int, str]]] = None, filter: Optional[Filter] = None, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

此数据结构用于API接口，并应用于多个分片

filter: Optional[Filter]

keys: List[str]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points: Optional[List[ExtendedPointId]]

shard_key: Optional[ShardKeySelector]

class DeletePayloadOperation(*, delete_payload: DeletePayload)

基类: BaseModel

delete_payload: DeletePayload

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DeleteVectors(*, points: Optional[List[Union[int, str]]] = None, filter: Optional[Filter] = None, vector: List[str], shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

filter: Optional[Filter]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points: Optional[List[ExtendedPointId]]

shard_key: Optional[ShardKeySelector]

vector: List[str]

class DeleteVectorsOperation(*, delete_vectors: DeleteVectors)

基类: BaseModel

delete_vectors: DeleteVectors

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class Direction(value)

基类: str, Enum

一个枚举。

ASC = 'asc'

DESC = 'desc'

class Disabled(value)

基类: str, Enum

一个枚举。

DISABLED = 'Disabled'

class DiscoverInput(*, target: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject], context: Union[List[ContextPair], ContextPair])

基类: BaseModel

context: Union[List[ContextPair], ContextPair]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

target: VectorInput

class DiscoverQuery(*, discover: DiscoverInput)

基类: BaseModel

discover: DiscoverInput

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DiscoverRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, target: Optional[Union[int, str, List[float], SparseVector]] = None, context: Optional[List[ContextExamplePair]] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, limit: int, offset: Optional[int] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, using: Optional[str] = None, lookup_from: Optional[LookupLocation] = None)

基类: BaseModel

使用上下文和目标查找最相似的点，受上下文约束。

context: Optional[List[ContextExamplePair]]

filter: Optional[Filter]

limit: int

lookup_from: Optional[LookupLocation]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

offset: Optional[int]

params: Optional[SearchParams]

shard_key: Optional[ShardKeySelector]

target: Optional[RecommendExample]

using: Optional[UsingVector]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class DiscoverRequestBatch(*, searches: List[DiscoverRequest])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

searches: List[DiscoverRequest]

class Distance(value)

基类: str, Enum

内部标签的类型，由用于比较向量的有效负载距离函数类型构建

COSINE = 'Cosine'

DOT = 'Dot'

EUCLID = 'Euclid'

MANHATTAN = 'Manhattan'

class DivExpression(*, div: DivParams)

基类: BaseModel

div: DivParams

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DivParams(*, left: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression], right: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression], by_zero_default: Optional[float] = None)

基类: BaseModel

by_zero_default: Optional[float]

left: Expression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

right: Expression

class Document(*, text: str, model: str, options: Optional[Dict[str, Any]] = None)

基类: BaseModel

警告：正在开发中，未实现的用于嵌入的文本文档。需要推理基础设施，未实现。

model: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

options: Optional[Dict[str, Any]]

text: str

class DropReplicaOperation(*, drop_replica: Replica)

基类: BaseModel

drop_replica: Replica

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class DropShardingKey(*, shard_key: Union[int, str])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_key: ShardKey

class DropShardingKeyOperation(*, drop_sharding_key: DropShardingKey)

基类: BaseModel

drop_sharding_key: DropShardingKey

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ErrorResponse(*, time: Optional[float] = None, status: Optional[ErrorResponseStatus] = None, result: Optional[Any] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[Any]

status: Optional[ErrorResponseStatus]

time: Optional[float]

class ErrorResponseStatus(*, error: Optional[str] = None)

基类: BaseModel

error: Optional[str]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ExpDecayExpression(*, exp_decay: DecayParamsExpression)

基类: BaseModel

exp_decay: DecayParamsExpression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ExpExpression(*, exp: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression])

基类: BaseModel

exp: Expression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class FacetRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, key: str, limit: Optional[int] = None, filter: Optional[Filter] = None, exact: Optional[bool] = None)

基类: BaseModel

exact: Optional[bool]

filter: Optional[Filter]

key: str

limit: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_key: Optional[ShardKeySelector]

class FacetResponse(*, hits: List[FacetValueHit])

基类: BaseModel

hits: List[FacetValueHit]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class FacetValueHit(*, value: Union[bool, int, str], count: int)

基类: BaseModel

count: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

value: FacetValue

class FieldCondition(*, key: str, match: Optional[Union[MatchValue, MatchText, MatchAny, MatchExcept]] = None, range: Optional[Union[Range, DatetimeRange]] = None, geo_bounding_box: Optional[GeoBoundingBox] = None, geo_radius: Optional[GeoRadius] = None, geo_polygon: Optional[GeoPolygon] = None, values_count: Optional[ValuesCount] = None, is_empty: Optional[bool] = None, is_null: Optional[bool] = None)

基类: BaseModel

所有可能的有效负载过滤条件

geo_bounding_box: Optional[GeoBoundingBox]

geo_polygon: Optional[GeoPolygon]

geo_radius: Optional[GeoRadius]

is_empty: Optional[bool]

is_null: Optional[bool]

key: str

match: Optional[Match]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

range: Optional[RangeInterface]

values_count: Optional[ValuesCount]

class Filter(*, should: Optional[Union[List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition,Filter]], FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition,Filter]] = None, min_should: Optional[MinShould] = None, must: Optional[Union[List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition,Filter]], FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition,Filter]] = None, must_not: Optional[Union[List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition,Filter]], FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition,Filter]] = None)

基类: BaseModel

min_should: Optional[MinShould]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

must: Optional[Union[List[Condition], Condition]]

must_not: Optional[Union[List[Condition], Condition]]

should: Optional[Union[List[Condition], Condition]]

class FilterSelector(*, filter: Filter, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

filter: Filter

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_key: Optional[ShardKeySelector]

class FloatIndexParams(*, type: FloatIndexType, is_principal: Optional[bool] = None, on_disk: Optional[bool] = None)

基类: BaseModel

is_principal: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

type: FloatIndexType

class FloatIndexType(value)

基类: str, Enum

一个枚举。

FLOAT = 'float'

class FormulaQuery(*, formula: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression], defaults: Optional[Dict[str, Any]] = {})

基类: BaseModel

defaults: Optional[Dict[str, Any]]

formula: Expression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class Fusion(value)

基类: str, Enum

融合算法允许合并多个预取结果。可用融合算法： * rrf - 倒数排序融合 (Reciprocal Rank Fusion) * dbsf - 基于分布的分数融合 (Distribution-Based Score Fusion)

DBSF = 'dbsf'

RRF = 'rrf'

class FusionQuery(*, fusion: Fusion)

基类: BaseModel

fusion: Fusion

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class GaussDecayExpression(*, gauss_decay: DecayParamsExpression)

基类: BaseModel

gauss_decay: DecayParamsExpression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class GeoBoundingBox(*, top_left: GeoPoint, bottom_right: GeoPoint)

基类: BaseModel

地理位置过滤器请求 匹配矩形内部的坐标，矩形由左上角和右下角的坐标描述

bottom_right: GeoPoint

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

top_left: GeoPoint

class GeoDistance(*, geo_distance: GeoDistanceParams)

基类: BaseModel

geo_distance: GeoDistanceParams

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class GeoDistanceParams(*, origin: GeoPoint, to: str)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

origin: GeoPoint

to: str

class GeoIndexParams(*, type: GeoIndexType, on_disk: Optional[bool] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

type: GeoIndexType

class GeoIndexType(value)

基类: str, Enum

一个枚举。

GEO = 'geo'

class GeoLineString(*, points: List[GeoPoint])

基类: BaseModel

表示线的有序地理点序列

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points: List[GeoPoint]

class GeoPoint(*, lon: float, lat: float)

基类: BaseModel

地理点负载模式

lat: float

lon: float

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class GeoPolygon(*, exterior: GeoLineString, interiors: Optional[List[GeoLineString]] = None)

基类: BaseModel

地理位置过滤器请求 匹配多边形内部的坐标，多边形由 exterior 和 interiors 定义

exterior: GeoLineString

interiors: Optional[List[GeoLineString]]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class GeoRadius(*, center: GeoPoint, radius: float)

基类: BaseModel

地理位置过滤器请求 匹配以 center 坐标为中心、radius 为半径的圆内部的坐标

center: GeoPoint

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

radius: float

class GpuDeviceTelemetry(*, name: str)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

name: str

class GroupsResult(*, groups: List[PointGroup])

基类: BaseModel

groups: List[PointGroup]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class GrpcTelemetry(*, responses: Dict[str, OperationDurationStatistics])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

responses: Dict[str, OperationDurationStatistics]

class HardwareTelemetry(*, collection_data: Dict[str, HardwareUsage])

基类: BaseModel

collection_data: Dict[str, HardwareUsage]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class HardwareUsage(*, cpu: int, payload_io_read: int, payload_io_write: int, payload_index_io_read: int, payload_index_io_write: int, vector_io_read: int, vector_io_write: int)

基类: BaseModel

处理请求所花费的硬件资源使用情况

cpu: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

payload_index_io_read: int

payload_index_io_write: int

payload_io_read: int

payload_io_write: int

vector_io_read: int

vector_io_write: int

class HasIdCondition(*, has_id: List[Union[int, str]])

基类: BaseModel

基于 ID 的过滤条件

has_id: List[ExtendedPointId]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class HasVectorCondition(*, has_vector: str)

基类: BaseModel

过滤具有特定向量的点

has_vector: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class HnswConfig(*, m: int, ef_construct: int, full_scan_threshold: int, max_indexing_threads: Optional[int] = 0, on_disk: Optional[bool] = None, payload_m: Optional[int] = None)

基类: BaseModel

HNSW 索引配置

ef_construct: int

full_scan_threshold: int

m: int

max_indexing_threads: Optional[int]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

payload_m: Optional[int]

class HnswConfigDiff(*, m: Optional[int] = None, ef_construct: Optional[int] = None, full_scan_threshold: Optional[int] = None, max_indexing_threads: Optional[int] = None, on_disk: Optional[bool] = None, payload_m: Optional[int] = None)

基类: BaseModel

ef_construct: Optional[int]

full_scan_threshold: Optional[int]

m: Optional[int]

max_indexing_threads: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

payload_m: Optional[int]

class Image(*, image: Any, model: str, options: Optional[Dict[str, Any]] = None)

基类: BaseModel

警告：正在开发中，用于嵌入的 Image 对象尚未实现。需要推理基础设施，尚未实现。

image: Any

model: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

options: Optional[Dict[str, Any]]

class IndexesOneOf(*, type: Literal['plain'], options: Any)

基类: BaseModel

搜索期间不使用任何索引，而是扫描整个向量集合。保证 100% 的精确度，但在大型集合上可能很耗时。

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

options: Any

type: Literal['plain']

class IndexesOneOf1(*, type: Literal['hnsw'], options: HnswConfig)

基类: BaseModel

使用可过滤的 HNSW 索引进行近似搜索。即使在非常大的集合上也非常快，但需要额外的空间来存储索引和额外的时间来构建它。

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

options: HnswConfig

type: Literal['hnsw']

class InferenceObject(*, object: Any, model: str, options: Optional[Dict[str, Any]] = None)

基类: BaseModel

警告：正在开发中，用于嵌入的 Custom 对象尚未实现。需要推理基础设施，尚未实现。

model: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

object: Any

options: Optional[Dict[str, Any]]

class InitFrom(*, collection: str)

基类: BaseModel

用于创建新集合并（可选地）指定索引参数的操作。

collection: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class InlineResponse200(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[bool] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[bool]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2001(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[TelemetryData] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[TelemetryData]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20010(*, time: Optional[float] = None, status: Optional[str] = None, result: Optional[bool] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[bool]

status: Optional[str]

time: Optional[float]

class InlineResponse20011(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[SnapshotDescription]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[List[SnapshotDescription]]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20012(*, time: Optional[float] = None, status: Optional[str] = None, result: Optional[SnapshotDescription] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[SnapshotDescription]

status: Optional[str]

time: Optional[float]

class InlineResponse20013(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[Record] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[Record]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20014(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[Record]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[List[Record]]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20015(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[UpdateResult]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[List[UpdateResult]]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20016(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[ScrollResult] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[ScrollResult]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20017(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[ScoredPoint]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[List[ScoredPoint]]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20018(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[List[ScoredPoint]]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[List[List[ScoredPoint]]]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20019(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[GroupsResult] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[GroupsResult]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2002(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[LocksOption] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[LocksOption]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20020(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CountResult] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[CountResult]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20021(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[FacetResponse] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[FacetResponse]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20022(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[QueryResponse] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[QueryResponse]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20023(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[QueryResponse]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[List[QueryResponse]]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20024(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[SearchMatrixPairsResponse] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[SearchMatrixPairsResponse]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse20025(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[SearchMatrixOffsetsResponse] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[SearchMatrixOffsetsResponse]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2003(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[Union[ClusterStatusOneOf, ClusterStatusOneOf1]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[ClusterStatus]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2004(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionsResponse] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[CollectionsResponse]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2005(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionInfo] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[CollectionInfo]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2006(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[UpdateResult] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[UpdateResult]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2007(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionExistence] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[CollectionExistence]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2008(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionClusterInfo] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[CollectionClusterInfo]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse2009(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionsAliasesResponse] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

result: Optional[CollectionsAliasesResponse]

status: Optional[str]

time: Optional[float]

usage: Optional[HardwareUsage]

class InlineResponse202(*, time: Optional[float] = None, status: Optional[str] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

status: Optional[str]

time: Optional[float]

class IntegerIndexParams(*, type: IntegerIndexType, lookup: Optional[bool] = None, range: Optional[bool] = None, is_principal: Optional[bool] = None, on_disk: Optional[bool] = None)

基类: BaseModel

is_principal: Optional[bool]

lookup: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

range: Optional[bool]

type: IntegerIndexType

class IntegerIndexType(value)

基类: str, Enum

一个枚举。

INTEGER = 'integer'

class IsEmptyCondition(*, is_empty: PayloadField)

基类: BaseModel

选择指定字段的 payload 为空的点

is_empty: PayloadField

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class IsNullCondition(*, is_null: PayloadField)

基类: BaseModel

选择指定字段的 payload 为 null 的点

is_null: PayloadField

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class KeywordIndexParams(*, type: KeywordIndexType, is_tenant: Optional[bool] = None, on_disk: Optional[bool] = None)

基类: BaseModel

is_tenant: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

type: KeywordIndexType

class KeywordIndexType(value)

基类: str, Enum

一个枚举。

KEYWORD = 'keyword'

class LinDecayExpression(*, lin_decay: DecayParamsExpression)

基类: BaseModel

lin_decay: DecayParamsExpression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class LnExpression(*, ln: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression])

基类: BaseModel

ln: Expression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class LocalShardInfo(*, shard_id: int, shard_key: Optional[Union[int, str]] = None, points_count: int, state: ReplicaState)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points_count: int

shard_id: int

shard_key: Optional[ShardKey]

state: ReplicaState

class LocalShardTelemetry(*, variant_name: Optional[str] = None, status: Optional[ShardStatus] = None, total_optimized_points: int, vectors_size_bytes: Optional[int] = None, payloads_size_bytes: Optional[int] = None, num_points: Optional[int] = None, num_vectors: Optional[int] = None, segments: Optional[List[SegmentTelemetry]] = None, optimizations: OptimizerTelemetry, async_scorer: Optional[bool] = None)

基类: BaseModel

async_scorer: Optional[bool]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

num_points: Optional[int]

num_vectors: Optional[int]

optimizations: OptimizerTelemetry

payloads_size_bytes: Optional[int]

segments: Optional[List[SegmentTelemetry]]

status: Optional[ShardStatus]

total_optimized_points: int

variant_name: Optional[str]

vectors_size_bytes: Optional[int]

class LocksOption(*, error_message: Optional[str] = None, write: bool)

基类: BaseModel

error_message: Optional[str]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

write: bool

class Log10Expression(*, log10: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression])

基类: BaseModel

log10: Expression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class LookupLocation(*, collection: str, vector: Optional[str] = None, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

定义用于查找向量的位置。指定集合和向量字段名称。

collection: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_key: Optional[ShardKeySelector]

vector: Optional[str]

class MatchAny(*, any: Union[List[str], List[int]])

基类: BaseModel

精确匹配给定的任意值

any: AnyVariants

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class MatchExcept(*, except_: Union[List[str], List[int]])

基类: BaseModel

应至少有一个值不匹配给定的任意值

except_: AnyVariants

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class MatchText(*, text: str)

基类: BaseModel

字符串的全文匹配。

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

text: str

class MatchValue(*, value: Union[bool, int, str])

基类: BaseModel

精确匹配给定的值

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

value: ValueVariants

class MaxOptimizationThreadsSetting(value)

基类: str, Enum

一个枚举。

AUTO = 'auto'

class MemoryTelemetry(*, active_bytes: int, allocated_bytes: int, metadata_bytes: int, resident_bytes: int, retained_bytes: int)

基类: BaseModel

active_bytes: int

allocated_bytes: int

metadata_bytes: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

resident_bytes: int

retained_bytes: int

class MessageSendErrors(*, count: int, latest_error: Optional[str] = None, latest_error_timestamp: Optional[Union[datetime, date]] = None)

基类: BaseModel

特定对等节点的邮件发送失败

count: int

latest_error: Optional[str]

latest_error_timestamp: Optional[Union[datetime, date]]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class MinShould(*, conditions: List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]], min_count: int)

基类: BaseModel

conditions: List[Condition]

min_count: int

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class Modifier(value)

基类: str, Enum

如果使用，包括权重修改，这将在查询时应用于稀疏向量：None - 无修改（默认） Idf - 逆文档频率，基于集合的统计信息

IDF = 'idf'

NONE = 'none'

class MoveShard(*, shard_id: int, to_peer_id: int, from_peer_id: int, method: Optional[Union[ShardTransferMethodOneOf, ShardTransferMethodOneOf1, ShardTransferMethodOneOf2, ShardTransferMethodOneOf3]] = None)

基类: BaseModel

from_peer_id: int

method: Optional[ShardTransferMethod]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_id: int

to_peer_id: int

class MoveShardOperation(*, move_shard: MoveShard)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

move_shard: MoveShard

class MultExpression(*, mult: List[Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression]])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

mult: List[Expression]

class MultiVectorComparator(value)

基类: str, Enum

一个枚举。

MAX_SIM = 'max_sim'

class MultiVectorConfig(*, comparator: MultiVectorComparator)

基类: BaseModel

comparator: MultiVectorComparator

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class NamedSparseVector(*, name: str, vector: SparseVector)

基类: BaseModel

带名称的稀疏向量数据

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

name: str

vector: SparseVector

class NamedVector(*, name: str, vector: List[float])

基类: BaseModel

带名称的密集向量数据

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

name: str

vector: List[float]

类 NearestQuery(*, nearest: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image,InferenceObject])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

nearest: VectorInput

类 NegExpression(*, neg: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression,GaussDecayExpression])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

neg: Expression

类 Nested(*, key: str, filter: Filter)

基类: BaseModel

选择具有指定嵌套字段有效载荷的点

filter: Filter

key: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

类 NestedCondition(*, nested: Nested)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

nested: Nested

类 OperationDurationStatistics(*, count: int, fail_count: Optional[int] = None, avg_duration_micros: Optional[float] = None, min_duration_micros: Optional[float] = None, max_duration_micros: Optional[float] = None, total_duration_micros: Optional[int] = None, last_responded: Optional[Union[datetime, date]] = None)

基类: BaseModel

avg_duration_micros: Optional[float]

count: int

fail_count: Optional[int]

last_responded: Optional[Union[datetime, date]]

max_duration_micros: Optional[float]

min_duration_micros: Optional[float]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

total_duration_micros: Optional[int]

类 OptimizerTelemetry(*, status: Union[OptimizersStatusOneOf, OptimizersStatusOneOf1], optimizations: OperationDurationStatistics, log: Optional[List[TrackerTelemetry]] = None)

基类: BaseModel

log: Optional[List[TrackerTelemetry]]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

optimizations: OperationDurationStatistics

status: OptimizersStatus

类 OptimizersConfig(*, deleted_threshold: float, vacuum_min_vector_number: int, default_segment_number: int, max_segment_size: Optional[int] = None, memmap_threshold: Optional[int] = None, indexing_threshold: Optional[int] = None, flush_interval_sec: int, max_optimization_threads: Optional[int] = None)

基类: BaseModel

default_segment_number: int

deleted_threshold: float

flush_interval_sec: int

indexing_threshold: Optional[int]

max_optimization_threads: Optional[int]

max_segment_size: Optional[int]

memmap_threshold: Optional[int]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

vacuum_min_vector_number: int

类 OptimizersConfigDiff(*, deleted_threshold: Optional[float] = None, vacuum_min_vector_number: Optional[int] = None, default_segment_number: Optional[int] = None, max_segment_size: Optional[int] = None, memmap_threshold: Optional[int] = None, indexing_threshold: Optional[int] = None, flush_interval_sec: Optional[int] = None, max_optimization_threads: Optional[Union[int, MaxOptimizationThreadsSetting]] = None)

基类: BaseModel

default_segment_number: Optional[int]

deleted_threshold: Optional[float]

flush_interval_sec: Optional[int]

indexing_threshold: Optional[int]

max_optimization_threads: Optional[MaxOptimizationThreads]

max_segment_size: Optional[int]

memmap_threshold: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

vacuum_min_vector_number: Optional[int]

类 OptimizersStatusOneOf(value)

基类: str, Enum

优化器报告状态正常

OK = 'ok'

类 OptimizersStatusOneOf1(*, error: str)

基类: BaseModel

优化器发生错误

error: str

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

类 OrderBy(*, key: str, direction: Optional[Direction] = None, start_from: Optional[Union[int, float, datetime, date]] = None)

基类: BaseModel

direction: Optional[Direction]

key: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

start_from: Optional[StartFrom]

类 OrderByQuery(*, order_by: Union[str, OrderBy])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

order_by: OrderByInterface

类 OverwritePayloadOperation(*, overwrite_payload: SetPayload)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

overwrite_payload: SetPayload

类 P2pConfigTelemetry(*, connection_pool_size: int)

基类: BaseModel

connection_pool_size: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

类 PayloadField(*, key: str)

基类: BaseModel

有效载荷字段

key: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

类 PayloadIndexInfo(*, data_type: PayloadSchemaType, params: Optional[Union[KeywordIndexParams, IntegerIndexParams, FloatIndexParams, GeoIndexParams, TextIndexParams, BoolIndexParams, DatetimeIndexParams, UuidIndexParams]] = None, points: int)

基类: BaseModel

显示有效载荷字段类型和索引信息

data_type: PayloadSchemaType

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

params: Optional[PayloadSchemaParams]

points: int

类 PayloadIndexTelemetry(*, field_name: Optional[str] = None, index_type: str, points_values_count: int, points_count: int, histogram_bucket_size: Optional[int] = None)

基类: BaseModel

field_name: Optional[str]

histogram_bucket_size: Optional[int]

index_type: str

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points_count: int

points_values_count: int

类 PayloadSchemaType(value)

基类: str, Enum

所有可能的有效载荷类型名称

BOOL = 'bool'

DATETIME = 'datetime'

FLOAT = 'float'

GEO = 'geo'

INTEGER = 'integer'

KEYWORD = 'keyword'

TEXT = 'text'

UUID = 'uuid'

类 PayloadSelectorExclude(*, exclude: List[str])

基类: BaseModel

exclude: List[str]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

类 PayloadSelectorInclude(*, include: List[str])

基类: BaseModel

include: List[str]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

类 PayloadStorageTypeOneOf(*, type: Literal['in_memory'])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

type: Literal['in_memory']

类 PayloadStorageTypeOneOf1(*, type: Literal['on_disk'])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

type: Literal['on_disk']

类 PayloadStorageTypeOneOf2(*, type: Literal['mmap'])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

type: Literal['mmap']

类 PeerInfo(*, uri: str)

基类: BaseModel

集群中对等节点的信息

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

uri: str

类 PointGroup(*, hits: List[ScoredPoint], id: Union[int, str], lookup: Optional[Record] = None)

基类: BaseModel

hits: List[ScoredPoint]

id: GroupId

lookup: Optional[Record]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class PointIdsList(*, points: List[Union[int, str]], shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points: List[ExtendedPointId]

shard_key: Optional[ShardKeySelector]

class PointRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, ids: List[Union[int, str]], with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None)

基类: BaseModel

ids: List[ExtendedPointId]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_key: Optional[ShardKeySelector]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class PointStruct(*, id: Union[int, str], vector: Union[List[float], List[List[float]], Dict[str, Union[List[float], SparseVector, List[List[float]], Document, Image, InferenceObject]], Document, Image, InferenceObject], payload: Optional[Dict[str, Any]] = None)

基类: BaseModel

id: ExtendedPointId

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

payload: Optional[Payload]

vector: VectorStruct

class PointVectors(*, id: Union[int, str], vector: Union[List[float], List[List[float]], Dict[str, Union[List[float], SparseVector, List[List[float]], Document, Image, InferenceObject]], Document, Image, InferenceObject])

基类: BaseModel

id: ExtendedPointId

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

vector: VectorStruct

class PointsBatch(*, batch: Batch, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

batch: Batch

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_key: Optional[ShardKeySelector]

class PointsList(*, points: List[PointStruct], shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points: List[PointStruct]

shard_key: Optional[ShardKeySelector]

class PowExpression(*, pow: PowParams)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

pow: PowParams

class PowParams(*, base: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression], exponent: Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression])

基类: BaseModel

base: Expression

exponent: Expression

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class Prefetch(*, prefetch: Optional[Union[List[Prefetch], Prefetch]] = None, query: Optional[Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject, NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, FormulaQuery, SampleQuery]] = None, using: Optional[str] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, limit: Optional[int] = None, lookup_from: Optional[LookupLocation] = None)

基类: BaseModel

filter: Optional[Filter]

limit: Optional[int]

lookup_from: Optional[LookupLocation]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

params: Optional[SearchParams]

prefetch: Optional[Union[List[Prefetch], Prefetch]]

query: Optional[QueryInterface]

score_threshold: Optional[float]

using: Optional[str]

class ProductQuantization(*, product: ProductQuantizationConfig)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

product: ProductQuantizationConfig

class ProductQuantizationConfig(*, compression: CompressionRatio, always_ram: Optional[bool] = None)

基类: BaseModel

always_ram: Optional[bool]

compression: CompressionRatio

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class QuantizationSearchParams(*, ignore: Optional[bool] = False, rescore: Optional[bool] = None, oversampling: Optional[float] = None)

基类: BaseModel

搜索的额外参数

ignore: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

oversampling: Optional[float]

rescore: Optional[bool]

class QueryGroupsRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, prefetch: Optional[Union[List[Prefetch], Prefetch]] = None, query: Optional[Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject, NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, FormulaQuery, SampleQuery]] = None, using: Optional[str] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, with_vector: Optional[Union[bool, List[str]]] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, lookup_from: Optional[LookupLocation] = None, group_by: str, group_size: Optional[int] = None, limit: Optional[int] = None, with_lookup: Optional[Union[str, WithLookup]] = None)

基类: BaseModel

filter: Optional[Filter]

group_by: str

group_size: Optional[int]

limit: Optional[int]

lookup_from: Optional[LookupLocation]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

params: Optional[SearchParams]

prefetch: Optional[Union[List[Prefetch], Prefetch]]

query: Optional[QueryInterface]

score_threshold: Optional[float]

shard_key: Optional[ShardKeySelector]

using: Optional[str]

with_lookup: Optional[WithLookupInterface]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class QueryRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, prefetch: Optional[Union[List[Prefetch], Prefetch]] = None, query: Optional[Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject, NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, FormulaQuery, SampleQuery]] = None, using: Optional[str] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, limit: Optional[int] = None, offset: Optional[int] = None, with_vector: Optional[Union[bool, List[str]]] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, lookup_from: Optional[LookupLocation] = None)

基类: BaseModel

filter: Optional[Filter]

limit: Optional[int]

lookup_from: Optional[LookupLocation]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

offset: Optional[int]

params: Optional[SearchParams]

prefetch: Optional[Union[List[Prefetch], Prefetch]]

query: Optional[QueryInterface]

score_threshold: Optional[float]

shard_key: Optional[ShardKeySelector]

using: Optional[str]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class QueryRequestBatch(*, searches: List[QueryRequest])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

searches: List[QueryRequest]

class QueryResponse(*, points: List[ScoredPoint])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points: List[ScoredPoint]

class RaftInfo(*, term: int, commit: int, pending_operations: int, leader: Optional[int] = None, role: Optional[StateRole] = None, is_voter: bool)

基类: BaseModel

Summary information about the current raft state

commit: int

is_voter: bool

leader: Optional[int]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

pending_operations: int

role: Optional[StateRole]

term: int

class Range(*, lt: Optional[float] = None, gt: Optional[float] = None, gte: Optional[float] = None, lte: Optional[float] = None)

基类: BaseModel

范围过滤请求

gt: Optional[float]

gte: Optional[float]

lt: Optional[float]

lte: Optional[float]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ReadConsistencyType(value)

基类: str, Enum

• majority - send N/2+1 random request and return points, which present on all of them * quorum - send requests to all nodes and return points which present on majority of nodes * all - send requests to all nodes and return points which present on all nodes

ALL = 'all'

MAJORITY = 'majority'

QUORUM = 'quorum'

class RecommendGroupsRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, positive: Optional[List[Union[int, str, List[float], SparseVector]]] = [], negative: Optional[List[Union[int, str, List[float], SparseVector]]] = [], strategy: Optional[RecommendStrategy] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, score_threshold: Optional[float] = None, using: Optional[str] = None, lookup_from: Optional[LookupLocation] = None, group_by: str, group_size: int, limit: int, with_lookup: Optional[Union[str, WithLookup]] = None)

基类: BaseModel

filter: Optional[Filter]

group_by: str

group_size: int

limit: int

lookup_from: Optional[LookupLocation]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

negative: Optional[List[RecommendExample]]

params: Optional[SearchParams]

positive: Optional[List[RecommendExample]]

score_threshold: Optional[float]

shard_key: Optional[ShardKeySelector]

strategy: Optional[RecommendStrategy]

using: Optional[UsingVector]

with_lookup: Optional[WithLookupInterface]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class RecommendInput(*, positive: Optional[List[Union[List[float], SparseVector, List[List[floatspan class="p">]], int, str, Document, Image, InferenceObject]]] = None, negative: Optional[List[Union[List[float], SparseVector, List[List[floatspan class="p">]], int, str, Document, Image, InferenceObject]]] = None, strategy: Optional[RecommendStrategy] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

negative: Optional[List[VectorInput]]

positive: Optional[List[VectorInput]]

strategy: Optional[RecommendStrategy]

class RecommendQuery(*, recommend: RecommendInput)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

recommend: RecommendInput

class RecommendRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, positive: Optional[List[Union[int, str, List[float], SparseVector]]] = [], negative: Optional[List[Union[int, str, List[float], SparseVector]]] = [], strategy: Optional[RecommendStrategy] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, limit: int, offset: Optional[int] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, score_threshold: Optional[float] = None, using: Optional[str] = None, lookup_from: Optional[LookupLocation] = None)

基类: BaseModel

Recommendation request. Provides positive and negative examples of the vectors, which can be ids of points that are already stored in the collection, raw vectors, or even ids and vectors combined. Service should look for the points which are closer to positive examples and at the same time further to negative examples. The concrete way of how to compare negative and positive distances is up to the strategy chosen.

filter: Optional[Filter]

limit: int

lookup_from: Optional[LookupLocation]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

negative: Optional[List[RecommendExample]]

offset: Optional[int]

params: Optional[SearchParams]

positive: Optional[List[RecommendExample]]

score_threshold: Optional[float]

shard_key: Optional[ShardKeySelector]

strategy: Optional[RecommendStrategy]

using: Optional[UsingVector]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class RecommendRequestBatch(*, searches: List[RecommendRequest])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

searches: List[RecommendRequest]

class RecommendStrategy(value)

基类: str, Enum

How to use positive and negative examples to find the results, default is average_vector: * average_vector - Average positive and negative vectors and create a single query with the formula query = avg_pos + avg_pos - avg_neg. Then performs normal search. * best_score - Uses custom search objective. Each candidate is compared against all examples, its score is then chosen from the max(max_pos_score, max_neg_score). If the max_neg_score is chosen then it is squared and negated, otherwise it is just the max_pos_score. * sum_scores - Uses custom search objective. Compares against all inputs, sums all the scores. Scores against positive vectors are added, against negatives are subtracted.

AVERAGE_VECTOR = 'average_vector'

BEST_SCORE = 'best_score'

SUM_SCORES = 'sum_scores'

class Record(*, id: Union[int, str], payload: Optional[Dict[str, Any]] = None, vector: Optional[Union[List[float], List[List[float]], Dict[str, Union[List[float], SparseVector, List[List[float]]]]]] = None, shard_key: Optional[Union[int, str]] = None, order_value: Optional[Union[int, float]] = None)

基类: BaseModel

Point data

id: ExtendedPointId

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

order_value: Optional[OrderValue]

payload: Optional[Payload]

shard_key: Optional[ShardKey]

vector: Optional[VectorStructOutput]

class RemoteShardInfo(*, shard_id: int, shard_key: Optional[Union[int, str]] = None, peer_id: int, state: ReplicaState)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peer_id: int

shard_id: int

shard_key: Optional[ShardKey]

state: ReplicaState

class RemoteShardTelemetry(*, shard_id: int, peer_id: Optional[int] = None, searches: OperationDurationStatistics, updates: OperationDurationStatistics)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peer_id: Optional[int]

searches: OperationDurationStatistics

shard_id: int

updates: OperationDurationStatistics

class RenameAlias(*, old_alias_name: str, new_alias_name: str)

基类: BaseModel

将别名更改为新的别名

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

new_alias_name: str

old_alias_name: str

class RenameAliasOperation(*, rename_alias: RenameAlias)

基类: BaseModel

将别名更改为新的别名

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

rename_alias: RenameAlias

class Replica(*, shard_id: int, peer_id: int)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peer_id: int

shard_id: int

class ReplicaSetTelemetry(*, id: int, key: Optional[Union[int, str]] = None, local: Optional[LocalShardTelemetry] = None, remote: List[RemoteShardTelemetry], replicate_states: Dict[str, ReplicaState])

基类: BaseModel

id: int

key: Optional[ShardKey]

local: Optional[LocalShardTelemetry]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

remote: List[RemoteShardTelemetry]

replicate_states: Dict[str, ReplicaState]

class ReplicaState(value)

基类: str, Enum

副本集内单个分片的状态。

ACTIVE = 'Active'

DEAD = 'Dead'

INITIALIZING = 'Initializing'

LISTENER = 'Listener'

PARTIAL = 'Partial'

PARTIALSNAPSHOT = 'PartialSnapshot'

RECOVERY = 'Recovery'

RESHARDING = 'Resharding'

RESHARDINGSCALEDOWN = 'ReshardingScaleDown'

class ReplicateShard(*, shard_id: int, to_peer_id: int, from_peer_id: int, method: Optional[Union[ShardTransferMethodOneOf, ShardTransferMethodOneOf1, ShardTransferMethodOneOf2, ShardTransferMethodOneOf3]] = None)

基类: BaseModel

from_peer_id: int

method: Optional[ShardTransferMethod]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_id: int

to_peer_id: int

class ReplicateShardOperation(*, replicate_shard: ReplicateShard)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

replicate_shard: ReplicateShard

class RequestsTelemetry(*, rest: WebApiTelemetry, grpc: GrpcTelemetry)

基类: BaseModel

grpc: GrpcTelemetry

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

rest: WebApiTelemetry

class ReshardingDirectionOneOf(value)

基类: str, Enum

向上扩展，添加一个新的分片

UP = 'up'

class ReshardingDirectionOneOf1(value)

基类: str, Enum

向下收缩，移除一个分片

DOWN = 'down'

class ReshardingInfo(*, direction: Union[ReshardingDirectionOneOf, ReshardingDirectionOneOf1], shard_id: int, peer_id: int, shard_key: Optional[Union[int, str]] = None)

基类: BaseModel

direction: ReshardingDirection

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peer_id: int

shard_id: int

shard_key: Optional[ShardKey]

class RestartTransfer(*, shard_id: int, from_peer_id: int, to_peer_id: int, method: Union[ShardTransferMethodOneOf, ShardTransferMethodOneOf1, ShardTransferMethodOneOf2, ShardTransferMethodOneOf3])

基类: BaseModel

from_peer_id: int

method: ShardTransferMethod

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_id: int

to_peer_id: int

class RestartTransferOperation(*, restart_transfer: RestartTransfer)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

restart_transfer: RestartTransfer

class RunningEnvironmentTelemetry(*, distribution: Optional[str] = None, distribution_version: Optional[str] = None, is_docker: bool, cores: Optional[int] = None, ram_size: Optional[int] = None, disk_size: Optional[int] = None, cpu_flags: str, cpu_endian: Optional[CpuEndian] = None, gpu_devices: Optional[List[GpuDeviceTelemetry]] = None)

基类: BaseModel

cores: Optional[int]

cpu_endian: Optional[CpuEndian]

cpu_flags: str

disk_size: Optional[int]

distribution: Optional[str]

distribution_version: Optional[str]

gpu_devices: Optional[List[GpuDeviceTelemetry]]

is_docker: bool

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

ram_size: Optional[int]

class Sample(value)

基类: str, Enum

一个枚举。

RANDOM = 'random'

class SampleQuery(*, sample: Sample)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

sample: Sample

class ScalarQuantization(*, scalar: ScalarQuantizationConfig)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

scalar: ScalarQuantizationConfig

class ScalarQuantizationConfig(*, type: ScalarType, quantile: Optional[float] = None, always_ram: Optional[bool] = None)

基类: BaseModel

always_ram: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

quantile: Optional[float]

type: ScalarType

class ScalarType(value)

基类: str, Enum

一个枚举。

INT8 = 'int8'

class ScoredPoint(*, id: Union[int, str], version: int, score: float, payload: Optional[Dict[str, Any]] = None, vector: Optional[Union[List[float], List[List][float]], Dict[str, Union[List[float], SparseVector, List[List[float]]]]]] = None, shard_key: Optional[Union[int, str]] = None, order_value: Optional[Union[int, float]] = None)

基类: BaseModel

搜索结果

id: ExtendedPointId

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

order_value: Optional[OrderValue]

payload: Optional[Payload]

score: float

shard_key: Optional[ShardKey]

vector: Optional[VectorStructOutput]

version: int

class ScrollRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, offset: Optional[Union[int, str]] = None, limit: Optional[int] = None, filter: Optional[Filter] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, order_by: Optional[Union[str, OrderBy]] = None)

基类: BaseModel

滚动请求 - 对所有符合给定条件的点进行分页

filter: Optional[Filter]

limit: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

offset: Optional[ExtendedPointId]

order_by: Optional[OrderByInterface]

shard_key: Optional[ShardKeySelector]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class ScrollResult(*, points: List[Record], next_page_offset: Optional[Union[int, str]] = None)

基类: BaseModel

点读取请求的结果

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

next_page_offset: Optional[ExtendedPointId]

points: List[Record]

class SearchGroupsRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, vector: Union[List[float], NamedVector, NamedSparseVector], filter: Optional[Filter] = None, params: Optional[SearchParams] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, score_threshold: Optional[float] = None, group_by: str, group_size: int, limit: int, with_lookup: Optional[Union[str, WithLookup]] = None)

基类: BaseModel

filter: Optional[Filter]

group_by: str

group_size: int

limit: int

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

params: Optional[SearchParams]

score_threshold: Optional[float]

shard_key: Optional[ShardKeySelector]

vector: NamedVectorStruct

with_lookup: Optional[WithLookupInterface]

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class SearchMatrixOffsetsResponse(*, offsets_row: List[int], offsets_col: List[int], scores: List[float], ids: List[Union[int, str]])

基类: BaseModel

ids: List[ExtendedPointId]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

offsets_col: List[int]

offsets_row: List[int]

scores: List[float]

class SearchMatrixPair(*, a: Union[int, str], b: Union[int, str], score: float)

基类: BaseModel

带有分数的点对 (a, b)

a: ExtendedPointId

b: ExtendedPointId

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

score: float

class SearchMatrixPairsResponse(*, pairs: List[SearchMatrixPair])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

pairs: List[SearchMatrixPair]

class SearchMatrixRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, filter: Optional[Filter] = None, sample: Optional[int] = None, limit: Optional[int] = None, using: Optional[str] = None)

基类: BaseModel

filter: Optional[Filter]

limit: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

sample: Optional[int]

shard_key: Optional[ShardKeySelector]

using: Optional[str]

class SearchParams(*, hnsw_ef: Optional[int] = None, exact: Optional[bool] = False, quantization: Optional[QuantizationSearchParams] = None, indexed_only: Optional[bool] = False)

基类: BaseModel

搜索的额外参数

exact: Optional[bool]

hnsw_ef: Optional[int]

indexed_only: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

quantization: Optional[QuantizationSearchParams]

class SearchRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, vector: Union[List[float], NamedVector, NamedSparseVector], filter: Optional[Filter] = None, params: Optional[SearchParams] = None, limit: int, offset: Optional[int] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, score_threshold: Optional[float] = None)

基类: BaseModel

搜索请求。包含根据筛选限制按向量相似度搜索最相似点的所有条件和参数。

filter: Optional[Filter]

limit: int

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

offset: Optional[int]

params: Optional[SearchParams]

score_threshold: Optional[float]

shard_key: Optional[ShardKeySelector]

vector: NamedVectorStruct

with_payload: Optional[WithPayloadInterface]

with_vector: Optional[WithVector]

class SearchRequestBatch(*, searches: List[SearchRequest])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

searches: List[SearchRequest]

class SegmentConfig(*, vector_data: Optional[Dict[str, VectorDataConfig]] = {}, sparse_vector_data: Optional[Dict[str, SparseVectorDataConfig]] = None, payload_storage_type: Union[PayloadStorageTypeOneOf, PayloadStorageTypeOneOf1, PayloadStorageTypeOneOf2])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

payload_storage_type: PayloadStorageType

sparse_vector_data: Optional[Dict[str, SparseVectorDataConfig]]

vector_data: Optional[Dict[str, VectorDataConfig]]

class SegmentInfo(*, segment_type: SegmentType, num_vectors: int, num_points: int, num_indexed_vectors: int, num_deleted_vectors: int, vectors_size_bytes: int, payloads_size_bytes: int, ram_usage_bytes: int, disk_usage_bytes: int, is_appendable: bool, index_schema: Dict[str, PayloadIndexInfo], vector_data: Dict[str, VectorDataInfo])

基类: BaseModel

关于段的聚合信息

disk_usage_bytes: int

index_schema: Dict[str, PayloadIndexInfo]

is_appendable: bool

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

num_deleted_vectors: int

num_indexed_vectors: int

num_points: int

num_vectors: int

payloads_size_bytes: int

ram_usage_bytes: int

segment_type: SegmentType

vector_data: Dict[str, VectorDataInfo]

vectors_size_bytes: int

class SegmentTelemetry(*, info: SegmentInfo, config: SegmentConfig, vector_index_searches: List[VectorIndexSearchesTelemetry], payload_field_indices: List[PayloadIndexTelemetry])

基类: BaseModel

config: SegmentConfig

info: SegmentInfo

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

payload_field_indices: List[PayloadIndexTelemetry]

vector_index_searches: List[VectorIndexSearchesTelemetry]

class SegmentType(value)

基类: str, Enum

段的类型

INDEXED = 'indexed'

PLAIN = 'plain'

SPECIAL = 'special'

class SetPayload(*, payload: Dict[str, Any], points: Optional[List[Union[int, str]]] = None, filter: Optional[Filter] = None, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, key: Optional[str] = None)

基类: BaseModel

此数据结构用于API接口，并应用于多个分片

filter: Optional[Filter]

key: Optional[str]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

payload: Payload

points: Optional[List[ExtendedPointId]]

shard_key: Optional[ShardKeySelector]

class SetPayloadOperation(*, set_payload: SetPayload)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

set_payload: SetPayload

class ShardCleanStatusFailedTelemetry(*, reason: str)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

reason: str

class ShardCleanStatusProgressTelemetry(*, deleted_points: int)

基类: BaseModel

deleted_points: int

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ShardCleanStatusTelemetryOneOf(value)

基类: str, Enum

一个枚举。

CANCELLED = 'cancelled'

DONE = 'done'

STARTED = 'started'

class ShardCleanStatusTelemetryOneOf1(*, progress: ShardCleanStatusProgressTelemetry)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

progress: ShardCleanStatusProgressTelemetry

class ShardCleanStatusTelemetryOneOf2(*, failed: ShardCleanStatusFailedTelemetry)

基类: BaseModel

failed: ShardCleanStatusFailedTelemetry

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class ShardSnapshotRecover(*, location: str, priority: Optional[SnapshotPriority] = None, checksum: Optional[str] = None, api_key: Optional[str] = None)

基类: BaseModel

api_key: Optional[str]

checksum: Optional[str]

location: ShardSnapshotLocation

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

priority: Optional[SnapshotPriority]

class ShardStatus(value)

基类: str, Enum

分片当前的状态（支持与集合相同的状态） Green - 一切正常。 Yellow - 优化正在运行，'Grey' - 优化是可能的但未触发，Red - 某些操作失败且未恢复

GREEN = 'green'

GREY = 'grey'

RED = 'red'

YELLOW = 'yellow'

class ShardTransferInfo(*, shard_id: int, to_shard_id: Optional[int] = None, from_: int, to: int, sync: bool, method: Optional[Union[ShardTransferMethodOneOf, ShardTransferMethodOneOf1, ShardTransferMethodOneOf2, ShardTransferMethodOneOf3]] = None, comment: Optional[str] = None)

基类: BaseModel

comment: Optional[str]

from_: int

method: Optional[ShardTransferMethod]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

shard_id: int

sync: bool

to: int

to_shard_id: Optional[int]

class ShardTransferMethodOneOf(value)

基类: str, Enum

分批流式传输所有分片记录，直到整个分片传输完成。

STREAM_RECORDS = 'stream_records'

class ShardTransferMethodOneOf1(value)

基类: str, Enum

快照分片，然后在接收方传输和恢复。

SNAPSHOT = 'snapshot'

class ShardTransferMethodOneOf2(value)

基类: str, Enum

尝试通过 WAL delta 传输分片差异。

WAL_DELTA = 'wal_delta'

class ShardTransferMethodOneOf3(value)

基类: str, Enum

用于重新分片的分片传输：分批流式传输所有记录，直到所有点传输完成。

RESHARDING_STREAM_RECORDS = 'resharding_stream_records'

class ShardingMethod(value)

基类: str, Enum

一个枚举。

AUTO = 'auto'

CUSTOM = 'custom'

class SnapshotDescription(*, name: str, creation_time: Optional[str] = None, size: int, checksum: Optional[str] = None)

基类: BaseModel

checksum: Optional[str]

creation_time: Optional[str]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

name: str

size: int

class SnapshotPriority(value)

基类: str, Enum

定义快照恢复的真相来源：NoSync 表示 - 恢复快照时不进行任何额外的同步。Snapshot 表示 - 相较于当前状态，优先使用快照数据。Replica 表示 - 相较于快照，优先使用现有数据。

NO_SYNC = 'no_sync'

REPLICA = 'replica'

SNAPSHOT = 'snapshot'

class SnapshotRecover(*, location: str, priority: Optional[SnapshotPriority] = None, checksum: Optional[str] = None, api_key: Optional[str] = None)

基类: BaseModel

api_key: Optional[str]

checksum: Optional[str]

location: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

priority: Optional[SnapshotPriority]

class SparseIndexConfig(*, full_scan_threshold: Optional[int] = None, index_type: Union[SparseIndexTypeOneOf, SparseIndexTypeOneOf1, SparseIndexTypeOneOf2], datatype: Optional[VectorStorageDatatype] = None)

基类: BaseModel

稀疏倒排索引的配置。

datatype: Optional[VectorStorageDatatype]

full_scan_threshold: Optional[int]

index_type: SparseIndexType

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class SparseIndexParams(*, full_scan_threshold: Optional[int] = None, on_disk: Optional[bool] = None, datatype: Optional[Datatype] = None)

基类: BaseModel

稀疏倒排索引的配置。

datatype: Optional[Datatype]

full_scan_threshold: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

class SparseIndexTypeOneOf(value)

基类: str, Enum

可变内存稀疏索引

MUTABLERAM = 'MutableRam'

class SparseIndexTypeOneOf1(value)

基类: str, Enum

不可变内存稀疏索引

IMMUTABLERAM = 'ImmutableRam'

class SparseIndexTypeOneOf2(value)

基类: str, Enum

Mmap 稀疏索引

MMAP = 'Mmap'

class SparseVector(*, indices: List[int], values: List[float])

基类: BaseModel

稀疏向量结构

indices: List[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

values: List[float]

class SparseVectorDataConfig(*, index: SparseIndexConfig, storage_type: Optional[Union[SparseVectorStorageTypeOneOf, SparseVectorStorageTypeOneOf1]] = None)

基类: BaseModel

单个稀疏向量数据存储配置

index: SparseIndexConfig

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

storage_type: Optional[SparseVectorStorageType]

class SparseVectorParams(*, index: Optional[SparseIndexParams] = None, modifier: Optional[Modifier] = None)

基类: BaseModel

单个稀疏向量数据存储参数

index: Optional[SparseIndexParams]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

modifier: Optional[Modifier]

class SparseVectorStorageTypeOneOf(value)

基类: str, Enum

磁盘存储

ON_DISK = 'on_disk'

class SparseVectorStorageTypeOneOf1(value)

基类: str, Enum

内存映射存储

MMAP = 'mmap'

class SqrtExpression(*, sqrt: Union[float, str,FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

sqrt: Expression

class StartResharding(*, direction: Union[ReshardingDirectionOneOf, ReshardingDirectionOneOf1], peer_id: Optional[int] = None, shard_key: Optional[Union[int, str]] = None)

基类: BaseModel

direction: ReshardingDirection

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

peer_id: Optional[int]

shard_key: Optional[ShardKey]

class StartReshardingOperation(*, start_resharding: StartResharding)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

start_resharding: StartResharding

class StateRole(value)

基类: str, Enum

节点在共识中的角色

CANDIDATE = 'Candidate'

FOLLOWER = 'Follower'

LEADER = 'Leader'

PRECANDIDATE = 'PreCandidate'

class StrictModeConfig(*, enabled: Optional[bool] = None, max_query_limit: Optional[int] = None, max_timeout: Optional[int] = None, unindexed_filtering_retrieve: Optional[bool] = None, unindexed_filtering_update: Optional[bool] = None, search_max_hnsw_ef: Optional[int] = None, search_allow_exact: Optional[bool] = None, search_max_oversampling: Optional[float] = None, upsert_max_batchsize: Optional[int] = None, max_collection_vector_size_bytes: Optional[int] = None, read_rate_limit: Optional[int] = None, write_rate_limit: Optional[int] = None, max_collection_payload_size_bytes: Optional[int] = None, max_points_count: Optional[int] = None, filter_max_conditions: Optional[int] = None, condition_max_size: Optional[int] = None, multivector_config: Optional[Dict[str, StrictModeMultivector]] = None, sparse_config: Optional[Dict[str, StrictModeSparse]] = None)

基类: BaseModel

condition_max_size: Optional[int]

enabled: Optional[bool]

filter_max_conditions: Optional[int]

max_collection_payload_size_bytes: Optional[int]

max_collection_vector_size_bytes: Optional[int]

max_points_count: Optional[int]

max_query_limit: Optional[int]

max_timeout: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

multivector_config: Optional[StrictModeMultivectorConfig]

read_rate_limit: Optional[int]

search_allow_exact: Optional[bool]

search_max_hnsw_ef: Optional[int]

search_max_oversampling: Optional[float]

sparse_config: Optional[StrictModeSparseConfig]

unindexed_filtering_retrieve: Optional[bool]

unindexed_filtering_update: Optional[bool]

upsert_max_batchsize: Optional[int]

write_rate_limit: Optional[int]

class StrictModeConfigOutput(*, enabled: Optional[bool] = None, max_query_limit: Optional[int] = None, max_timeout: Optional[int] = None, unindexed_filtering_retrieve: Optional[bool] = None, unindexed_filtering_update: Optional[bool] = None, search_max_hnsw_ef: Optional[int] = None, search_allow_exact: Optional[bool] = None, search_max_oversampling: Optional[float] = None, upsert_max_batchsize: Optional[int] = None, max_collection_vector_size_bytes: Optional[int] = None, read_rate_limit: Optional[int] = None, write_rate_limit: Optional[int] = None, max_collection_payload_size_bytes: Optional[int] = None, max_points_count: Optional[int] = None, filter_max_conditions: Optional[int] = None, condition_max_size: Optional[int] = None, multivector_config: Optional[Dict[str, StrictModeMultivectorOutput]] = None, sparse_config: Optional[Dict[str, StrictModeSparseOutput]] = None)

基类: BaseModel

condition_max_size: Optional[int]

enabled: Optional[bool]

filter_max_conditions: Optional[int]

max_collection_payload_size_bytes: Optional[int]

max_collection_vector_size_bytes: Optional[int]

max_points_count: Optional[int]

max_query_limit: Optional[int]

max_timeout: Optional[int]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

multivector_config: Optional[StrictModeMultivectorConfigOutput]

read_rate_limit: Optional[int]

search_allow_exact: Optional[bool]

search_max_hnsw_ef: Optional[int]

search_max_oversampling: Optional[float]

sparse_config: Optional[StrictModeSparseConfigOutput]

unindexed_filtering_retrieve: Optional[bool]

unindexed_filtering_update: Optional[bool]

upsert_max_batchsize: Optional[int]

write_rate_limit: Optional[int]

class StrictModeMultivector(*, max_vectors: Optional[int] = None)

基类: BaseModel

max_vectors: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class StrictModeMultivectorOutput(*, max_vectors: Optional[int] = None)

基类: BaseModel

max_vectors: Optional[int]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class StrictModeSparse(*, max_length: Optional[int] = None)

基类: BaseModel

max_length: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class StrictModeSparseOutput(*, max_length: Optional[int] = None)

基类: BaseModel

max_length: Optional[int]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class SumExpression(*, sum: List[Union[float, str, FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter, GeoDistance, DatetimeExpression, DatetimeKeyExpression, MultExpression, SumExpression, NegExpression, AbsExpression, DivExpression, SqrtExpression, PowExpression, ExpExpression, Log10Expression, LnExpression, LinDecayExpression, ExpDecayExpression, GaussDecayExpression]])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

sum: List[Expression]

class TelemetryData(*, id: str, app: AppBuildTelemetry, collections: CollectionsTelemetry, cluster: Optional[ClusterTelemetry] = None, requests: Optional[RequestsTelemetry] = None, memory: Optional[MemoryTelemetry] = None, hardware: Optional[HardwareTelemetry] = None)

基类: BaseModel

app: AppBuildTelemetry

cluster: Optional[ClusterTelemetry]

collections: CollectionsTelemetry

hardware: Optional[HardwareTelemetry]

id: str

memory: Optional[MemoryTelemetry]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

requests: Optional[RequestsTelemetry]

class TextIndexParams(*, type: TextIndexType, tokenizer: Optional[TokenizerType] = None, min_token_len: Optional[int] = None, max_token_len: Optional[int] = None, lowercase: Optional[bool] = None, on_disk: Optional[bool] = None)

基类: BaseModel

lowercase: Optional[bool]

max_token_len: Optional[int]

min_token_len: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

tokenizer: Optional[TokenizerType]

type: TextIndexType

class TextIndexType(value)

基类: str, Enum

一个枚举。

TEXT = 'text'

class TokenizerType(value)

基类: str, Enum

一个枚举。

MULTILINGUAL = 'multilingual'

PREFIX = 'prefix'

WHITESPACE = 'whitespace'

WORD = 'word'

class TrackerStatusOneOf(value)

基类: str, Enum

一个枚举。

DONE = 'done'

OPTIMIZING = 'optimizing'

class TrackerStatusOneOf1(*, cancelled: str)

基类: BaseModel

cancelled: str

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class TrackerStatusOneOf2(*, error: str)

基类: BaseModel

error: str

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class TrackerTelemetry(*, name: str, segment_ids: List[int], status: Union[TrackerStatusOneOf, TrackerStatusOneOf1, TrackerStatusOneOf2], start_at: Union[datetime, date], end_at: Optional[Union[datetime, date]] = None)

基类: BaseModel

用于遥测的 Tracker 对象

end_at: Optional[Union[datetime, date]]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

name: str

segment_ids: List[int]

start_at: Union[datetime, date]

status: TrackerStatus

class UpdateCollection(*, vectors: Optional[Dict[str, VectorParamsDiff]] = None, optimizers_config: Optional[OptimizersConfigDiff] = None, params: Optional[CollectionParamsDiff] = None, hnsw_config: Optional[HnswConfigDiff] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization, Disabled]] = None, sparse_vectors: Optional[Dict[str, SparseVectorParams]] = None, strict_mode_config: Optional[StrictModeConfig] = None)

基类: BaseModel

用于更新现有 Collection 参数的操作

hnsw_config: Optional[HnswConfigDiff]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

optimizers_config: Optional[OptimizersConfigDiff]

params: Optional[CollectionParamsDiff]

quantization_config: Optional[QuantizationConfigDiff]

sparse_vectors: Optional[SparseVectorsConfig]

strict_mode_config: Optional[StrictModeConfig]

vectors: Optional[VectorsConfigDiff]

class UpdateOperations(*, operations: List[Union[UpsertOperation, DeleteOperation, SetPayloadOperation, OverwritePayloadOperation, DeletePayloadOperation, ClearPayloadOperation, UpdateVectorsOperation, DeleteVectorsOperation]])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

operations: List[UpdateOperation]

class UpdateResult(*, operation_id: Optional[int] = None, status: UpdateStatus)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

operation_id: Optional[int]

status: UpdateStatus

class UpdateStatus(value)

基类: str, Enum

Acknowledged - 请求已保存到 WAL 并将在队列中处理。Completed - 请求已完成，更改已生效。

ACKNOWLEDGED = 'acknowledged'

COMPLETED = 'completed'

class UpdateVectors(*, points: List[PointVectors], shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

points: List[PointVectors]

shard_key: Optional[ShardKeySelector]

class UpdateVectorsOperation(*, update_vectors: UpdateVectors)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

update_vectors: UpdateVectors

class UpsertOperation(*, upsert: Union[PointsBatch, PointsList])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

upsert: PointInsertOperations

class UuidIndexParams(*, type: UuidIndexType, is_tenant: Optional[bool] = None, on_disk: Optional[bool] = None)

基类: BaseModel

is_tenant: Optional[bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

type: UuidIndexType

class UuidIndexType(value)

基类: str, Enum

一个枚举。

UUID = 'uuid'

class ValuesCount(*, lt: Optional[int] = None, gt: Optional[int] = None, gte: Optional[int] = None, lte: Optional[int] = None)

基类: BaseModel

值计数过滤请求

gt: Optional[int]

gte: Optional[int]

lt: Optional[int]

lte: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

class VectorDataConfig(*, size: int, distance: Distance, storage_type: Union[VectorStorageTypeOneOf, VectorStorageTypeOneOf1, VectorStorageTypeOneOf2, VectorStorageTypeOneOf3]], index: Union[IndexesOneOf, IndexesOneOf1], quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, multivector_config: Optional[MultiVectorConfig] = None, datatype: Optional[VectorStorageDatatype] = None)

基类: BaseModel

单个向量数据存储配置

datatype: Optional[VectorStorageDatatype]

distance: Distance

index: Indexes

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

multivector_config: Optional[MultiVectorConfig]

quantization_config: Optional[QuantizationConfig]

size: int

storage_type: VectorStorageType

class VectorDataInfo(*, num_vectors: int, num_indexed_vectors: int, num_deleted_vectors: int)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

num_deleted_vectors: int

num_indexed_vectors: int

num_vectors: int

class VectorIndexSearchesTelemetry(*, index_name: Optional[str] = None, unfiltered_plain: OperationDurationStatistics, unfiltered_hnsw: OperationDurationStatistics, unfiltered_sparse: OperationDurationStatistics, filtered_plain: OperationDurationStatistics, filtered_small_cardinality: OperationDurationStatistics, filtered_large_cardinality: OperationDurationStatistics, filtered_exact: OperationDurationStatistics, filtered_sparse: OperationDurationStatistics, unfiltered_exact: OperationDurationStatistics)

基类: BaseModel

filtered_exact: OperationDurationStatistics

filtered_large_cardinality: OperationDurationStatistics

filtered_plain: OperationDurationStatistics

filtered_small_cardinality: OperationDurationStatistics

filtered_sparse: OperationDurationStatistics

index_name: Optional[str]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

unfiltered_exact: OperationDurationStatistics

unfiltered_hnsw: OperationDurationStatistics

unfiltered_plain: OperationDurationStatistics

unfiltered_sparse: OperationDurationStatistics

class VectorParams(*, size: int, distance: Distance, hnsw_config: Optional[HnswConfigDiff] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, on_disk: Optional[bool] = None, datatype: Optional[Datatype] = None, multivector_config: Optional[MultiVectorConfig] = None)

基类: BaseModel

单个向量数据存储参数

datatype: Optional[Datatype]

distance: Distance

hnsw_config: Optional[HnswConfigDiff]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

multivector_config: Optional[MultiVectorConfig]

on_disk: Optional[bool]

quantization_config: Optional[QuantizationConfig]

size: int

class VectorParamsDiff(*, hnsw_config: Optional[HnswConfigDiff] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization, Disabled]] = None, on_disk: Optional[bool] = None)

基类: BaseModel

hnsw_config: Optional[HnswConfigDiff]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

on_disk: Optional[bool]

quantization_config: Optional[QuantizationConfigDiff]

class VectorStorageDatatype(value)

基类: str, Enum

向量存储类型

FLOAT16 = 'float16'

FLOAT32 = 'float32'

UINT8 = 'uint8'

class VectorStorageTypeOneOf(value)

基类: str, Enum

内存 (RAM) 存储 速度非常快，但会消耗大量内存。

MEMORY = 'Memory'

class VectorStorageTypeOneOf1(value)

基类: str, Enum

mmap 文件存储，不可追加 搜索性能取决于磁盘速度以及可容纳在内存中的向量比例。

MMAP = 'Mmap'

class VectorStorageTypeOneOf2(value)

基类: str, Enum

分块 mmap 文件存储，可追加 搜索性能取决于磁盘速度以及可容纳在内存中的向量比例。

CHUNKEDMMAP = 'ChunkedMmap'

class VectorStorageTypeOneOf3(value)

基类: str, Enum

与 ChunkedMmap 相同，但向量被强制锁定在内存中。通过这种方式，我们避免了对磁盘的冷请求，但存在内存不足的风险。设计用于替代不依赖于 RocksDB 的 Memory。

INRAMCHUNKEDMMAP = 'InRamChunkedMmap'

class VersionInfo(*, title: str, version: str, commit: Optional[str] = None)

基类: BaseModel

commit: Optional[str]

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

title: str

version: str

class WalConfig(*, wal_capacity_mb: int, wal_segments_ahead: int)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

wal_capacity_mb: int

wal_segments_ahead: int

class WalConfigDiff(*, wal_capacity_mb: Optional[int] = None, wal_segments_ahead: Optional[int] = None)

基类: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

wal_capacity_mb: Optional[int]

wal_segments_ahead: Optional[int]

class WebApiTelemetry(*, responses: Dict[str, Dict[str, OperationDurationStatistics]])

基类: BaseModel

model_config: ClassVar[ConfigDict] = {}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

responses: Dict[str, Dict[str, OperationDurationStatistics]]

class WithLookup(*, collection: str, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vectors: Optional[Union[bool, List[str]]] = None)

基类: BaseModel

collection: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

模型的配置，应该是一个符合 [ConfigDict][pydantic.config.ConfigDict] 的字典。

with_payload: Optional[WithPayloadInterface]

with_vectors: Optional[WithVector]

class WriteOrdering(value)

基类: str, Enum

定义了集合操作的写顺序保证 * weak - 写操作可能被重新排序，速度更快，默认 * medium - 写操作通过动态选择的领导者进行，在领导者变更时可能短时间内不一致 * strong - 写操作通过永久领导者进行，一致，但如果领导者宕机则可能不可用

MEDIUM = 'medium'

STRONG = 'strong'

WEAK = 'weak'