Module: Google::Cloud::DiscoveryEngine

Defined in:
lib/google/cloud/discovery_engine.rb,
lib/google/cloud/discovery_engine/version.rb

Constant Summary collapse

VERSION = 
"0.2.0"

Class Method Summary collapse

Class Method Details

.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.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/discovery_engine.rb', line 69

def self.completion_service version: :v1, transport: :grpc, &block
  require "google/cloud/discovery_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::DiscoveryEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:CompletionService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.discovery_engine| ... } ⇒ ::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:



280
281
282
283
284
 
# File 'lib/google/cloud/discovery_engine.rb', line 280

def self.configure
  yield ::Google::Cloud.configure.discovery_engine if block_given?

  ::Google::Cloud.configure.discovery_engine
end

.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.



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/discovery_engine.rb', line 137

def self.conversational_search_service version: :v1, transport: :grpc, &block
  require "google/cloud/discovery_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::DiscoveryEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:ConversationalSearchService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/google/cloud/discovery_engine.rb', line 172

def self.document_service version: :v1, transport: :grpc, &block
  require "google/cloud/discovery_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::DiscoveryEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:DocumentService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/google/cloud/discovery_engine.rb', line 206

def self.schema_service version: :v1, transport: :grpc, &block
  require "google/cloud/discovery_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::DiscoveryEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:SchemaService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/google/cloud/discovery_engine.rb', line 103

def self.search_service version: :v1, transport: :grpc, &block
  require "google/cloud/discovery_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::DiscoveryEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:SearchService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.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.



240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/google/cloud/discovery_engine.rb', line 240

def self.user_event_service version: :v1, transport: :grpc, &block
  require "google/cloud/discovery_engine/#{version.to_s.downcase}"

  package_name = Google::Cloud::DiscoveryEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::DiscoveryEngine.const_get(package_name).const_get(:UserEventService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end