weaviate-python-client の API リファレンス
weaviate-python-client (weaviate/weaviate-python-client) の公開 API 102 件 —— クラス 80、関数 12、メソッド 10。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: weaviate/weaviate-python-client
| 種別 | 件数 |
|---|---|
| クラス | 80 |
| 関数 | 12 |
| メソッド | 10 |
API 一覧
class
weaviate.aliases.alias.AliasReturnReturned aliases from Weaviate.
class
weaviate.backup.backup.BackupListReturnReturn type of the backup list method.
class
weaviate.backup.backup.BackupReturnReturn type of the backup creation and restore methods.
class
weaviate.backup.backup.BackupStatusThe status of a backup.
class
weaviate.backup.backup.BackupStatusReturnReturn type of the backup status methods.
class
weaviate.backup.backup.BackupStorageWhich backend should be used to write the backup to.
class
weaviate.backup.backup_location.BackupLocationThe dynamic path of a backup.
class
weaviate.cluster.models.NodeStatisticsRAFT cluster statistics for a single node.
class
weaviate.cluster.models.RaftStatsRAFT consensus statistics for a node.
class
weaviate.cluster.models.ReplicateOperationStateEnum for replication operation states.
class
weaviate.cluster.models.ReplicationTypeEnum for replication types.
class
weaviate.cluster.models.ShardReplicasClass representing a shard replica.
class
weaviate.cluster.models.ShardingStateClass representing the sharding state of a collection.
method
weaviate.collections.batch.base.BatchRequest.aadd(item:TBatchInput) -> NoneAsynchronously add an item to the BatchRequest.
method
weaviate.collections.batch.base.BatchRequest.add(item:TBatchInput) -> NoneAdd an item to the BatchRequest.
method
weaviate.collections.batch.base.BatchRequest.prepend(item:List[TBatchInput]) -> NoneAdd items to the front of the BatchRequest.
class
weaviate.collections.classes.aggregate.AggregateBooleanThe aggregation result for a boolean property.
class
weaviate.collections.classes.aggregate.AggregateDateThe aggregation result for a date property.
class
weaviate.collections.classes.aggregate.AggregateIntegerThe aggregation result for an int property.
class
weaviate.collections.classes.aggregate.AggregateNumberThe aggregation result for a number property.
class
weaviate.collections.classes.aggregate.AggregateReturnThe aggregation result for a collection.
class
weaviate.collections.classes.aggregate.AggregateTextThe aggregation result for a text property.
class
weaviate.collections.classes.aggregate.GroupedByThe property that the collection was grouped by.
class
weaviate.collections.classes.aggregate.TopOccurrenceThe top occurrence of a text property.
class
weaviate.collections.classes.batch.BatchObjectA Weaviate object to be added to the database.
class
weaviate.collections.classes.batch.BatchReferenceA reference between two objects in Weaviate.
class
weaviate.collections.classes.cluster.NodeThe properties of a single node in the cluster.
class
weaviate.collections.classes.cluster.ShardThe properties of a single shard of a collection.
class
weaviate.collections.classes.cluster.StatsThe statistics of a collection.
class
weaviate.collections.classes.config.DataTypeThe available primitive data types in Weaviate.
class
weaviate.collections.classes.config.RerankersThe available reranker modules in Weaviate.
class
weaviate.collections.classes.config.StopwordsPresetPreset stopwords to use in the `Stopwords` class.
class
weaviate.collections.classes.config_vector_index.PQEncoderDistributionDistribution of the PQ encoder.
class
weaviate.collections.classes.config_vector_index.PQEncoderTypeType of the PQ encoder.
class
weaviate.collections.classes.config_vector_index.VectorIndexTypeThe available vector index types in Weaviate.
method
weaviate.collections.classes.filters.Filter.not_(filter_:_Filters) -> _FiltersNegate the filter with a NOT operator.
class
weaviate.collections.classes.grpc.BM25OperatorAndDefine the 'And' operator for keyword queries.
class
weaviate.collections.classes.grpc.BM25OperatorOrDefine the 'Or' operator for keyword queries.
method
weaviate.collections.classes.grpc.Sort.by_creation_time(ascending:bool=True) -> SortingSort by an object's creation time.
method
weaviate.collections.classes.grpc.Sort.by_id(ascending:bool=True) -> SortingSort by an object's ID in the collection.
method
weaviate.collections.classes.grpc.Sort.by_property(name:str, ascending:bool=True) -> SortingSort by an object property in the collection.
method
weaviate.collections.classes.grpc.Sort.by_update_time(ascending:bool=True) -> SortingSort by an object's last update time.
class
weaviate.collections.classes.internal.GroupA group of objects returned in a group by query.
class
weaviate.collections.classes.internal.MetadataReturnMetadata of an object returned by a query.
class
weaviate.collections.classes.internal.ShardProfileReturnProfiling data for a single shard.
class
weaviate.collections.classes.tenants.TenantTenant class used to describe a tenant in Weaviate.
class
weaviate.collections.classes.tenants.TenantOutputWrapper around Tenant for output purposes.
class
weaviate.collections.classes.types.GeoCoordinateInput for the geo-coordinate datatype.
class
weaviate.collections.classes.types.PhoneNumberInput for the phone number datatype.
method
weaviate.collections.collection.sync.Collection.exists() -> boolCheck if the collection exists in Weaviate.
class
weaviate.config.TimeoutTimeouts for the different operations in the client.
class
weaviate.exceptions.AdditionalPropertiesErrorAdditional properties were provided multiple times.
class
weaviate.exceptions.AuthenticationFailedErrorAuthentication Failed Exception.
class
weaviate.exceptions.BackupCanceledErrorBackup canceled Exception.
class
weaviate.exceptions.BackupFailedErrorBackup Failed Exception.
class
weaviate.exceptions.ExportCanceledErrorExport Canceled Exception.
class
weaviate.exceptions.ExportFailedErrorExport Failed Exception.
class
weaviate.exceptions.MissingScopeErrorScope was not provided with client credential flow.
class
weaviate.exceptions.ObjectAlreadyExistsErrorObject Already Exists Exception.
class
weaviate.exceptions.SchemaValidationErrorSchema Validation Exception.
class
weaviate.exceptions.WeaviateAddInvalidPropertyErrorIs raised when adding an invalid new property.
class
weaviate.exceptions.WeaviateBaseErrorWeaviate base exception that all Weaviate exceptions should inherit from.
class
weaviate.exceptions.WeaviateBatchValidationErrorIs raised when a batch validation error occurs.
class
weaviate.exceptions.WeaviateConnectionErrorIs raised when the connection to Weaviate fails.
class
weaviate.exceptions.WeaviateEmbeddedInvalidVersionErrorInvalid version provided to Weaviate embedded.
class
weaviate.exceptions.WeaviateInsertInvalidPropertyErrorIs raised when inserting an invalid property.
class
weaviate.exceptions.WeaviateInsertManyAllFailedErrorIs raised when all objects fail to be inserted.
class
weaviate.exceptions.WeaviateInvalidInputErrorIs raised if the input to a function is invalid.
class
weaviate.exceptions.WeaviateTimeoutErrorIs raised when a request to Weaviate times out.
class
weaviate.export.export.ExportCreateReturnReturn type of the export creation method.
class
weaviate.export.export.ExportFileFormatWhich file format should be used for the export.
class
weaviate.export.export.ExportStatusThe status of an export.
class
weaviate.export.export.ExportStatusReturnReturn type of the export status method.
class
weaviate.export.export.ShardExportStatusThe status of an individual shard export.
class
weaviate.export.export.ShardProgressProgress of a single shard export.
class
weaviate.gql.filter.FilterA base abstract class for all filters.
class
weaviate.gql.filter.NearAudioNearAudio class used to filter weaviate objects.
class
weaviate.gql.filter.NearDepthNearDepth class used to filter weaviate objects.
class
weaviate.gql.filter.NearIMUNearIMU class used to filter weaviate objects.
class
weaviate.gql.filter.NearImageNearImage class used to filter weaviate objects.
class
weaviate.gql.filter.NearObjectNearObject class used to filter weaviate objects.
class
weaviate.gql.filter.NearTextNearText class used to filter weaviate objects.
class
weaviate.gql.filter.NearThermalNearThermal class used to filter weaviate objects.
class
weaviate.gql.filter.NearVectorNearVector class used to filter weaviate objects.
class
weaviate.gql.filter.NearVideoNearVideo class used to filter weaviate objects.
class
weaviate.gql.filter.SortSort filter class used to sort weaviate objects.
method
weaviate.gql.filter.Sort.add(content:Union[dict, list]) -> NoneAdd more sort clauses to the already existing sort clauses.
class
weaviate.gql.filter.WhereWhere filter class used to filter weaviate objects.
class
weaviate.rbac.models.RoleScopeScope of the role permission.
class
weaviate.tokenization.models.TokenizeResultResult of a tokenization operation.
func
weaviate.util.check_batch_result(results:Optional[List[Dict[str, Any]]]) -> NoneCheck batch results for errors.
func
weaviate.util.docstring_deprecated(details:str='', deprecated_in:str='') -> CallableStdlib replacement for ``deprecation.deprecated``.
func
weaviate.util.file_decoder_b64(encoded_file:str) -> bytesDecode file from a Weaviate format image.
func
weaviate.util.file_encoder_b64(file_or_file_path:Union[str, Path, io.BufferedReader]) -> strEncode a file in a Weaviate understandable format.
func
weaviate.util.get_domain_from_weaviate_url(url:str) -> strGet the domain from a weaviate URL.
func
weaviate.util.get_valid_uuid(uuid:Union[str, uuid_lib.UUID]) -> strValidate and extract the UUID.
func
weaviate.util.get_vector(vector:Sequence) -> Sequence[float]Get weaviate compatible format of the embedding vector.
func
weaviate.util.image_decoder_b64(encoded_image:str) -> bytesDecode image from a Weaviate format image.
func
weaviate.util.is_object_url(url:str) -> boolValidates an Weaviater object URL.
func
weaviate.util.is_weaviate_object_url(url:str) -> boolChecks if the input follows a normal Weaviate 'beacon'.
func
weaviate.util.parse_blob(media:BLOB_INPUT) -> strParse a blob input to a base64 encoded string.
func
weaviate.util.parse_version_string(ver_str:str) -> tupleParse a version string into a float.
この情報について
掲載しているシグネチャは weaviate/weaviate-python-client の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。