Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client (v1.3.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client.

Client for the GroundedGenerationService service.

Service for grounded generation.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the GroundedGenerationService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all GroundedGenerationService clients
::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client.configure do |config|
  config.timeout = 10.0
end

#check_grounding

def check_grounding(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse
def check_grounding(grounding_config: nil, answer_candidate: nil, facts: nil, grounding_spec: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse

Performs a grounding check.

Overloads 
def check_grounding(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse
Pass arguments to check_grounding via a request object, either of type CheckGroundingRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::CheckGroundingRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def check_grounding(grounding_config: nil, answer_candidate: nil, facts: nil, grounding_spec: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse
Pass arguments to check_grounding via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • grounding_config (::String) — Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.
  • answer_candidate (::String) — Answer candidate to check. Can have a maximum length of 1024 characters.
  • facts (::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact, ::Hash>) — List of facts for the grounding check. We support up to 200 facts.
  • grounding_spec (::Google::Cloud::DiscoveryEngine::V1::CheckGroundingSpec, ::Hash) — Configuration of the grounding check.
  • user_labels (::Hash{::String => ::String}) — The user labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1::CheckGroundingRequest.new

# Call the check_grounding method.
result = client.check_grounding request

# The returned object is of type Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the GroundedGenerationService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#generate_grounded_content

def generate_grounded_content(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse
def generate_grounded_content(location: nil, system_instruction: nil, contents: nil, generation_spec: nil, grounding_spec: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse

Generates grounded content.

Overloads 
def generate_grounded_content(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse
Pass arguments to generate_grounded_content via a request object, either of type Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def generate_grounded_content(location: nil, system_instruction: nil, contents: nil, generation_spec: nil, grounding_spec: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse
Pass arguments to generate_grounded_content via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • location (::String) — Required. Location resource.

    Format: projects/{project}/locations/{location}.

  • system_instruction (::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent, ::Hash) — Content of the system instruction for the current API.

    These instructions will take priority over any other prompt instructions if the selected model is supporting them.

  • contents (::Array<::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent, ::Hash>) — Content of the current conversation with the model.

    For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.

    Only a single-turn query is supported currently.

  • generation_spec (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GenerationSpec, ::Hash) — Content generation specification.
  • grounding_spec (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSpec, ::Hash) — Grounding specification.
  • user_labels (::Hash{::String => ::String}) — The user labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest.new

# Call the generate_grounded_content method.
result = client.generate_grounded_content request

# The returned object is of type Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new GroundedGenerationService client object.

Yields
  • (config) — Configure the GroundedGenerationService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#stream_generate_grounded_content

def stream_generate_grounded_content(request, options = nil) { |response, operation| ... } -> ::Enumerable<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse>

Generates grounded content in a streaming fashion.

Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client.new

# Create an input stream.
input = Gapic::StreamInput.new

# Call the stream_generate_grounded_content method to start streaming.
output = client.stream_generate_grounded_content input

# Send requests on the stream. For each request object, set fields by
# passing keyword arguments. Be sure to close the stream when done.
input << Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest.new
input << Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest.new
input.close

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse
output.each do |current_response|
  p current_response
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)