Vector Search API - Module Google::Cloud::VectorSearch (v0.1.0)

Reference documentation and code samples for the Vector Search API module Google::Cloud::VectorSearch.

Methods

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-vector_search library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :jitter (type: Numeric) - The jitter in seconds. Default: 1.0.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.vector_search)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.data_object_search_service

def self.data_object_search_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DataObjectSearchService.

By default, this returns an instance of Google::Cloud::VectorSearch::V1::DataObjectSearchService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DataObjectSearchService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataObjectSearchService service. You can determine whether the method will succeed by calling VectorSearch.data_object_search_service_available?.

About DataObjectSearchService

Service for searching data objects.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.data_object_search_service_available?

def self.data_object_search_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DataObjectSearchService service is supported by the current client. If true, you can retrieve a client object by calling VectorSearch.data_object_search_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataObjectSearchService service, or if the versioned client gem needs an update to support the DataObjectSearchService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.data_object_service

def self.data_object_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for DataObjectService.

By default, this returns an instance of Google::Cloud::VectorSearch::V1::DataObjectService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DataObjectService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataObjectService service. You can determine whether the method will succeed by calling VectorSearch.data_object_service_available?.

About DataObjectService

Service for creating and managing data objects.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.data_object_service_available?

def self.data_object_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the DataObjectService service is supported by the current client. If true, you can retrieve a client object by calling VectorSearch.data_object_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataObjectService service, or if the versioned client gem needs an update to support the DataObjectService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.vector_search_service

def self.vector_search_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for VectorSearchService.

By default, this returns an instance of Google::Cloud::VectorSearch::V1::VectorSearchService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the VectorSearchService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the VectorSearchService service. You can determine whether the method will succeed by calling VectorSearch.vector_search_service_available?.

About VectorSearchService

VectorSearchService provides methods for managing Collection resources, and Collection Index resources. The primary resources offered by this service are Collections which are a container for a set of related JSON data objects, and Collection Indexes which enable efficient ANN search across data objects within a Collection.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.vector_search_service_available?

def self.vector_search_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the VectorSearchService service is supported by the current client. If true, you can retrieve a client object by calling VectorSearch.vector_search_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the VectorSearchService service, or if the versioned client gem needs an update to support the VectorSearchService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "0.1.0"