alibabacloud_oss_v2.vectors.models package

Submodules

alibabacloud_oss_v2.vectors.models.bucket_basic module

class alibabacloud_oss_v2.vectors.models.bucket_basic.BucketInfo(name: str | None = None, location: str | None = None, creation_date: datetime | None = None, extranet_endpoint: str | None = None, intranet_endpoint: str | None = None, resource_group_id: str | None = None, **kwargs: Any)[source]

Bases: Model

BucketInfo defines Bucket information.

Parameters:

  • name (str, optional) – The name of the bucket.

  • location (str, optional) – The region in which the bucket is located.

  • creation_date (datetime, optional) – The time when the bucket is created. The time is in UTC.

  • extranet_endpoint (str, optional) – The public endpoint that is used to access the bucket over the Internet.

  • intranet_endpoint (str, optional) – The internal endpoint that is used to access the bucket from Elastic

  • resource_group_id (str, optional) – The ID of the resource group to which the bucket belongs.

class alibabacloud_oss_v2.vectors.models.bucket_basic.BucketProperties(name: str | None = None, location: str | None = None, creation_date: datetime | None = None, extranet_endpoint: str | None = None, intranet_endpoint: str | None = None, region: str | None = None, resource_group_id: str | None = None, **kwargs: Any)[source]

Bases: Model

Stores the metadata of the bucket.

Parameters:

  • name (str, optional) – The name of the bucket.

  • location (str, optional) – The data center in which the bucket is located.

  • creation_date (datetime, optional) – The time when the bucket was created.

  • extranet_endpoint (str, optional) – The public endpoint used to access the bucket over the Internet.

  • intranet_endpoint (str, optional) – The internal endpoint that is used to access the bucket from ECS instances that reside in the same region as the bucket.

  • region (str, optional) – The region in which the bucket is located.

  • resource_group_id (str, optional) – The ID of the resource group to which the bucket belongs.

