Class: Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb

Overview

REST client for the DataChatService service.

Service to ask a natural language question on top of BigQuery and Looker Studio datasources to get back streamed responses of various kinds to help provide a rich conversational answer.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#conversation_path, #data_agent_path, #location_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new DataChatService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the DataChatService client.

Yield Parameters:



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 134

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @data_chat_service_stub = ::Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @data_chat_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @data_chat_service_stub.endpoint
    config.universe_domain = @data_chat_service_stub.universe_domain
    config.bindings_override = @config.bindings_override
    config.logger = @data_chat_service_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

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

Returns:

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


190
191
192
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 190

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the DataChatService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all DataChatService clients
::Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 67

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "GeminiDataAnalytics", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 600.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#chat(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Message> #chat(inline_context: nil, conversation_reference: nil, data_agent_context: nil, client_managed_resource_context: nil, project: nil, parent: nil, messages: nil) ⇒ ::Enumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Message>

Answers a data question by generating a stream of [Message][google.cloud.geminidataanalytics.v1alpha.Message] objects.

Examples:

Basic example

require "google/cloud/gemini_data_analytics/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GeminiDataAnalytics::V1beta::ChatRequest.new

# Call the chat method to start streaming.
output = client.chat request

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::GeminiDataAnalytics::V1beta::Message
output.each do |current_response|
  p current_response
end

Overloads:

  • #chat(request, options = nil) ⇒ ::Enumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Message>

    Pass arguments to chat via a request object, either of type ChatRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GeminiDataAnalytics::V1beta::ChatRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #chat(inline_context: nil, conversation_reference: nil, data_agent_context: nil, client_managed_resource_context: nil, project: nil, parent: nil, messages: nil) ⇒ ::Enumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Message>

    Pass arguments to chat 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:

    • inline_context (::Google::Cloud::GeminiDataAnalytics::V1beta::Context, ::Hash) (defaults to: nil) —

      Optional. Inline context for the chat request. Use this to chat statelessly (without managed conversation persistence and without an Agent) by passing all context inline.

      Note: The following parameters are mutually exclusive: inline_context, conversation_reference, data_agent_context, client_managed_resource_context. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • conversation_reference (::Google::Cloud::GeminiDataAnalytics::V1beta::ConversationReference, ::Hash) (defaults to: nil) —

      Optional. Reference to a persisted conversation and agent context. Use this to chat with an Agent using managed conversation persistence.

      Note: The following parameters are mutually exclusive: conversation_reference, inline_context, data_agent_context, client_managed_resource_context. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • data_agent_context (::Google::Cloud::GeminiDataAnalytics::V1beta::DataAgentContext, ::Hash) (defaults to: nil) —

      Optional. Context for the chat request. Use this to chat with an Agent statelessly, without managed conversation persistence.

      Note: The following parameters are mutually exclusive: data_agent_context, inline_context, conversation_reference, client_managed_resource_context. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • client_managed_resource_context (::Google::Cloud::GeminiDataAnalytics::V1beta::ClientManagedResourceContext, ::Hash) (defaults to: nil) —

      Optional. Context with client managed resources. Some clients may not use GDA managed resources including conversations and agents, instead they create and manage their own conversations and agents resources.

      Note: The following parameters are mutually exclusive: client_managed_resource_context, inline_context, conversation_reference, data_agent_context. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.

    • project (::String) (defaults to: nil) —

      Optional. The Google Cloud project to be used for quota and billing.

    • parent (::String) (defaults to: nil) —

      Required. The parent value for chat request. Pattern: projects/{project}/locations/{location}

    • messages (::Array<::Google::Cloud::GeminiDataAnalytics::V1beta::Message, ::Hash>) (defaults to: nil) —

      Required. Content of current conversation.

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 274

def chat request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GeminiDataAnalytics::V1beta::ChatRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.chat.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GeminiDataAnalytics::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.chat.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.chat.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  ::Gapic::Rest::ServerStream.new(
    ::Google::Cloud::GeminiDataAnalytics::V1beta::Message,
    ::Gapic::Rest::ThreadedEnumerator.new do |in_q, out_q|
      @data_chat_service_stub.chat request, options do |chunk|
        in_q.deq
        out_q.enq chunk
      end
    end
  )
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the DataChatService 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



