Class: OCI::GenerativeAiAgentRuntime::GenerativeAiAgentRuntimeClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb

Overview

OCI Generative AI Agents is a fully managed service that combines the power of large language models (LLMs) with an intelligent retrieval system to create contextually relevant answers by searching your knowledge base, making your AI applications smart and efficient.

OCI Generative AI Agents supports several ways to onboard your data and then allows you and your customers to interact with your data using a chat interface or API.

Use the Generative AI Agents Client API to create and manage client chat sessions. A session represents an interactive conversation initiated by a user through an API to engage with an agent. It involves a series of exchanges where the user sends queries or prompts, and the agent responds with relevant information, actions, or assistance based on the user's input. The session persists for the duration of the interaction, maintaining context and continuity to provide coherent and meaningful responses throughout the conversation.

For creating and managing agents, knowledge bases, data sources, endpoints, and data ingestion jobs see the Generative AI Agents Management API.

To learn more about the service, see the Generative AI Agents documentation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GenerativeAiAgentRuntimeClient

Creates a new GenerativeAiAgentRuntimeClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

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

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

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

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 63

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20240531'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "GenerativeAiAgentRuntimeClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



23
24
25
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 23

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 27

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 37

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



33
34
35
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 33

def retry_config
  @retry_config
end

Instance Method Details

#chat(agent_endpoint_id, chat_details, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use chat API.

Chat on endpoint with provided messages.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



133
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
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 133