class alibabacloud_oss_v2.vectors.models.bucket_basic.DeleteVectorBucketRequest(bucket: str | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the DeleteBucket operation.

Parameters:

bucket (str, required) – The name of the bucket to create.

class alibabacloud_oss_v2.vectors.models.bucket_basic.DeleteVectorBucketResult(**kwargs: Any)[source]

Bases: ResultModel

The result for the DeleteBucket operation.

class alibabacloud_oss_v2.vectors.models.bucket_basic.GetVectorBucketRequest(bucket: str = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the GetBucketInfoRequest operation.

Parameters:

bucket (str, required) – The name of the bucket.

class alibabacloud_oss_v2.vectors.models.bucket_basic.GetVectorBucketResult(bucket_info: BucketInfo | None = None, **kwargs: Any)[source]

Bases: ResultModel

The result for the GetBucketInfoResult operation.

Parameters:

bucket_info (BucketInfo, optional) – BucketInfo defines Bucket information.

class alibabacloud_oss_v2.vectors.models.bucket_basic.ListVectorBucketsRequest(marker: str | None = None, max_keys: int | None = None, prefix: str | None = None, resource_group_id: str | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the ListBuckets operation.

Parameters:

  • marker (str, optional) – The name of the bucket from which the list operation begins.

  • max_keys (int, optional) – The maximum number of buckets that can be returned in the single query. Valid values: 1 to 1000.

  • prefix (str, optional) – The prefix that the names of returned buckets must contain. Limits the response to keys that begin with the specified prefix

  • request_payer (str, optional) – The ID of the resource group.

class alibabacloud_oss_v2.vectors.models.bucket_basic.ListVectorBucketsResult(prefix: str | None = None, marker: str | None = None, max_keys: int | None = None, is_truncated: bool | None = None, next_marker: str | None = None, buckets: List[BucketProperties] | None = None, **kwargs: Any)[source]

Bases: ResultModel

The result for the ListBuckets operation.

Parameters:

  • prefix (str, optional) – The prefix contained in the names of the returned bucket.

  • marker (str, optional) – The name of the bucket after which the ListBuckets operation starts

  • max_keys (int, optional) – The maximum number of buckets that can be returned for the request.

  • is_truncated (bool, optional) – Indicates whether the returned results are truncated. true indicates that not all results are returned this time. false indicates that all results are returned this time.

  • next_marker (str, optional) – The marker for the next ListBuckets request, which can be used to return the remaining results.

  • buckets ([BucketProperties], optional) – The container that stores information about buckets.

class alibabacloud_oss_v2.vectors.models.bucket_basic.PutVectorBucketRequest(bucket: str = None, resource_group_id: str | None = None, bucket_tagging: str | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the PutBucket operation.

Parameters:

  • bucket (str, required) – The name of the bucket to create.

  • resource_group_id (str, optional) – The ID of the resource group.

  • bucket_tagging (str, optional) – The tagging information for the bucket.

class alibabacloud_oss_v2.vectors.models.bucket_basic.PutVectorBucketResult(**kwargs: Any)[source]

Bases: ResultModel

The result for the PutBucket operation.

alibabacloud_oss_v2.vectors.models.bucket_logging module

alibabacloud_oss_v2.vectors.models.bucket_policy module

alibabacloud_oss_v2.vectors.models.bucket_public_access_block module

alibabacloud_oss_v2.vectors.models.index_basic module

class alibabacloud_oss_v2.vectors.models.index_basic.DeleteVectorIndexRequest(bucket: str | None = None, index_name: str | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the DeleteVectorIndex operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • index_name (str, optional) – The name of the index to delete.

class alibabacloud_oss_v2.vectors.models.index_basic.DeleteVectorIndexResult(**kwargs: Any)[source]

Bases: ResultModel

The result for the DeleteVectorIndex operation.

class alibabacloud_oss_v2.vectors.models.index_basic.GetVectorIndexRequest(bucket: str | None = None, index_name: str | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the GetVectorIndex operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • index_name (str, optional) – The name of the index.

class alibabacloud_oss_v2.vectors.models.index_basic.GetVectorIndexResult(index: Dict | None = None, **kwargs: Any)[source]

Bases: ResultModel

The result for the GetVectorIndex operation.

Parameters:

index (Dict, optional) – The vector index information.

class alibabacloud_oss_v2.vectors.models.index_basic.ListVectorIndexesRequest(bucket: str | None = None, max_results: int | None = None, next_token: str | None = None, prefix: str | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the ListVectorIndexes operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • max_results (int, optional) – The maximum number of indexes to return.

  • next_token (str, optional) – The token for the next page of indexes.

  • prefix (str, optional) – The prefix to filter indexes by name.

class alibabacloud_oss_v2.vectors.models.index_basic.ListVectorIndexesResult(indexes: List[Dict] | None = None, next_token: str | None = None, **kwargs: Any)[source]

Bases: ResultModel

The result for the ListVectorIndexes operation.

Parameters:

  • indexes (List[Dict], optional) – The list of vector index summaries.

  • next_token (str, optional) – The token for the next page of indexes.

class alibabacloud_oss_v2.vectors.models.index_basic.PutVectorIndexRequest(bucket: str | None = None, data_type: str | None = None, dimension: int | None = None, distance_metric: str | None = None, index_name: str | None = None, metadata: Dict | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the vector index operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • data_type (str, optional) – The type of data for the vector index.

  • dimension (int, optional) – The dimension of the vector data.

  • distance_metric (str, optional) – The distance measurement function has the following optional values: Euclidean distance: Euclidean distance Cosine: cosine distance

  • index_name (str, optional) – The name of the index.

  • metadata (Dict, optional) – The metadata configuration.

class alibabacloud_oss_v2.vectors.models.index_basic.PutVectorIndexResult(**kwargs: Any)[source]

Bases: ResultModel

The result for the PutVectorIndex operation.

alibabacloud_oss_v2.vectors.models.vector_basic module

class alibabacloud_oss_v2.vectors.models.vector_basic.DeleteVectorsRequest(bucket: str | None = None, index_name: str | None = None, keys: List[str] | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the DeleteVectors operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • index_name (str, optional) – The name of the index.

  • keys (List[str], optional) – The list of vector keys to delete.

class alibabacloud_oss_v2.vectors.models.vector_basic.DeleteVectorsResult(**kwargs: Any)[source]

Bases: ResultModel

The result for the DeleteVectors operation.

class alibabacloud_oss_v2.vectors.models.vector_basic.GetVectorsRequest(bucket: str | None = None, index_name: str | None = None, keys: List[str] | None = None, return_data: bool | None = None, return_metadata: bool | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the GetVectors operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • index_name (str, optional) – The name of the index.

  • keys (List[str], optional) – The list of vector keys to retrieve.

  • return_data (bool, optional) – Whether to return vector data.

  • return_metadata (bool, optional) – Whether to return vector metadata.

class alibabacloud_oss_v2.vectors.models.vector_basic.GetVectorsResult(vectors: List[Dict] | None = None, **kwargs: Any)[source]

Bases: ResultModel

The result for the GetVectors operation.

Parameters:

vectors (List[Dict], optional) – The list of vectors retrieved.

class alibabacloud_oss_v2.vectors.models.vector_basic.ListVectorsRequest(bucket: str | None = None, index_name: str | None = None, max_results: int | None = None, next_token: str | None = None, return_data: bool | None = None, return_metadata: bool | None = None, segment_count: int | None = None, segment_index: int | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the ListVectors operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • index_name (str, optional) – The name of the index.

  • max_results (int, optional) – The maximum number of vectors to return.

  • next_token (str, optional) – The token for the next page of vectors.

  • return_data (bool, optional) – Whether to return vector data.

  • return_metadata (bool, optional) – Whether to return vector metadata.

  • segment_count (int, optional) – Number of concurrent segments.

  • segment_index (int, optional) – Current segment index.

class alibabacloud_oss_v2.vectors.models.vector_basic.ListVectorsResult(next_token: str | None = None, vectors: List[Dict] | None = None, **kwargs: Any)[source]

Bases: ResultModel

The result for the ListVectors operation.

Parameters:

  • next_token (str, optional) – The token for the next page of vectors.

  • vectors (List[Dict], optional) – The list of vectors retrieved.

class alibabacloud_oss_v2.vectors.models.vector_basic.PutVectorsRequest(bucket: str | None = None, index_name: str | None = None, vectors: List[Dict] | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the PutVectors operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • index_name (str, optional) – The name of the index.

  • vectors (List[Dict], optional) – The list of vectors to put.

class alibabacloud_oss_v2.vectors.models.vector_basic.PutVectorsResult(**kwargs: Any)[source]

Bases: ResultModel

The result for the PutVectors operation.

class alibabacloud_oss_v2.vectors.models.vector_basic.QueryVectorsRequest(bucket: str | None = None, filter: Dict | None = None, index_name: str | None = None, query_vector: Dict | None = None, return_distance: bool | None = None, return_metadata: bool | None = None, top_k: int | None = None, **kwargs: Any)[source]

Bases: RequestModel

The request for the QueryVectors operation.

Parameters:

  • bucket (str, optional) – The name of the bucket.

  • filter (Dict, optional) – The filter conditions for querying vectors.

  • index_name (str, optional) – The name of the index.

  • query_vector (Dict, optional) – The query vector data.

  • return_distance (bool, optional) – Whether to return distance values.

  • return_metadata (bool, optional) – Whether to return vector metadata.

  • top_k (int, optional) – The number of nearest neighbors to return.

class alibabacloud_oss_v2.vectors.models.vector_basic.QueryVectorsResult(vectors: List[Dict] | None = None, **kwargs: Any)[source]

Bases: ResultModel

The result for the QueryVectors operation.

Parameters:

vectors (List[Dict], optional) – The list of query result vectors.

Module contents