weaviate-client
Preparing search index...
web/src
Module web/src
Interfaces
Collection
Collections
WeaviateClient
Type Aliases
ConnectToCustomOptions
ConnectToLocalOptions
Variables
default
Functions
connectToCustom
connectToLocal
connectToWeaviateCloud
References
AccessTokenCredentialsInput
→
AccessTokenCredentialsInput
Aggregate
→
Aggregate
AggregateBaseOptions
→
AggregateBaseOptions
AggregateBoolean
→
AggregateBoolean
AggregateDate
→
AggregateDate
AggregatedGeoCoordinate
→
AggregatedGeoCoordinate
AggregateGroupBy
→
AggregateGroupBy
AggregateGroupByHybridOptions
→
AggregateGroupByHybridOptions
AggregateGroupByNearOptions
→
AggregateGroupByNearOptions
AggregateGroupByOptions
→
AggregateGroupByOptions
AggregateGroupByResult
→
AggregateGroupByResult
AggregateHybridOptions
→
AggregateHybridOptions
AggregateMetrics
→
AggregateMetrics
AggregateNearOptions
→
AggregateNearOptions
AggregateNumber
→
AggregateNumber
AggregateOverAllOptions
→
AggregateOverAllOptions
AggregateReference
→
AggregateReference
AggregateResult
→
AggregateResult
AggregateText
→
AggregateText
AggregateType
→
AggregateType
AliasAction
→
AliasAction
AliasPermission
→
AliasPermission
ApiKey
→
ApiKey
AsyncReplicationConfig
→
AsyncReplicationConfig
AuthAccessTokenCredentials
→
AuthAccessTokenCredentials
AuthClientCredentials
→
AuthClientCredentials
AuthCredentials
→
AuthCredentials
AuthUserPasswordCredentials
→
AuthUserPasswordCredentials
Backend
→
Backend
Backup
→
Backup
BackupArgs
→
BackupArgs
BackupCollection
→
BackupCollection
BackupCollectionArgs
→
BackupCollectionArgs
BackupCompressionLevel
→
BackupCompressionLevel
BackupConfigCreate
→
BackupConfigCreate
BackupConfigRestore
→
BackupConfigRestore
BackupsAction
→
BackupsAction
BackupsPermission
→
BackupsPermission
BackupStatus
→
BackupStatus
BackupStatusArgs
→
BackupStatusArgs
BaseBm25Options
→
BaseBm25Options
BaseHybridOptions
→
BaseHybridOptions
BaseNearOptions
→
BaseNearOptions
BaseNearTextOptions
→
BaseNearTextOptions
BaseRefProperty
→
BaseRefProperty
BatchObject
→
BatchObject
BatchObjects
→
BatchObjects
BatchObjectsReturn
→
BatchObjectsReturn
BatchReference
→
BatchReference
BatchReferencesReturn
→
BatchReferencesReturn
Beacon
→
Beacon
Bm25Operator
→
Bm25Operator
Bm25OperatorOptions
→
Bm25OperatorOptions
Bm25Options
→
Bm25Options
BooleanKeys
→
BooleanKeys
Boost
→
Boost
BoostOptions
→
BoostOptions
BQConfig
→
BQConfig
BQConfigCreate
→
BQConfigCreate
BQConfigUpdate
→
BQConfigUpdate
CallOptions
→
CallOptions
cleanHost
→
cleanHost
ClientCredentialsInput
→
ClientCredentialsInput
ClientParams
→
ClientParams
Cluster
→
Cluster
ClusterAction
→
ClusterAction
ClusterPermission
→
ClusterPermission
CollectionConfig
→
CollectionConfig
CollectionConfigCreate
→
CollectionConfigCreate
CollectionConfigUpdate
→
CollectionConfigUpdate
CollectionsAction
→
CollectionsAction
CollectionsPermission
→
CollectionsPermission
Config
→
Config
configGuards
→
configGuards
configure
→
configure
ConfigureNonTextMultiVectorizerOptions
→
ConfigureNonTextMultiVectorizerOptions
ConfigureNonTextVectorizerOptions
→
ConfigureNonTextVectorizerOptions
ConfigureTextMultiVectorizerOptions
→
ConfigureTextMultiVectorizerOptions
ConfigureTextVectorizerOptions
→
ConfigureTextVectorizerOptions
ConnectionGQL
→
ConnectionGQL
ConnectionGRPC
→
ConnectionGRPC
ConnectionParams
→
ConnectionParams
ConnectionREST
→
ConnectionREST
ConnectToWCDOptions
→
ConnectToWCDOptions
ConnectToWCSOptions
→
ConnectToWCSOptions
ConnectToWeaviateCloudOptions
→
ConnectToWeaviateCloudOptions
ConsistencyLevel
→
ConsistencyLevel
Context
→
Context
CrossReference
→
CrossReference
CrossReferenceDefault
→
CrossReferenceDefault
CrossReferences
→
CrossReferences
Curve
→
Curve
Data
→
Data
DataAction
→
DataAction
DataObject
→
DataObject
DataPermission
→
DataPermission
dataType
→
dataType
DataType
→
DataType
DateKeys
→
DateKeys
DeleteManyObject
→
DeleteManyObject
DeleteManyOptions
→
DeleteManyOptions
DeleteManyReturn
→
DeleteManyReturn
Diversity
→
Diversity
DiversityConfig
→
DiversityConfig
DiversityGuards
→
DiversityGuards
ErrorObject
→
ErrorObject
ErrorReference
→
ErrorReference
FetchObjectByIdOptions
→
FetchObjectByIdOptions
FetchObjectsOptions
→
FetchObjectsOptions
filter
→
filter
Filter
→
Filter
FilterByCount
→
FilterByCount
FilterById
→
FilterById
FilterByProperty
→
FilterByProperty
FilterByTime
→
FilterByTime
Filters
→
Filters
FilterValue
→
FilterValue
Generate
→
Generate
GenerateOptions
→
GenerateOptions
GenerateReturn
→
GenerateReturn
generateUuid5
→
generateUuid5
generative
→
generative
GenerativeAnthropicConfig
→
GenerativeAnthropicConfig
GenerativeAnthropicConfigCreate
→
GenerativeAnthropicConfigCreate
GenerativeAnthropicConfigRuntime
→
GenerativeAnthropicConfigRuntime
GenerativeAnyscaleConfig
→
GenerativeAnyscaleConfig
GenerativeAnyscaleConfigCreate
→
GenerativeAnyscaleConfigCreate
GenerativeAnyscaleConfigRuntime
→
GenerativeAnyscaleConfigRuntime
GenerativeAWSConfig
→
GenerativeAWSConfig
GenerativeAWSConfigCreate
→
GenerativeAWSConfigCreate
GenerativeAWSConfigRuntime
→
GenerativeAWSConfigRuntime
GenerativeAzureOpenAIConfig
→
GenerativeAzureOpenAIConfig
GenerativeAzureOpenAIConfigCreate
→
GenerativeAzureOpenAIConfigCreate
GenerativeCohereConfig
→
GenerativeCohereConfig
GenerativeCohereConfigCreate
→
GenerativeCohereConfigCreate
GenerativeCohereConfigRuntime
→
GenerativeCohereConfigRuntime
GenerativeConfig
→
GenerativeConfig
GenerativeConfigCreate
→
GenerativeConfigCreate
GenerativeConfigCreateType
→
GenerativeConfigCreateType
GenerativeConfigRuntime
→
GenerativeConfigRuntime
GenerativeConfigRuntimeType
→
GenerativeConfigRuntimeType
GenerativeConfigType
→
GenerativeConfigType
GenerativeContextualAIConfig
→
GenerativeContextualAIConfig
GenerativeContextualAIConfigCreate
→
GenerativeContextualAIConfigCreate
GenerativeContextualAIConfigRuntime
→
GenerativeContextualAIConfigRuntime
GenerativeDatabricksConfig
→
GenerativeDatabricksConfig
GenerativeDatabricksConfigCreate
→
GenerativeDatabricksConfigCreate
GenerativeDatabricksConfigRuntime
→
GenerativeDatabricksConfigRuntime
GenerativeDummyConfigRuntime
→
GenerativeDummyConfigRuntime
GenerativeFriendliAIConfig
→
GenerativeFriendliAIConfig
GenerativeFriendliAIConfigCreate
→
GenerativeFriendliAIConfigCreate
GenerativeFriendliAIConfigRuntime
→
GenerativeFriendliAIConfigRuntime
GenerativeGenericObject
→
GenerativeGenericObject
GenerativeGoogleConfig
→
GenerativeGoogleConfig
GenerativeGoogleConfigRuntime
→
GenerativeGoogleConfigRuntime
GenerativeGroupByResult
→
GenerativeGroupByResult
GenerativeGroupByReturn
→
GenerativeGroupByReturn
GenerativeGrouped
→
GenerativeGrouped
GenerativeMetadata
→
GenerativeMetadata
GenerativeMistralConfig
→
GenerativeMistralConfig
GenerativeMistralConfigCreate
→
GenerativeMistralConfigCreate
GenerativeMistralConfigRuntime
→
GenerativeMistralConfigRuntime
GenerativeNonGenericObject
→
GenerativeNonGenericObject
GenerativeNvidiaConfig
→
GenerativeNvidiaConfig
GenerativeNvidiaConfigCreate
→
GenerativeNvidiaConfigCreate
GenerativeNvidiaConfigRuntime
→
GenerativeNvidiaConfigRuntime
GenerativeObject
→
GenerativeObject
GenerativeOllamaConfig
→
GenerativeOllamaConfig
GenerativeOllamaConfigCreate
→
GenerativeOllamaConfigCreate
GenerativeOllamaConfigRuntime
→
GenerativeOllamaConfigRuntime
GenerativeOpenAIConfig
→
GenerativeOpenAIConfig
GenerativeOpenAIConfigBase
→
GenerativeOpenAIConfigBase
GenerativeOpenAIConfigBaseCreate
→
GenerativeOpenAIConfigBaseCreate
GenerativeOpenAIConfigCreate
→
GenerativeOpenAIConfigCreate
GenerativeOpenAIConfigRuntime
→
GenerativeOpenAIConfigRuntime
GenerativePaLMConfig
→
GenerativePaLMConfig
GenerativePaLMConfigCreate
→
GenerativePaLMConfigCreate
generativeParameters
→
generativeParameters
GenerativeReturn
→
GenerativeReturn
GenerativeSearch
→
GenerativeSearch
GenerativeSingle
→
GenerativeSingle
GenerativeXAIConfig
→
GenerativeXAIConfig
GenerativeXAIConfigCreate
→
GenerativeXAIConfigCreate
GenerativeXAIConfigRuntime
→
GenerativeXAIConfigRuntime
GeoCoordinate
→
GeoCoordinate
GeoRangeFilter
→
GeoRangeFilter
GetReplicationOpOptions
→
GetReplicationOpOptions
GroupAssignment
→
GroupAssignment
GroupByAggregate
→
GroupByAggregate
GroupByBm25Options
→
GroupByBm25Options
GroupByHybridOptions
→
GroupByHybridOptions
GroupByNearOptions
→
GroupByNearOptions
GroupByNearTextOptions
→
GroupByNearTextOptions
GroupByObject
→
GroupByObject
GroupByOptions
→
GroupByOptions
GroupByResult
→
GroupByResult
GroupByReturn
→
GroupByReturn
GroupedTask
→
GroupedTask
GroupsAction
→
GroupsAction
GroupsPermission
→
GroupsPermission
helpers
→
helpers
HybridNearTextSubSearch
→
HybridNearTextSubSearch
HybridNearVectorSubSearch
→
HybridNearVectorSubSearch
HybridOptions
→
HybridOptions
HybridSubSearchBase
→
HybridSubSearchBase
ICollection
→
ICollection
ICollections
→
ICollections
IConnection
→
IConnection
Img2VecNeuralConfig
→
Img2VecNeuralConfig
Img2VecNeuralConfigCreate
→
Img2VecNeuralConfigCreate
InsertObject
→
InsertObject
InternalConnectionParams
→
InternalConnectionParams
InvertedIndexConfig
→
InvertedIndexConfig
InvertedIndexConfigCreate
→
InvertedIndexConfigCreate
InvertedIndexConfigUpdate
→
InvertedIndexConfigUpdate
InvertedIndexName
→
InvertedIndexName
IsEmptyType
→
IsEmptyType
IsNestedField
→
IsNestedField
IsPrimitiveField
→
IsPrimitiveField
IsWeaviateField
→
IsWeaviateField
Iterator
→
Iterator
IteratorOptions
→
IteratorOptions
IWeaviateClient
→
IWeaviateClient
LegacyVectorizerConfigUpdate
→
LegacyVectorizerConfigUpdate
McpAction
→
McpAction
McpPermission
→
McpPermission
Metadata
→
Metadata
MetadataKeys
→
MetadataKeys
metrics
→
metrics
Metrics
→
Metrics
MetricsBase
→
MetricsBase
MetricsBoolean
→
MetricsBoolean
MetricsDate
→
MetricsDate
MetricsInput
→
MetricsInput
MetricsInteger
→
MetricsInteger
MetricsManager
→
MetricsManager
MetricsNumber
→
MetricsNumber
MetricsProperty
→
MetricsProperty
MetricsText
→
MetricsText
MMR
→
MMR
Modifier
→
Modifier
ModuleConfig
→
ModuleConfig
MoveOptions
→
MoveOptions
Multi2MultivecJinaAIConfig
→
Multi2MultivecJinaAIConfig
Multi2MultivecJinaAIConfigCreate
→
Multi2MultivecJinaAIConfigCreate
Multi2MultivecWeaviateConfig
→
Multi2MultivecWeaviateConfig
Multi2MultivecWeaviateConfigCreate
→
Multi2MultivecWeaviateConfigCreate
Multi2VecAWSConfig
→
Multi2VecAWSConfig
Multi2VecAWSConfigCreate
→
Multi2VecAWSConfigCreate
Multi2VecBindConfig
→
Multi2VecBindConfig
Multi2VecBindConfigCreate
→
Multi2VecBindConfigCreate
Multi2VecClipConfig
→
Multi2VecClipConfig
Multi2VecClipConfigCreate
→
Multi2VecClipConfigCreate
Multi2VecCohereConfig
→
Multi2VecCohereConfig
Multi2VecCohereConfigCreate
→
Multi2VecCohereConfigCreate
Multi2VecField
→
Multi2VecField
Multi2VecGoogleConfig
→
Multi2VecGoogleConfig
Multi2VecGoogleConfigCreate
→
Multi2VecGoogleConfigCreate
Multi2VecGoogleGeminiConfig
→
Multi2VecGoogleGeminiConfig
Multi2VecGoogleGeminiConfigCreate
→
Multi2VecGoogleGeminiConfigCreate
Multi2VecJinaAIConfig
→
Multi2VecJinaAIConfig
Multi2VecJinaAIConfigCreate
→
Multi2VecJinaAIConfigCreate
Multi2VecNvidiaConfig
→
Multi2VecNvidiaConfig
Multi2VecNvidiaConfigCreate
→
Multi2VecNvidiaConfigCreate
Multi2VecPalmConfig
→
Multi2VecPalmConfig
Multi2VecPalmConfigCreate
→
Multi2VecPalmConfigCreate
Multi2VecTwelveLabsConfig
→
Multi2VecTwelveLabsConfig
Multi2VecTwelveLabsConfigCreate
→
Multi2VecTwelveLabsConfigCreate
Multi2VecVoyageAIConfig
→
Multi2VecVoyageAIConfig
Multi2VecVoyageAIConfigCreate
→
Multi2VecVoyageAIConfigCreate
MultiTargetVector
→
MultiTargetVector
MultiTargetVectorJoin
→
MultiTargetVectorJoin
MultiTargetVectorJoinCombination
→
MultiTargetVectorJoinCombination
MultiTargetVectorWeights
→
MultiTargetVectorWeights
MultiTenancyConfig
→
MultiTenancyConfig
MultiTenancyConfigCreate
→
MultiTenancyConfigCreate
MultiTenancyConfigUpdate
→
MultiTenancyConfigUpdate
MultiVectorConfig
→
MultiVectorConfig
MultiVectorConfigCreate
→
MultiVectorConfigCreate
MultiVectorEncodingConfig
→
MultiVectorEncodingConfig
MultiVectorEncodingConfigCreate
→
MultiVectorEncodingConfigCreate
multiVectors
→
multiVectors
MultiVectorType
→
MultiVectorType
MuveraEncodingConfig
→
MuveraEncodingConfig
MuveraEncodingConfigCreate
→
MuveraEncodingConfigCreate
NearMediaType
→
NearMediaType
NearOptions
→
NearOptions
NearTextOptions
→
NearTextOptions
NestedDataTypeConfig
→
NestedDataTypeConfig
NestedField
→
NestedField
NestedKeys
→
NestedKeys
NestedProperties
→
NestedProperties
NestedPropertyConfigCreate
→
NestedPropertyConfigCreate
NestedPropertyConfigCreateBase
→
NestedPropertyConfigCreateBase
NestedPropertyCreate
→
NestedPropertyCreate
Node
→
Node
NodesAction
→
NodesAction
NodesOptions
→
NodesOptions
NodesPermission
→
NodesPermission
NonReferenceInputs
→
NonReferenceInputs
NonRefKeys
→
NonRefKeys
NoVectorizerConfig
→
NoVectorizerConfig
NumberKeys
→
NumberKeys
NumericDecay
→
NumericDecay
ObjectDataType
→
ObjectDataType
ObjectTTLConfig
→
ObjectTTLConfig
ObjectTTLConfigCreate
→
ObjectTTLConfigCreate
ObjectTTLConfigUpdate
→
ObjectTTLConfigUpdate
Operator
→
Operator
Option
→
Option
Output
→
Output
Permission
→
Permission
permissions
→
permissions
PermissionsInput
→
PermissionsInput
PhoneNumber
→
PhoneNumber
PhoneNumberInput
→
PhoneNumberInput
PQConfig
→
PQConfig
PQConfigCreate
→
PQConfigCreate
PQConfigUpdate
→
PQConfigUpdate
PQEncoderConfig
→
PQEncoderConfig
PQEncoderDistribution
→
PQEncoderDistribution
PQEncoderType
→
PQEncoderType
PrimitiveDataType
→
PrimitiveDataType
PrimitiveField
→
PrimitiveField
PrimitiveKeys
→
PrimitiveKeys
Properties
→
Properties
PropertiesMetrics
→
PropertiesMetrics
Property
→
Property
PropertyConfig
→
PropertyConfig
PropertyConfigCreate
→
PropertyConfigCreate
PropertyConfigCreateBase
→
PropertyConfigCreateBase
PropertyDescriptionsUpdate
→
PropertyDescriptionsUpdate
PropertyOf
→
PropertyOf
PropertyValue
→
PropertyValue
PropertyVectorizerConfig
→
PropertyVectorizerConfig
ProtocolParams
→
ProtocolParams
ProxiesParams
→
ProxiesParams
Quantizer
→
Quantizer
QuantizerConfig
→
QuantizerConfig
QuantizerConfigCreate
→
QuantizerConfigCreate
QuantizerConfigUpdate
→
QuantizerConfigUpdate
QuantizerRecursivePartial
→
QuantizerRecursivePartial
Query
→
Query
queryFactory
→
queryFactory
QueryMetadata
→
QueryMetadata
QueryNested
→
QueryNested
QueryProfile
→
QueryProfile
QueryProperty
→
QueryProperty
QueryReference
→
QueryReference
QueryReplicationOpsOptions
→
QueryReplicationOpsOptions
QueryReturn
→
QueryReturn
QueryShardingStateOptions
→
QueryShardingStateOptions
reconfigure
→
reconfigure
RecursivePartial
→
RecursivePartial
Ref2VecCentroidConfig
→
Ref2VecCentroidConfig
Ref2VecCentroidConfigCreate
→
Ref2VecCentroidConfigCreate
Reference
→
Reference
ReferenceArgs
→
ReferenceArgs
ReferenceConfig
→
ReferenceConfig
ReferenceConfigBaseCreate
→
ReferenceConfigBaseCreate
ReferenceConfigCreate
→
ReferenceConfigCreate
ReferenceInput
→
ReferenceInput
ReferenceInputs
→
ReferenceInputs
ReferenceManager
→
ReferenceManager
ReferenceMultiTargetConfigCreate
→
ReferenceMultiTargetConfigCreate
ReferenceSingleTargetConfigCreate
→
ReferenceSingleTargetConfigCreate
ReferenceToMultiTarget
→
ReferenceToMultiTarget
RefKeys
→
RefKeys
RefProperty
→
RefProperty
RefPropertyDefault
→
RefPropertyDefault
ReplaceObject
→
ReplaceObject
ReplicateAction
→
ReplicateAction
ReplicateArgs
→
ReplicateArgs
ReplicatePermission
→
ReplicatePermission
ReplicationConfig
→
ReplicationConfig
ReplicationConfigCreate
→
ReplicationConfigCreate
ReplicationConfigUpdate
→
ReplicationConfigUpdate
ReplicationDeletionStrategy
→
ReplicationDeletionStrategy
ReplicationOperation
→
ReplicationOperation
Replications
→
Replications
RequiresNested
→
RequiresNested
reranker
→
reranker
Reranker
→
Reranker
RerankerCohereConfig
→
RerankerCohereConfig
RerankerConfig
→
RerankerConfig
RerankerConfigType
→
RerankerConfigType
RerankerContextualAIConfig
→
RerankerContextualAIConfig
RerankerJinaAIConfig
→
RerankerJinaAIConfig
RerankerNvidiaConfig
→
RerankerNvidiaConfig
RerankerTransformersConfig
→
RerankerTransformersConfig
RerankerVoyageAIConfig
→
RerankerVoyageAIConfig
RerankOptions
→
RerankOptions
ReturnMetadata
→
ReturnMetadata
ReturnProperties
→
ReturnProperties
ReturnReferences
→
ReturnReferences
ReturnVectors
→
ReturnVectors
Role
→
Role
RolesAction
→
RolesAction
RolesPermission
→
RolesPermission
RQConfig
→
RQConfig
RQConfigCreate
→
RQConfigCreate
RQConfigUpdate
→
RQConfigUpdate
SearchOptions
→
SearchOptions
SearchProfile
→
SearchProfile
ShardingConfig
→
ShardingConfig
ShardingConfigCreate
→
ShardingConfigCreate
ShardingState
→
ShardingState
ShardProfile
→
ShardProfile
SinglePrompt
→
SinglePrompt
SingleVectorType
→
SingleVectorType
Sort
→
Sort
SortBy
→
SortBy
Sorting
→
Sorting
SQConfig
→
SQConfig
SQConfigCreate
→
SQConfigCreate
SQConfigUpdate
→
SQConfigUpdate
Stopwords
→
Stopwords
StopwordsPreset
→
StopwordsPreset
Tenant
→
Tenant
TenantBase
→
TenantBase
TenantCreate
→
TenantCreate
Tenants
→
Tenants
TenantsAction
→
TenantsAction
TenantsPermission
→
TenantsPermission
TenantUpdate
→
TenantUpdate
Text2MultiVecJinaAIConfig
→
Text2MultiVecJinaAIConfig
Text2MultiVecJinaAIConfigCreate
→
Text2MultiVecJinaAIConfigCreate
Text2VecAWSConfig
→
Text2VecAWSConfig
Text2VecAWSConfigCreate
→
Text2VecAWSConfigCreate
Text2VecAzureOpenAIConfig
→
Text2VecAzureOpenAIConfig
Text2VecAzureOpenAIConfigCreate
→
Text2VecAzureOpenAIConfigCreate
Text2VecCohereConfig
→
Text2VecCohereConfig
Text2VecCohereConfigCreate
→
Text2VecCohereConfigCreate
Text2VecContextionaryConfig
→
Text2VecContextionaryConfig
Text2VecContextionaryConfigCreate
→
Text2VecContextionaryConfigCreate
Text2VecDatabricksConfig
→
Text2VecDatabricksConfig
Text2VecDatabricksConfigCreate
→
Text2VecDatabricksConfigCreate
Text2VecDigitalOceanConfig
→
Text2VecDigitalOceanConfig
Text2VecDigitalOceanConfigCreate
→
Text2VecDigitalOceanConfigCreate
Text2VecGoogleAiStudioConfig
→
Text2VecGoogleAiStudioConfig
Text2VecGoogleAiStudioConfigCreate
→
Text2VecGoogleAiStudioConfigCreate
Text2VecGoogleConfig
→
Text2VecGoogleConfig
Text2VecGoogleConfigCreate
→
Text2VecGoogleConfigCreate
Text2VecGoogleGeminiConfig
→
Text2VecGoogleGeminiConfig
Text2VecGoogleGeminiConfigCreate
→
Text2VecGoogleGeminiConfigCreate
Text2VecGPT4AllConfig
→
Text2VecGPT4AllConfig
Text2VecGPT4AllConfigCreate
→
Text2VecGPT4AllConfigCreate
Text2VecHuggingFaceConfig
→
Text2VecHuggingFaceConfig
Text2VecHuggingFaceConfigCreate
→
Text2VecHuggingFaceConfigCreate
Text2VecJinaAIConfig
→
Text2VecJinaAIConfig
Text2VecJinaAIConfigCreate
→
Text2VecJinaAIConfigCreate
Text2VecJinaConfig
→
Text2VecJinaConfig
Text2VecMistralConfig
→
Text2VecMistralConfig
Text2VecMistralConfigCreate
→
Text2VecMistralConfigCreate
Text2VecModel2Vec
→
Text2VecModel2Vec
Text2VecModel2VecConfigCreate
→
Text2VecModel2VecConfigCreate
Text2VecMorphConfig
→
Text2VecMorphConfig
Text2VecMorphConfigCreate
→
Text2VecMorphConfigCreate
Text2VecNvidiaConfig
→
Text2VecNvidiaConfig
Text2VecNvidiaConfigCreate
→
Text2VecNvidiaConfigCreate
Text2VecOllamaConfig
→
Text2VecOllamaConfig
Text2VecOllamaConfigCreate
→
Text2VecOllamaConfigCreate
Text2VecOpenAIConfig
→
Text2VecOpenAIConfig
Text2VecOpenAIConfigCreate
→
Text2VecOpenAIConfigCreate
Text2VecPalmConfig
→
Text2VecPalmConfig
Text2VecPalmConfigCreate
→
Text2VecPalmConfigCreate
Text2VecTransformersConfig
→
Text2VecTransformersConfig
Text2VecTransformersConfigCreate
→
Text2VecTransformersConfigCreate
Text2VecVoyageAIConfig
→
Text2VecVoyageAIConfig
Text2VecVoyageAIConfigCreate
→
Text2VecVoyageAIConfigCreate
Text2VecWeaviateConfig
→
Text2VecWeaviateConfig
Text2VecWeaviateConfigCreate
→
Text2VecWeaviateConfigCreate
TextAnalyzerConfig
→
TextAnalyzerConfig
TimeDecay
→
TimeDecay
TimeoutParams
→
TimeoutParams
tokenization
→
tokenization
Tokenization
→
Tokenization
Transports
→
Transports
TransportsMaker
→
TransportsMaker
TransportsParams
→
TransportsParams
UncompressedConfig
→
UncompressedConfig
UncompressedConfigCreate
→
UncompressedConfigCreate
UnionOf
→
UnionOf
UpdateObject
→
UpdateObject
UserAssignment
→
UserAssignment
UserPasswordCredentialsInput
→
UserPasswordCredentialsInput
UsersAction
→
UsersAction
UsersPermission
→
UsersPermission
VectorConfig
→
VectorConfig
VectorConfigCreate
→
VectorConfigCreate
VectorConfigUpdate
→
VectorConfigUpdate
VectorDistance
→
VectorDistance
vectorDistances
→
vectorDistances
vectorIndex
→
vectorIndex
VectorIndex
→
VectorIndex
VectorIndexConfig
→
VectorIndexConfig
VectorIndexConfigCreate
→
VectorIndexConfigCreate
VectorIndexConfigCreateType
→
VectorIndexConfigCreateType
VectorIndexConfigDymamicUpdate
→
VectorIndexConfigDymamicUpdate
VectorIndexConfigDynamic
→
VectorIndexConfigDynamic
VectorIndexConfigDynamicCreate
→
VectorIndexConfigDynamicCreate
VectorIndexConfigDynamicCreateOptions
→
VectorIndexConfigDynamicCreateOptions
VectorIndexConfigDynamicUpdate
→
VectorIndexConfigDynamicUpdate
VectorIndexConfigFlat
→
VectorIndexConfigFlat
VectorIndexConfigFlatCreate
→
VectorIndexConfigFlatCreate
VectorIndexConfigFlatCreateOptions
→
VectorIndexConfigFlatCreateOptions
VectorIndexConfigFlatUpdate
→
VectorIndexConfigFlatUpdate
VectorIndexConfigHFresh
→
VectorIndexConfigHFresh
VectorIndexConfigHFreshCreate
→
VectorIndexConfigHFreshCreate
VectorIndexConfigHFreshCreateOptions
→
VectorIndexConfigHFreshCreateOptions
VectorIndexConfigHFreshUpdate
→
VectorIndexConfigHFreshUpdate
VectorIndexConfigHNSW
→
VectorIndexConfigHNSW
VectorIndexConfigHNSWCreate
→
VectorIndexConfigHNSWCreate
VectorIndexConfigHNSWCreateOptions
→
VectorIndexConfigHNSWCreateOptions
VectorIndexConfigHNSWUpdate
→
VectorIndexConfigHNSWUpdate
VectorIndexConfigType
→
VectorIndexConfigType
VectorIndexConfigUpdate
→
VectorIndexConfigUpdate
VectorIndexConfigUpdateType
→
VectorIndexConfigUpdateType
VectorIndexFilterStrategy
→
VectorIndexFilterStrategy
VectorIndexType
→
VectorIndexType
vectorizer
→
vectorizer
Vectorizer
→
Vectorizer
VectorizerConfig
→
VectorizerConfig
VectorizerConfigCreateType
→
VectorizerConfigCreateType
VectorizerConfigType
→
VectorizerConfigType
VectorizerCreateOptions
→
VectorizerCreateOptions
VectorizersConfigAdd
→
VectorizersConfigAdd
VectorizersConfigCreate
→
VectorizersConfigCreate
VectorizerUpdateOptions
→
VectorizerUpdateOptions
vectors
→
vectors
Vectors
→
Vectors
WeaviateBackupCanceled
→
WeaviateBackupCanceled
WeaviateBackupCancellationError
→
WeaviateBackupCancellationError
WeaviateBackupFailed
→
WeaviateBackupFailed
WeaviateBatchError
→
WeaviateBatchError
WeaviateBatchStreamError
→
WeaviateBatchStreamError
WeaviateClass
→
WeaviateClass
WeaviateDeleteManyError
→
WeaviateDeleteManyError
WeaviateDeserializationError
→
WeaviateDeserializationError
WeaviateField
→
WeaviateField
WeaviateGenericObject
→
WeaviateGenericObject
WeaviateGRPCUnavailableError
→
WeaviateGRPCUnavailableError
WeaviateInsufficientPermissionsError
→
WeaviateInsufficientPermissionsError
WeaviateInvalidInputError
→
WeaviateInvalidInputError
WeaviateNonGenericObject
→
WeaviateNonGenericObject
WeaviateObject
→
WeaviateObject
WeaviateQueryError
→
WeaviateQueryError
WeaviateRequestTimeoutError
→
WeaviateRequestTimeoutError
WeaviateReturn
→
WeaviateReturn
WeaviateSerializationError
→
WeaviateSerializationError
WeaviateStartUpError
→
WeaviateStartUpError
WeaviateTenantsGetError
→
WeaviateTenantsGetError
WeaviateUnauthenticatedError
→
WeaviateUnauthenticatedError
WeaviateUnexpectedResponseError
→
WeaviateUnexpectedResponseError
WeaviateUnexpectedStatusCodeError
→
WeaviateUnexpectedStatusCodeError
WeaviateUnsupportedFeatureError
→
WeaviateUnsupportedFeatureError
weaviateV2
→
weaviateV2
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Interfaces
Collection
Collections
Weaviate
Client
Type Aliases
Connect
To
Custom
Options
Connect
To
Local
Options
Variables
default
Functions
connect
To
Custom
connect
To
Local
connect
To
Weaviate
Cloud
References
Access
Token
Credentials
Input
Aggregate
Aggregate
Base
Options
Aggregate
Boolean
Aggregate
Date
Aggregated
Geo
Coordinate
Aggregate
Group
By
Aggregate
Group
By
Hybrid
Options
Aggregate
Group
By
Near
Options
Aggregate
Group
By
Options
Aggregate
Group
By
Result
Aggregate
Hybrid
Options
Aggregate
Metrics
Aggregate
Near
Options
Aggregate
Number
Aggregate
Over
All
Options
Aggregate
Reference
Aggregate
Result
Aggregate
Text
Aggregate
Type
Alias
Action
Alias
Permission
Api
Key
Async
Replication
Config
Auth
Access
Token
Credentials
Auth
Client
Credentials
Auth
Credentials
Auth
User
Password
Credentials
Backend
Backup
Backup
Args
Backup
Collection
Backup
Collection
Args
Backup
Compression
Level
Backup
Config
Create
Backup
Config
Restore
Backups
Action
Backups
Permission
Backup
Status
Backup
Status
Args
Base
Bm25
Options
Base
Hybrid
Options
Base
Near
Options
Base
Near
Text
Options
Base
Ref
Property
Batch
Object
Batch
Objects
Batch
Objects
Return
Batch
Reference
Batch
References
Return
Beacon
Bm25
Operator
Bm25
Operator
Options
Bm25
Options
Boolean
Keys
Boost
Boost
Options
BQ
Config
BQ
Config
Create
BQ
Config
Update
Call
Options
clean
Host
Client
Credentials
Input
Client
Params
Cluster
Cluster
Action
Cluster
Permission
Collection
Config
Collection
Config
Create
Collection
Config
Update
Collections
Action
Collections
Permission
Config
config
Guards
configure
Configure
Non
Text
Multi
Vectorizer
Options
Configure
Non
Text
Vectorizer
Options
Configure
Text
Multi
Vectorizer
Options
Configure
Text
Vectorizer
Options
Connection
GQL
Connection
GRPC
Connection
Params
Connection
REST
Connect
To
WCD
Options
Connect
To
WCS
Options
Connect
To
Weaviate
Cloud
Options
Consistency
Level
Context
Cross
Reference
Cross
Reference
Default
Cross
References
Curve
Data
Data
Action
Data
Object
Data
Permission
data
Type
Data
Type
Date
Keys
Delete
Many
Object
Delete
Many
Options
Delete
Many
Return
Diversity
Diversity
Config
Diversity
Guards
Error
Object
Error
Reference
Fetch
Object
By
Id
Options
Fetch
Objects
Options
filter
Filter
Filter
By
Count
Filter
By
Id
Filter
By
Property
Filter
By
Time
Filters
Filter
Value
Generate
Generate
Options
Generate
Return
generate
Uuid5
generative
Generative
Anthropic
Config
Generative
Anthropic
Config
Create
Generative
Anthropic
Config
Runtime
Generative
Anyscale
Config
Generative
Anyscale
Config
Create
Generative
Anyscale
Config
Runtime
Generative
AWS
Config
Generative
AWS
Config
Create
Generative
AWS
Config
Runtime
Generative
Azure
Open
AI
Config
Generative
Azure
Open
AI
Config
Create
Generative
Cohere
Config
Generative
Cohere
Config
Create
Generative
Cohere
Config
Runtime
Generative
Config
Generative
Config
Create
Generative
Config
Create
Type
Generative
Config
Runtime
Generative
Config
Runtime
Type
Generative
Config
Type
Generative
Contextual
AI
Config
Generative
Contextual
AI
Config
Create
Generative
Contextual
AI
Config
Runtime
Generative
Databricks
Config
Generative
Databricks
Config
Create
Generative
Databricks
Config
Runtime
Generative
Dummy
Config
Runtime
Generative
Friendli
AI
Config
Generative
Friendli
AI
Config
Create
Generative
Friendli
AI
Config
Runtime
Generative
Generic
Object
Generative
Google
Config
Generative
Google
Config
Runtime
Generative
Group
By
Result
Generative
Group
By
Return
Generative
Grouped
Generative
Metadata
Generative
Mistral
Config
Generative
Mistral
Config
Create
Generative
Mistral
Config
Runtime
Generative
Non
Generic
Object
Generative
Nvidia
Config
Generative
Nvidia
Config
Create
Generative
Nvidia
Config
Runtime
Generative
Object
Generative
Ollama
Config
Generative
Ollama
Config
Create
Generative
Ollama
Config
Runtime
Generative
Open
AI
Config
Generative
Open
AI
Config
Base
Generative
Open
AI
Config
Base
Create
Generative
Open
AI
Config
Create
Generative
Open
AI
Config
Runtime
Generative
Pa
LM
Config
Generative
Pa
LM
Config
Create
generative
Parameters
Generative
Return
Generative
Search
Generative
Single
Generative
XAI
Config
Generative
XAI
Config
Create
Generative
XAI
Config
Runtime
Geo
Coordinate
Geo
Range
Filter
Get
Replication
Op
Options
Group
Assignment
Group
By
Aggregate
Group
By
Bm25
Options
Group
By
Hybrid
Options
Group
By
Near
Options
Group
By
Near
Text
Options
Group
By
Object
Group
By
Options
Group
By
Result
Group
By
Return
Grouped
Task
Groups
Action
Groups
Permission
helpers
Hybrid
Near
Text
Sub
Search
Hybrid
Near
Vector
Sub
Search
Hybrid
Options
Hybrid
Sub
Search
Base
I
Collection
I
Collections
I
Connection
Img2
Vec
Neural
Config
Img2
Vec
Neural
Config
Create
Insert
Object
Internal
Connection
Params
Inverted
Index
Config
Inverted
Index
Config
Create
Inverted
Index
Config
Update
Inverted
Index
Name
Is
Empty
Type
Is
Nested
Field
Is
Primitive
Field
Is
Weaviate
Field
Iterator
Iterator
Options
I
Weaviate
Client
Legacy
Vectorizer
Config
Update
Mcp
Action
Mcp
Permission
Metadata
Metadata
Keys
metrics
Metrics
Metrics
Base
Metrics
Boolean
Metrics
Date
Metrics
Input
Metrics
Integer
Metrics
Manager
Metrics
Number
Metrics
Property
Metrics
Text
MMR
Modifier
Module
Config
Move
Options
Multi2
Multivec
Jina
AI
Config
Multi2
Multivec
Jina
AI
Config
Create
Multi2
Multivec
Weaviate
Config
Multi2
Multivec
Weaviate
Config
Create
Multi2
Vec
AWS
Config
Multi2
Vec
AWS
Config
Create
Multi2
Vec
Bind
Config
Multi2
Vec
Bind
Config
Create
Multi2
Vec
Clip
Config
Multi2
Vec
Clip
Config
Create
Multi2
Vec
Cohere
Config
Multi2
Vec
Cohere
Config
Create
Multi2
Vec
Field
Multi2
Vec
Google
Config
Multi2
Vec
Google
Config
Create
Multi2
Vec
Google
Gemini
Config
Multi2
Vec
Google
Gemini
Config
Create
Multi2
Vec
Jina
AI
Config
Multi2
Vec
Jina
AI
Config
Create
Multi2
Vec
Nvidia
Config
Multi2
Vec
Nvidia
Config
Create
Multi2
Vec
Palm
Config
Multi2
Vec
Palm
Config
Create
Multi2
Vec
Twelve
Labs
Config
Multi2
Vec
Twelve
Labs
Config
Create
Multi2
Vec
Voyage
AI
Config
Multi2
Vec
Voyage
AI
Config
Create
Multi
Target
Vector
Multi
Target
Vector
Join
Multi
Target
Vector
Join
Combination
Multi
Target
Vector
Weights
Multi
Tenancy
Config
Multi
Tenancy
Config
Create
Multi
Tenancy
Config
Update
Multi
Vector
Config
Multi
Vector
Config
Create
Multi
Vector
Encoding
Config
Multi
Vector
Encoding
Config
Create
multi
Vectors
Multi
Vector
Type
Muvera
Encoding
Config
Muvera
Encoding
Config
Create
Near
Media
Type
Near
Options
Near
Text
Options
Nested
Data
Type
Config
Nested
Field
Nested
Keys
Nested
Properties
Nested
Property
Config
Create
Nested
Property
Config
Create
Base
Nested
Property
Create
Node
Nodes
Action
Nodes
Options
Nodes
Permission
Non
Reference
Inputs
Non
Ref
Keys
No
Vectorizer
Config
Number
Keys
Numeric
Decay
Object
Data
Type
Object
TTL
Config
Object
TTL
Config
Create
Object
TTL
Config
Update
Operator
Option
Output
Permission
permissions
Permissions
Input
Phone
Number
Phone
Number
Input
PQ
Config
PQ
Config
Create
PQ
Config
Update
PQ
Encoder
Config
PQ
Encoder
Distribution
PQ
Encoder
Type
Primitive
Data
Type
Primitive
Field
Primitive
Keys
Properties
Properties
Metrics
Property
Property
Config
Property
Config
Create
Property
Config
Create
Base
Property
Descriptions
Update
Property
Of
Property
Value
Property
Vectorizer
Config
Protocol
Params
Proxies
Params
Quantizer
Quantizer
Config
Quantizer
Config
Create
Quantizer
Config
Update
Quantizer
Recursive
Partial
Query
query
Factory
Query
Metadata
Query
Nested
Query
Profile
Query
Property
Query
Reference
Query
Replication
Ops
Options
Query
Return
Query
Sharding
State
Options
reconfigure
Recursive
Partial
Ref2
Vec
Centroid
Config
Ref2
Vec
Centroid
Config
Create
Reference
Reference
Args
Reference
Config
Reference
Config
Base
Create
Reference
Config
Create
Reference
Input
Reference
Inputs
Reference
Manager
Reference
Multi
Target
Config
Create
Reference
Single
Target
Config
Create
Reference
To
Multi
Target
Ref
Keys
Ref
Property
Ref
Property
Default
Replace
Object
Replicate
Action
Replicate
Args
Replicate
Permission
Replication
Config
Replication
Config
Create
Replication
Config
Update
Replication
Deletion
Strategy
Replication
Operation
Replications
Requires
Nested
reranker
Reranker
Reranker
Cohere
Config
Reranker
Config
Reranker
Config
Type
Reranker
Contextual
AI
Config
Reranker
Jina
AI
Config
Reranker
Nvidia
Config
Reranker
Transformers
Config
Reranker
Voyage
AI
Config
Rerank
Options
Return
Metadata
Return
Properties
Return
References
Return
Vectors
Role
Roles
Action
Roles
Permission
RQ
Config
RQ
Config
Create
RQ
Config
Update
Search
Options
Search
Profile
Sharding
Config
Sharding
Config
Create
Sharding
State
Shard
Profile
Single
Prompt
Single
Vector
Type
Sort
Sort
By
Sorting
SQ
Config
SQ
Config
Create
SQ
Config
Update
Stopwords
Stopwords
Preset
Tenant
Tenant
Base
Tenant
Create
Tenants
Tenants
Action
Tenants
Permission
Tenant
Update
Text2
Multi
Vec
Jina
AI
Config
Text2
Multi
Vec
Jina
AI
Config
Create
Text2
Vec
AWS
Config
Text2
Vec
AWS
Config
Create
Text2
Vec
Azure
Open
AI
Config
Text2
Vec
Azure
Open
AI
Config
Create
Text2
Vec
Cohere
Config
Text2
Vec
Cohere
Config
Create
Text2
Vec
Contextionary
Config
Text2
Vec
Contextionary
Config
Create
Text2
Vec
Databricks
Config
Text2
Vec
Databricks
Config
Create
Text2
Vec
Digital
Ocean
Config
Text2
Vec
Digital
Ocean
Config
Create
Text2
Vec
Google
Ai
Studio
Config
Text2
Vec
Google
Ai
Studio
Config
Create
Text2
Vec
Google
Config
Text2
Vec
Google
Config
Create
Text2
Vec
Google
Gemini
Config
Text2
Vec
Google
Gemini
Config
Create
Text2
Vec
GPT4
All
Config
Text2
Vec
GPT4
All
Config
Create
Text2
Vec
Hugging
Face
Config
Text2
Vec
Hugging
Face
Config
Create
Text2
Vec
Jina
AI
Config
Text2
Vec
Jina
AI
Config
Create
Text2
Vec
Jina
Config
Text2
Vec
Mistral
Config
Text2
Vec
Mistral
Config
Create
Text2
Vec
Model2
Vec
Text2
Vec
Model2
Vec
Config
Create
Text2
Vec
Morph
Config
Text2
Vec
Morph
Config
Create
Text2
Vec
Nvidia
Config
Text2
Vec
Nvidia
Config
Create
Text2
Vec
Ollama
Config
Text2
Vec
Ollama
Config
Create
Text2
Vec
Open
AI
Config
Text2
Vec
Open
AI
Config
Create
Text2
Vec
Palm
Config
Text2
Vec
Palm
Config
Create
Text2
Vec
Transformers
Config
Text2
Vec
Transformers
Config
Create
Text2
Vec
Voyage
AI
Config
Text2
Vec
Voyage
AI
Config
Create
Text2
Vec
Weaviate
Config
Text2
Vec
Weaviate
Config
Create
Text
Analyzer
Config
Time
Decay
Timeout
Params
tokenization
Tokenization
Transports
Transports
Maker
Transports
Params
Uncompressed
Config
Uncompressed
Config
Create
Union
Of
Update
Object
User
Assignment
User
Password
Credentials
Input
Users
Action
Users
Permission
Vector
Config
Vector
Config
Create
Vector
Config
Update
Vector
Distance
vector
Distances
vector
Index
Vector
Index
Vector
Index
Config
Vector
Index
Config
Create
Vector
Index
Config
Create
Type
Vector
Index
Config
Dymamic
Update
Vector
Index
Config
Dynamic
Vector
Index
Config
Dynamic
Create
Vector
Index
Config
Dynamic
Create
Options
Vector
Index
Config
Dynamic
Update
Vector
Index
Config
Flat
Vector
Index
Config
Flat
Create
Vector
Index
Config
Flat
Create
Options
Vector
Index
Config
Flat
Update
Vector
Index
Config
H
Fresh
Vector
Index
Config
H
Fresh
Create
Vector
Index
Config
H
Fresh
Create
Options
Vector
Index
Config
H
Fresh
Update
Vector
Index
Config
HNSW
Vector
Index
Config
HNSW
Create
Vector
Index
Config
HNSW
Create
Options
Vector
Index
Config
HNSW
Update
Vector
Index
Config
Type
Vector
Index
Config
Update
Vector
Index
Config
Update
Type
Vector
Index
Filter
Strategy
Vector
Index
Type
vectorizer
Vectorizer
Vectorizer
Config
Vectorizer
Config
Create
Type
Vectorizer
Config
Type
Vectorizer
Create
Options
Vectorizers
Config
Add
Vectorizers
Config
Create
Vectorizer
Update
Options
vectors
Vectors
Weaviate
Backup
Canceled
Weaviate
Backup
Cancellation
Error
Weaviate
Backup
Failed
Weaviate
Batch
Error
Weaviate
Batch
Stream
Error
Weaviate
Class
Weaviate
Delete
Many
Error
Weaviate
Deserialization
Error
Weaviate
Field
Weaviate
Generic
Object
Weaviate
GRPC
Unavailable
Error
Weaviate
Insufficient
Permissions
Error
Weaviate
Invalid
Input
Error
Weaviate
Non
Generic
Object
Weaviate
Object
Weaviate
Query
Error
Weaviate
Request
Timeout
Error
Weaviate
Return
Weaviate
Serialization
Error
Weaviate
Start
Up
Error
Weaviate
Tenants
Get
Error
Weaviate
Unauthenticated
Error
Weaviate
Unexpected
Response
Error
Weaviate
Unexpected
Status
Code
Error
Weaviate
Unsupported
Feature
Error
weaviate
V2
weaviate-client
Loading...