def chat(agent_endpoint_id, chat_details, opts = {}, &block)
  logger.debug 'Calling operation GenerativeAiAgentRuntimeClient#chat.' if logger

  raise "Missing the required parameter 'agent_endpoint_id' when calling chat." if agent_endpoint_id.nil?
  raise "Missing the required parameter 'chat_details' when calling chat." if chat_details.nil?
  raise "Parameter value for 'agent_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_endpoint_id)

  path = '/agentEndpoints/{agentEndpointId}/actions/chat'.sub('{agentEndpointId}', agent_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, text/event-stream'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(chat_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiAgentRuntimeClient#chat') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GenerativeAiAgentRuntime::Models::ChatResult',
      &block
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_session(create_session_details, agent_endpoint_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_session API.

A session represents an interactive conversation initiated by a user through an API to engage with an agent. It involves a series of exchanges where the user sends queries or prompts, and the agent responds with relevant information, actions, or assistance based on the user's input. The session persists for the duration of the interaction, maintaining context and continuity to provide coherent and meaningful responses throughout the conversation.Creates an agent session.

Use this API to create an agent session.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 202

def create_session(create_session_details, agent_endpoint_id, opts = {})
  logger.debug 'Calling operation GenerativeAiAgentRuntimeClient#create_session.' if logger

  raise "Missing the required parameter 'create_session_details' when calling create_session." if create_session_details.nil?
  raise "Missing the required parameter 'agent_endpoint_id' when calling create_session." if agent_endpoint_id.nil?
  raise "Parameter value for 'agent_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_endpoint_id)

  path = '/agentEndpoints/{agentEndpointId}/sessions'.sub('{agentEndpointId}', agent_endpoint_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_session_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiAgentRuntimeClient#create_session') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GenerativeAiAgentRuntime::Models::Session'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_session(agent_endpoint_id, session_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_session API.

Delete a session and all its associated information.

Parameters:

  • agent_endpoint_id (String) —

    A unique ID for the endpoint.

  • session_id (String) —

    A unique ID for the session.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



267
268
269
270
271
272
273
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
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 267

def delete_session(agent_endpoint_id, session_id, opts = {})
  logger.debug 'Calling operation GenerativeAiAgentRuntimeClient#delete_session.' if logger

  raise "Missing the required parameter 'agent_endpoint_id' when calling delete_session." if agent_endpoint_id.nil?
  raise "Missing the required parameter 'session_id' when calling delete_session." if session_id.nil?
  raise "Parameter value for 'agent_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_endpoint_id)
  raise "Parameter value for 'session_id' must not be blank" if OCI::Internal::Util.blank_string?(session_id)

  path = '/agentEndpoints/{agentEndpointId}/sessions/{sessionId}'.sub('{agentEndpointId}', agent_endpoint_id.to_s).sub('{sessionId}', session_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiAgentRuntimeClient#delete_session') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_session(agent_endpoint_id, session_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_session API.

Return the session resource identified by the session ID.

Parameters:

  • agent_endpoint_id (String) —

    A unique ID for the endpoint.

  • session_id (String) —

    A unique ID for the session.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 325

def get_session(agent_endpoint_id, session_id, opts = {})
  logger.debug 'Calling operation GenerativeAiAgentRuntimeClient#get_session.' if logger

  raise "Missing the required parameter 'agent_endpoint_id' when calling get_session." if agent_endpoint_id.nil?
  raise "Missing the required parameter 'session_id' when calling get_session." if session_id.nil?
  raise "Parameter value for 'agent_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_endpoint_id)
  raise "Parameter value for 'session_id' must not be blank" if OCI::Internal::Util.blank_string?(session_id)

  path = '/agentEndpoints/{agentEndpointId}/sessions/{sessionId}'.sub('{agentEndpointId}', agent_endpoint_id.to_s).sub('{sessionId}', session_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiAgentRuntimeClient#get_session') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GenerativeAiAgentRuntime::Models::Session'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



102
103
104
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 102

def logger
  @api_client.config.logger
end

#retrieve_metadata(knowledge_base_id, retrieve_metadata_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use retrieve_metadata API.

Returns metadata of provided knowledgeBase. Return available metadata with information of field names, their types, supported operations, and possible values.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Returns:



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 395

def retrieve_metadata(knowledge_base_id, retrieve_metadata_details, opts = {})
  logger.debug 'Calling operation GenerativeAiAgentRuntimeClient#retrieve_metadata.' if logger

  raise "Missing the required parameter 'knowledge_base_id' when calling retrieve_metadata." if knowledge_base_id.nil?
  raise "Missing the required parameter 'retrieve_metadata_details' when calling retrieve_metadata." if retrieve_metadata_details.nil?
  raise "Parameter value for 'knowledge_base_id' must not be blank" if OCI::Internal::Util.blank_string?(knowledge_base_id)

  path = '/knowledgeBases/{knowledgeBaseId}/actions/retrieveMetadata'.sub('{knowledgeBaseId}', knowledge_base_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(retrieve_metadata_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiAgentRuntimeClient#retrieve_metadata') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::GenerativeAiAgentRuntime::Models::KnowledgeBaseMetadataSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_session(agent_endpoint_id, session_id, update_session_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_session API.

Update session metadata, including but not limited to description, tags.

Parameters:

  • agent_endpoint_id (String) —

    A unique ID for the endpoint.

  • session_id (String) —

    A unique ID for the session.

  • update_session_details (OCI::GenerativeAiAgentRuntime::Models::UpdateSessionDetails) —

    Details to update an agent session.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/oci/generative_ai_agent_runtime/generative_ai_agent_runtime_client.rb', line 462

def update_session(agent_endpoint_id, session_id, update_session_details, opts = {})
  logger.debug 'Calling operation GenerativeAiAgentRuntimeClient#update_session.' if logger

  raise "Missing the required parameter 'agent_endpoint_id' when calling update_session." if agent_endpoint_id.nil?
  raise "Missing the required parameter 'session_id' when calling update_session." if session_id.nil?
  raise "Missing the required parameter 'update_session_details' when calling update_session." if update_session_details.nil?
  raise "Parameter value for 'agent_endpoint_id' must not be blank" if OCI::Internal::Util.blank_string?(agent_endpoint_id)
  raise "Parameter value for 'session_id' must not be blank" if OCI::Internal::Util.blank_string?(session_id)

  path = '/agentEndpoints/{agentEndpointId}/sessions/{sessionId}'.sub('{agentEndpointId}', agent_endpoint_id.to_s).sub('{sessionId}', session_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_session_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiAgentRuntimeClient#update_session') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::GenerativeAiAgentRuntime::Models::Session'
    )
  end
  # rubocop:enable Metrics/BlockLength
end