Discovery Engine API - Module Google::Cloud::DiscoveryEngine (v1.0.1)

Reference documentation and code samples for the Discovery Engine API module Google::Cloud::DiscoveryEngine.

Methods

.completion_service

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

Create a new client object for CompletionService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::CompletionService::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 CompletionService 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.

About CompletionService

Service for Auto-Completion.

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.

.configure

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

Configure the google-cloud-discovery_engine 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.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.discovery_engine)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.control_service

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

Create a new client object for ControlService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::ControlService::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 ControlService 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.

About ControlService

Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.

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.

.conversational_search_service

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

Create a new client object for ConversationalSearchService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::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 ConversationalSearchService 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.

About ConversationalSearchService

Service for conversational search.

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_store_service

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

Create a new client object for DataStoreService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::DataStoreService::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 DataStoreService 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.

About DataStoreService

Service for managing DataStore configuration.

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.

.document_service

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

Create a new client object for DocumentService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::DocumentService::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 DocumentService 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.

About DocumentService

Service for ingesting Document information of the customer's website.

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.

.engine_service

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

Create a new client object for EngineService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::EngineService::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 EngineService 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.

About EngineService

Service for managing Engine configuration.

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.

.grounded_generation_service

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

Create a new client object for GroundedGenerationService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::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 GroundedGenerationService 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.

About GroundedGenerationService

Service for grounded generation.

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.

.project_service

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

Create a new client object for ProjectService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::ProjectService::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 ProjectService 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.

About ProjectService

Service for operations on the Project.

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.

.rank_service

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

Create a new client object for RankService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::RankService::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 RankService 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.

About RankService

Service for ranking text records.

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.

.recommendation_service

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

Create a new client object for RecommendationService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::RecommendationService::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 RecommendationService 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.

About RecommendationService

Service for making recommendations.

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.

.schema_service

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

Create a new client object for SchemaService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::SchemaService::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 SchemaService 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.

About SchemaService

Service for managing Schemas.

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.

.search_service

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

Create a new client object for SearchService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::SearchService::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 SearchService 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.

About SearchService

Service for search.

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.

.site_search_engine_service

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

Create a new client object for SiteSearchEngineService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::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 SiteSearchEngineService 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.

About SiteSearchEngineService

Service for managing site search related resources.

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.

.user_event_service

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

Create a new client object for UserEventService.

By default, this returns an instance of Google::Cloud::DiscoveryEngine::V1::UserEventService::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 UserEventService 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.

About UserEventService

Service for ingesting end user actions on a website to Discovery Engine API.

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.

Constants

VERSION

value: "1.0.1"