104
105
106
107
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 104

def configure
  yield @config if block_given?
  @config
end

#create_conversation(request, options = nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation #create_conversation(parent: nil, conversation_id: nil, conversation: nil, request_id: nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation

Creates a new conversation to persist the conversation history. Each conversation will have multiple messages associated with it.

Examples:

Basic example

require "google/cloud/gemini_data_analytics/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GeminiDataAnalytics::V1beta::CreateConversationRequest.new

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

# The returned object is of type Google::Cloud::GeminiDataAnalytics::V1beta::Conversation.
p result

Overloads:

  • #create_conversation(request, options = nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation

    Pass arguments to create_conversation via a request object, either of type CreateConversationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GeminiDataAnalytics::V1beta::CreateConversationRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_conversation(parent: nil, conversation_id: nil, conversation: nil, request_id: nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation

    Pass arguments to create_conversation 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:

    • parent (::String) (defaults to: nil) —

      Required. Parent value for CreateConversationRequest. Format: projects/{project}/locations/{location}

    • conversation_id (::String) (defaults to: nil) —

      Optional. The conversation id of the conversation to create. Must be unique within the parent. The allowed format is: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$. If not provided, the server will auto-generate a value for the id.

    • conversation (::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation, ::Hash) (defaults to: nil) —

      Required. The conversation to create.

    • request_id (::String) (defaults to: nil) —

      Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 372

def create_conversation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GeminiDataAnalytics::V1beta::CreateConversationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_conversation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GeminiDataAnalytics::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_conversation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_conversation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @data_chat_service_stub.create_conversation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_conversation(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_conversation(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a conversation.

Examples:

Basic example

require "google/cloud/gemini_data_analytics/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GeminiDataAnalytics::V1beta::DeleteConversationRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_conversation(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_conversation via a request object, either of type Google::Cloud::GeminiDataAnalytics::V1beta::DeleteConversationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GeminiDataAnalytics::V1beta::DeleteConversationRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_conversation(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_conversation 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:

    • name (::String) (defaults to: nil) —

      Required. Name of the resource. Format: projects/{project}/locations/{location}/conversations/{conversation}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 452

def delete_conversation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GeminiDataAnalytics::V1beta::DeleteConversationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_conversation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GeminiDataAnalytics::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_conversation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_conversation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @data_chat_service_stub.delete_conversation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_conversation(request, options = nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation #get_conversation(name: nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation

Gets details of a single conversation by using conversation id and parent.

Examples:

Basic example

require "google/cloud/gemini_data_analytics/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GeminiDataAnalytics::V1beta::GetConversationRequest.new

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

# The returned object is of type Google::Cloud::GeminiDataAnalytics::V1beta::Conversation.
p result

Overloads:

  • #get_conversation(request, options = nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation

    Pass arguments to get_conversation via a request object, either of type GetConversationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GeminiDataAnalytics::V1beta::GetConversationRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_conversation(name: nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation

    Pass arguments to get_conversation 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:

    • name (::String) (defaults to: nil) —

      Required. Name of the resource. Format: projects/{project}/locations/{location}/conversations/{conversation}

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 532

def get_conversation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GeminiDataAnalytics::V1beta::GetConversationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_conversation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GeminiDataAnalytics::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_conversation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_conversation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @data_chat_service_stub.get_conversation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_conversations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation> #list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation>

Lists all conversations for a given parent.

Examples:

Basic example

require "google/cloud/gemini_data_analytics/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GeminiDataAnalytics::V1beta::ListConversationsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation.
  p item
end

Overloads:

  • #list_conversations(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation>

    Pass arguments to list_conversations via a request object, either of type ListConversationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GeminiDataAnalytics::V1beta::ListConversationsRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_conversations(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::Conversation>

    Pass arguments to list_conversations 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:

    • parent (::String) (defaults to: nil) —

      Required. Parent value for ListConversationsRequest. Format: projects/{project}/locations/{location}

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. The max page size is 100. All larger page sizes will be coerced to 100. If unspecified, server will pick 50 as an approperiate default.

    • page_token (::String) (defaults to: nil) —

      Optional. A token identifying a page of results the server should return.

    • filter (::String) (defaults to: nil) —

      Optional. Returned conversations will match criteria specified within the filter. ListConversations allows filtering by:

      • agents
      • labels

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 626

def list_conversations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GeminiDataAnalytics::V1beta::ListConversationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_conversations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GeminiDataAnalytics::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_conversations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_conversations.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @data_chat_service_stub.list_conversations request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @data_chat_service_stub, :list_conversations, "conversations", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_messages(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::StorageMessage> #list_messages(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::StorageMessage>

Lists all messages for a given conversation.

Examples:

Basic example

require "google/cloud/gemini_data_analytics/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GeminiDataAnalytics::V1beta::ListMessagesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::GeminiDataAnalytics::V1beta::StorageMessage.
  p item
end

Overloads:

  • #list_messages(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::StorageMessage>

    Pass arguments to list_messages via a request object, either of type ListMessagesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GeminiDataAnalytics::V1beta::ListMessagesRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_messages(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GeminiDataAnalytics::V1beta::StorageMessage>

    Pass arguments to list_messages 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:

    • parent (::String) (defaults to: nil) —

      Required. The conversation to list messages under. Format: projects/{project}/locations/{location}/conversations/{conversation_id}

    • page_size (::Integer) (defaults to: nil) —

      Optional. Requested page size. Server may return fewer items than requested. The max page size is 100. All larger page sizes will be coerced to 100. If unspecified, server will pick 50 as an approperiate default.

    • page_token (::String) (defaults to: nil) —

      Optional. A token identifying a page of results the server should return.

    • filter (::String) (defaults to: nil) —

      Optional. Filtering results. See AIP-160 for syntax.

      ListMessages allows filtering by:

      • create_time (e.g., createTime > "2025-01-28T06:51:56-08:00")
      • update_time

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 725

def list_messages request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GeminiDataAnalytics::V1beta::ListMessagesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_messages.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GeminiDataAnalytics::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_messages.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_messages.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @data_chat_service_stub.list_messages request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @data_chat_service_stub, :list_messages, "messages", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


197
198
199
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 197

def logger
  @data_chat_service_stub.logger
end

#query_data(request, options = nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataResponse #query_data(parent: nil, prompt: nil, context: nil, generation_options: nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataResponse

Queries data from a natural language user query.

Examples:

Basic example

require "google/cloud/gemini_data_analytics/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GeminiDataAnalytics::V1beta::DataChatService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataRequest.new

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

# The returned object is of type Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataResponse.
p result

Overloads:

  • #query_data(request, options = nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataResponse

    Pass arguments to query_data via a request object, either of type QueryDataRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataRequest, ::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #query_data(parent: nil, prompt: nil, context: nil, generation_options: nil) ⇒ ::Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataResponse

    Pass arguments to query_data 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:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource to generate the query for. Format: projects/{project}/locations/{location}

    • prompt (::String) (defaults to: nil) —

      Required. The natural language query for which to generate query. Example: "What are the top 5 best selling products this month?"

    • context (::Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataContext, ::Hash) (defaults to: nil) —

      Required. The context for the data query, including the data sources to use.

    • generation_options (::Google::Cloud::GeminiDataAnalytics::V1beta::GenerationOptions, ::Hash) (defaults to: nil) —

      Optional. Options to control query generation and execution behavior.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 814

def query_data request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::GeminiDataAnalytics::V1beta::QueryDataRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.query_data.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::GeminiDataAnalytics::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_data.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.query_data.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @data_chat_service_stub.query_data request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


114
115
116
 
# File 'lib/google/cloud/gemini_data_analytics/v1beta/data_chat_service/rest/client.rb', line 114

def universe_domain
  @data_chat_service_stub.universe_domain
end