alibabacloud_oss_v2.vectors package

Subpackages

• alibabacloud_oss_v2.vectors.models package
  • Submodules
  • alibabacloud_oss_v2.vectors.models.bucket_basic module
    • BucketInfo
    • BucketProperties
    • DeleteVectorBucketRequest
    • DeleteVectorBucketResult
    • GetVectorBucketRequest
    • GetVectorBucketResult
    • ListVectorBucketsRequest
    • ListVectorBucketsResult
    • PutVectorBucketRequest
    • PutVectorBucketResult
  • 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
    • DeleteVectorIndexRequest
    • DeleteVectorIndexResult
    • GetVectorIndexRequest
    • GetVectorIndexResult
    • ListVectorIndexesRequest
    • ListVectorIndexesResult
    • PutVectorIndexRequest
    • PutVectorIndexResult
  • alibabacloud_oss_v2.vectors.models.vector_basic module
    • DeleteVectorsRequest
    • DeleteVectorsResult
    • GetVectorsRequest
    • GetVectorsResult
    • ListVectorsRequest
    • ListVectorsResult
    • PutVectorsRequest
    • PutVectorsResult
    • QueryVectorsRequest
    • QueryVectorsResult
  • Module contents
• alibabacloud_oss_v2.vectors.operations package
  • Submodules
  • alibabacloud_oss_v2.vectors.operations.bucket_basic module
    • delete_vector_bucket()
    • get_vector_bucket()
    • list_vector_buckets()
    • put_vector_bucket()
  • alibabacloud_oss_v2.vectors.operations.bucket_logging module
    • delete_bucket_logging()
    • get_bucket_logging()
    • put_bucket_logging()
  • alibabacloud_oss_v2.vectors.operations.bucket_policy module
    • delete_bucket_policy()
    • get_bucket_policy()
    • put_bucket_policy()
  • alibabacloud_oss_v2.vectors.operations.index_basic module
    • delete_vector_index()
    • get_vector_index()
    • list_vector_indexes()
    • put_vector_index()
  • alibabacloud_oss_v2.vectors.operations.vector_basic module
    • delete_vectors()
    • get_vectors()
    • list_vectors()
    • put_vectors()
    • query_vectors()
  • Module contents

Submodules

alibabacloud_oss_v2.vectors.client module

Client used to interact with Alibaba Cloud Object Storage Service (OSS).

class alibabacloud_oss_v2.vectors.client.Client(config: Config, **kwargs)

Bases: object

Vectors Client

Initialize Vectors Client

Parameters:

config (Config) – _description_

delete_bucket_logging(request: DeleteBucketLoggingRequest, **kwargs) → DeleteBucketLoggingResult

Disables logging for a bucket.

Parameters:

request (DeleteBucketLoggingRequest) – Request parameters for DeleteBucketLogging operation.

Returns:

Response result for DeleteBucketLogging operation.

Return type:

DeleteBucketLoggingResult

delete_bucket_policy(request: DeleteBucketPolicyRequest, **kwargs) → DeleteBucketPolicyResult

Deletes a policy for a bucket.

Parameters:

request (DeleteBucketPolicyRequest) – Request parameters for DeleteBucketPolicy operation.

Returns:

Response result for DeleteBucketPolicy operation.

Return type:

DeleteBucketPolicyResult

delete_vector_bucket(request: DeleteVectorBucketRequest, **kwargs) → DeleteVectorBucketResult

Deletes a bucket.

Parameters:

request (DeleteVectorBucketRequest) – Request parameters for DeleteVectorBucket operation.

Returns:

Response result for DeleteVectorBucket operation.

Return type:

DeleteVectorBucketResult

delete_vector_index(request: DeleteVectorIndexRequest, **kwargs) → DeleteVectorIndexResult

Delete a vector index.

Parameters:

request (DeleteVectorIndexRequest) – The request for the DeleteVectorIndex operation.

Returns:

The result for the DeleteVectorIndex operation.

Return type:

DeleteVectorIndexResult

delete_vectors(request: DeleteVectorsRequest, **kwargs) → DeleteVectorsResult

Delete vectors from an index.

Parameters:

request (DeleteVectorsRequest) – The request for the DeleteVectors operation.

Returns:

The result for the DeleteVectors operation.

Return type:

DeleteVectorsResult

get_bucket_logging(request: GetBucketLoggingRequest, **kwargs) → GetBucketLoggingResult

Queries the logging configurations of a bucket.

Parameters:

request (GetBucketLoggingRequest) – Request parameters for GetBucketLogging operation.

Returns:

Response result for GetBucketLogging operation.

Return type:

GetBucketLoggingResult

get_bucket_policy(request: GetBucketPolicyRequest, **kwargs) → GetBucketPolicyResult

Queries the policies configured for a bucket.

Parameters:

request (GetBucketPolicyRequest) – Request parameters for GetBucketPolicy operation.

Returns:

Response result for GetBucketPolicy operation.

Return type:

GetBucketPolicyResult

get_vector_bucket(request: GetVectorBucketRequest, **kwargs) → GetVectorBucketResult

GetBucketInfo Queries information about a bucket.

Parameters:

request (GetVectorBucketRequest) – Request parameters for GetVectorBucket operation.

Returns:

Response result for GetVectorBucket operation.

Return type:

GetVectorBucketResult

get_vector_index(request: GetVectorIndexRequest, **kwargs) → GetVectorIndexResult

Get information about a specific vector index.

Parameters:

request (GetVectorIndexRequest) – The request for the GetVectorIndex operation.

Returns:

The result for the GetVectorIndex operation.

Return type:

GetVectorIndexResult

get_vectors(request: GetVectorsRequest, **kwargs) → GetVectorsResult

Get vectors from an index.

Parameters:

request (GetVectorsRequest) – The request for the GetVectors operation.

Returns:

The result for the GetVectors operation.

Return type:

GetVectorsResult

invoke_operation(op_input: OperationInput, **kwargs) → OperationOutput

invoke operation

Parameters:

op_input (OperationInput) – _description_

Returns:

_description_

Return type:

OperationOutput

list_vector_buckets(request: ListVectorBucketsRequest, **kwargs) → ListVectorBucketsResult

Lists all buckets that belong to your Alibaba Cloud account.

Parameters:

request (ListVectorBucketsRequest) – Request parameters for ListBuckets operation.

Returns:

Response result for ListVectorBuckets operation.

Return type:

ListVectorBucketsResult

list_vector_buckets_paginator(**kwargs) → ListVectorBucketsPaginator

Creates a paginator for ListVectorBuckets

Returns:

a paginator for ListVectorBuckets

Return type:

ListVectorBucketsPaginator

list_vector_indexes(request: ListVectorIndexesRequest, **kwargs) → ListVectorIndexesResult

List vector indexes in a bucket.

Parameters:

request (ListVectorIndexesRequest) – The request for the ListVectorIndexes operation.

Returns:

The result for the ListVectorIndexes operation.

Return type:

ListVectorIndexesResult

list_vector_indexes_paginator(**kwargs) → ListVectorIndexesPaginator

Creates a paginator for ListVectorIndex

Returns:

a paginator for ListVectorIndex

Return type:

ListVectorIndexesPaginator

list_vectors(request: ListVectorsRequest, **kwargs) → ListVectorsResult

List vectors in an index.

Parameters:

request (ListVectorsRequest) – The request for the ListVectors operation.

Returns:

The result for the ListVectors operation.

Return type:

ListVectorsResult

list_vectors_paginator(**kwargs) → ListVectorsPaginator

Creates a paginator for ListVectors

Returns:

a paginator for ListVectors

Return type:

ListVectorsPaginator

put_bucket_logging(request: PutBucketLoggingRequest, **kwargs) → PutBucketLoggingResult

Enables logging for a bucket.

Parameters:

request (PutBucketLoggingRequest) – Request parameters for PutBucketLogging operation.

Returns:

Response result for PutBucketLogging operation.

Return type:

PutBucketLoggingResult

put_bucket_policy(request: PutBucketPolicyRequest, **kwargs) → PutBucketPolicyResult

Configures a policy for a bucket.

Parameters:

request (PutBucketPolicyRequest) – Request parameters for PutBucketPolicy operation.

Returns:

Response result for PutBucketPolicy operation.

Return type:

PutBucketPolicyResult

put_vector_bucket(request: PutVectorBucketRequest, **kwargs) → PutVectorBucketResult

Creates a bucket.

Parameters:

request (PutVectorBucketRequest) – Request parameters for PutVectorBucket operation.

Returns:

Response result for PutBucket operation.

Return type:

PutVectorBucketResult

put_vector_index(request: PutVectorIndexRequest, **kwargs) → PutVectorIndexResult

Create or update a vector index.

Parameters:

request (PutVectorIndexRequest) – The request for the PutVectorIndex operation.

Returns:

The result for the PutVectorIndex operation.

Return type:

PutVectorIndexResult

put_vectors(request: PutVectorsRequest, **kwargs) → PutVectorsResult

Put vectors into an index.

Parameters:

request (PutVectorsRequest) – The request for the PutVectors operation.

Returns:

The result for the PutVectors operation.

Return type:

PutVectorsResult

query_vectors(request: QueryVectorsRequest, **kwargs) → QueryVectorsResult

Query vectors in an index.

Parameters:

request (QueryVectorsRequest) – The request for the QueryVectors operation.

Returns:

The result for the QueryVectors operation.

Return type:

QueryVectorsResult

alibabacloud_oss_v2.vectors.endpoints module

class alibabacloud_oss_v2.vectors.endpoints.VectorsEndpointProvider(endpoint: ParseResult, account_id: str)

Bases: EndpointProvider

build_url(op_input: OperationInput) → str

build the request url

alibabacloud_oss_v2.vectors.endpoints.from_region(region: str, etype: str) → str

Generate vectors endpoint from region

alibabacloud_oss_v2.vectors.paginator module

Paginator for list operation.

class alibabacloud_oss_v2.vectors.paginator.ListVectorBucketsAPIClient

Bases: ABC

Abstract base class for list_vector_buckets client.

abstract list_vector_buckets(request: ListVectorBucketsRequest, **kwargs) → ListVectorBucketsResult

Lists all vector buckets that belong to your Alibaba Cloud account.

class alibabacloud_oss_v2.vectors.paginator.ListVectorBucketsPaginator(client: ListVectorBucketsAPIClient, **kwargs: Any)

Bases: object

A paginator for ListVectorBuckets

client (ListVectorBucketsAPIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListVectorBucketsRequest, **kwargs: Any) → Iterator[ListVectorBucketsResult]

Iterates over the vector buckets.

Parameters:

• request (models.ListVectorBucketsRequest) – The request for the ListVectorBuckets operation.

• limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListVectorBucketsResult] – An iterator of ListVectorBucketsResult from the response

class alibabacloud_oss_v2.vectors.paginator.ListVectorIndexesAPIClient

Bases: ABC

Abstract base class for list_vector_indexes client.

abstract list_vector_indexes(request: ListVectorIndexesRequest, **kwargs) → ListVectorIndexesResult

Lists vector indexes in a bucket.

class alibabacloud_oss_v2.vectors.paginator.ListVectorIndexesPaginator(client: ListVectorIndexesAPIClient, **kwargs: Any)

Bases: object

A paginator for ListVectorIndexes

client (ListVectorIndexesAPIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListVectorIndexesRequest, **kwargs: Any) → Iterator[ListVectorIndexesResult]

Iterates over the vector indexes.

Parameters:

• request (models.ListVectorIndexesRequest) – The request for the ListVectorIndexes operation.

• limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[models.ListVectorIndexesResult] – An iterator of ListVectorIndexes from the response

class alibabacloud_oss_v2.vectors.paginator.ListVectorsAPIClient

Bases: ABC

Abstract base class for list_vectors client.

abstract list_vectors(request: ListVectorsRequest, **kwargs) → ListVectorsResult

Lists vectors in a bucket.

class alibabacloud_oss_v2.vectors.paginator.ListVectorsPaginator(client: ListVectorsAPIClient, **kwargs: Any)

Bases: object

A paginator for ListVectors

client (ListVectorsAPIClient): A agent that sends the request. limit (int, optional): The maximum number of items in the response.

iter_page(request: ListVectorsRequest, **kwargs: Any) → Iterator[ListVectorsResult]

Iterates over the vectors.

Parameters:

• request (vectors.models.ListVectorsRequest) – The request for the ListVectors operation.

• limit (int, optional) – The maximum number of items in the response.

Yields:

Iterator[vectors.models.ListVectorsResult] – An iterator of ListVectorsResult from the response

Module contents