Class: OCI::GenerativeAi::GenerativeAiClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/generative_ai_client.rb

Overview

OCI Generative AI is a fully managed service that provides a set of state-of-the-art, customizable large language models (LLMs) that cover a wide range of use cases for text generation, summarization, and text embeddings.

Use the Generative AI service management API to create and manage dedicated AI clusters, endpoints, custom models, and work requests in the Generative AI service. For example, create a custom model by fine-tuning an out-of-the-box model using your own data, on a fine-tuning dedicated AI cluster. Then, create a hosting dedicated AI cluster with an endpoint to host your custom model.

To access your custom model endpoints, or to try the out-of-the-box models to generate text, summarize, and create text embeddings see the Generative AI Inference API.

To learn more about the service, see the Generative AI 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) ⇒ GenerativeAiClient

Creates a new GenerativeAiClient. 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



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

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 + '/20231130'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "GenerativeAiClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



21
22
23
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 21

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 25

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 35

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:



31
32
33
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 31

def retry_config
  @retry_config
end

Instance Method Details

#add_artifact(add_artifact_details, hosted_deployment_id, opts = {}) ⇒ Response

Note:

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

add image with isAutoDeploy flag.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def add_artifact(add_artifact_details, hosted_deployment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#add_artifact.' if logger

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

  path = '/hostedDeployments/{hostedDeploymentId}/artifacts'.sub('{hostedDeploymentId}', hosted_deployment_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]
  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(add_artifact_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#add_artifact') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#cancel_vector_store_connector_file_sync(vector_store_connector_file_sync_id, opts = {}) ⇒ Response

Note:

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

Cancels a vectorStoreConnectorFileSync.

Parameters:

  • vector_store_connector_file_sync_id (String) —

    The OCID of the vectorStoreConnectorFileSync.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



199
200
201
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
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 199

def cancel_vector_store_connector_file_sync(vector_store_connector_file_sync_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#cancel_vector_store_connector_file_sync.' if logger

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

  path = '/vectorStoreConnectorFileSyncs/{vectorStoreConnectorFileSyncId}'.sub('{vectorStoreConnectorFileSyncId}', vector_store_connector_file_sync_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: 'GenerativeAiClient#cancel_vector_store_connector_file_sync') 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

#change_api_key_compartment(api_key_id, change_api_key_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves an API key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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
306
307
308
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 269

def change_api_key_compartment(api_key_id, change_api_key_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_api_key_compartment.' if logger

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

  path = '/apikeys/{apiKeyId}/actions/changeCompartment'.sub('{apiKeyId}', api_key_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]
  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(change_api_key_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_api_key_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_dedicated_ai_cluster_compartment(dedicated_ai_cluster_id, change_dedicated_ai_cluster_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a dedicated AI cluster into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 342

def change_dedicated_ai_cluster_compartment(dedicated_ai_cluster_id, change_dedicated_ai_cluster_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_dedicated_ai_cluster_compartment.' if logger

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

  path = '/dedicatedAiClusters/{dedicatedAiClusterId}/actions/changeCompartment'.sub('{dedicatedAiClusterId}', dedicated_ai_cluster_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]
  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(change_dedicated_ai_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_dedicated_ai_cluster_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_endpoint_compartment(endpoint_id, change_endpoint_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 415

def change_endpoint_compartment(endpoint_id, change_endpoint_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_endpoint_compartment.' if logger

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

  path = '/endpoints/{endpointId}/actions/changeCompartment'.sub('{endpointId}', 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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  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(change_endpoint_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_endpoint_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_generative_ai_private_endpoint_compartment(generative_ai_private_endpoint_id, change_generative_ai_private_endpoint_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Generative AI private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 491

def change_generative_ai_private_endpoint_compartment(generative_ai_private_endpoint_id, change_generative_ai_private_endpoint_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_generative_ai_private_endpoint_compartment.' if logger

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

  path = '/generativeAiPrivateEndpoints/{generativeAiPrivateEndpointId}/actions/changeCompartment'.sub('{generativeAiPrivateEndpointId}', generative_ai_private_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-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(change_generative_ai_private_endpoint_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_generative_ai_private_endpoint_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_generative_ai_project_compartment(generative_ai_project_id, change_generative_ai_project_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a generativeAiProject into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 564

def change_generative_ai_project_compartment(generative_ai_project_id, change_generative_ai_project_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_generative_ai_project_compartment.' if logger

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

  path = '/generativeAiProjects/{generativeAiProjectId}/actions/changeCompartment'.sub('{generativeAiProjectId}', generative_ai_project_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]
  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(change_generative_ai_project_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_generative_ai_project_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_hosted_application_compartment(hosted_application_id, change_hosted_application_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a hosted application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 637

def change_hosted_application_compartment(hosted_application_id, change_hosted_application_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_hosted_application_compartment.' if logger

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

  path = '/hostedApplications/{hostedApplicationId}/actions/changeCompartment'.sub('{hostedApplicationId}', hosted_application_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]
  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(change_hosted_application_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_hosted_application_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_hosted_application_iam_compartment(hosted_application_iam_id, change_hosted_application_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a hosted application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
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
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 710

def change_hosted_application_iam_compartment(hosted_application_iam_id, change_hosted_application_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_hosted_application_iam_compartment.' if logger

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

  path = '/hostedApplicationsIam/{hostedApplicationIamId}/actions/changeCompartment'.sub('{hostedApplicationIamId}', hosted_application_iam_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]
  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(change_hosted_application_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_hosted_application_iam_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_hosted_application_storage_compartment(hosted_application_storage_id, change_hosted_application_storage_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a hosted application storage into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 783

def change_hosted_application_storage_compartment(hosted_application_storage_id, change_hosted_application_storage_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_hosted_application_storage_compartment.' if logger

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

  path = '/hostedApplicationStorages/{hostedApplicationStorageId}/actions/changeCompartment'.sub('{hostedApplicationStorageId}', hosted_application_storage_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]
  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(change_hosted_application_storage_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_hosted_application_storage_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_imported_model_compartment(imported_model_id, change_imported_model_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves an imported model into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 856

def change_imported_model_compartment(imported_model_id, change_imported_model_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_imported_model_compartment.' if logger

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

  path = '/importedModels/{importedModelId}/actions/changeCompartment'.sub('{importedModelId}', imported_model_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]
  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(change_imported_model_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_imported_model_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_model_compartment(model_id, change_model_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a custom model into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 929

def change_model_compartment(model_id, change_model_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_model_compartment.' if logger

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

  path = '/models/{modelId}/actions/changeCompartment'.sub('{modelId}', model_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]
  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(change_model_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_model_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_semantic_store_compartment(semantic_store_id, change_semantic_store_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a SemanticStore into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1002

def change_semantic_store_compartment(semantic_store_id, change_semantic_store_compartment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#change_semantic_store_compartment.' if logger

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

  path = '/semanticStores/{semanticStoreId}/actions/changeCompartment'.sub('{semanticStoreId}', semantic_store_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]
  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(change_semantic_store_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#change_semantic_store_compartment') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_api_key(create_api_key_details, opts = {}) ⇒ Response

Note:

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

Creates a new API key in the specified compartment.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1069

def create_api_key(create_api_key_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_api_key.' if logger

  raise "Missing the required parameter 'create_api_key_details' when calling create_api_key." if create_api_key_details.nil?

  path = '/apikeys'
  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_api_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_api_key') 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::GenerativeAi::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_dedicated_ai_cluster(create_dedicated_ai_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates a dedicated AI cluster.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1134

def create_dedicated_ai_cluster(create_dedicated_ai_cluster_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_dedicated_ai_cluster.' if logger

  raise "Missing the required parameter 'create_dedicated_ai_cluster_details' when calling create_dedicated_ai_cluster." if create_dedicated_ai_cluster_details.nil?

  path = '/dedicatedAiClusters'
  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_dedicated_ai_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_dedicated_ai_cluster') 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::GenerativeAi::Models::DedicatedAiCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_endpoint(create_endpoint_details, opts = {}) ⇒ Response

Note:

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

Creates an endpoint.

The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1202

def create_endpoint(create_endpoint_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_endpoint.' if logger

  raise "Missing the required parameter 'create_endpoint_details' when calling create_endpoint." if create_endpoint_details.nil?

  path = '/endpoints'
  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_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_endpoint') 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::GenerativeAi::Models::Endpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_generative_ai_private_endpoint(create_generative_ai_private_endpoint_details, opts = {}) ⇒ Response

Note:

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

Creates a Generative AI private endpoint.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1269

def create_generative_ai_private_endpoint(create_generative_ai_private_endpoint_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_generative_ai_private_endpoint.' if logger

  raise "Missing the required parameter 'create_generative_ai_private_endpoint_details' when calling create_generative_ai_private_endpoint." if create_generative_ai_private_endpoint_details.nil?

  path = '/generativeAiPrivateEndpoints'
  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_generative_ai_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_generative_ai_private_endpoint') 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::GenerativeAi::Models::GenerativeAiPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_generative_ai_project(create_generative_ai_project_details, opts = {}) ⇒ Response

Note:

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

Creates a GenerativeAiProject. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the generativeAiProject creation progress.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1336

def create_generative_ai_project(create_generative_ai_project_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_generative_ai_project.' if logger

  raise "Missing the required parameter 'create_generative_ai_project_details' when calling create_generative_ai_project." if create_generative_ai_project_details.nil?

  path = '/generativeAiProjects'
  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_generative_ai_project_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_generative_ai_project') 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::GenerativeAi::Models::GenerativeAiProject'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_hosted_application(create_hosted_application_details, opts = {}) ⇒ Response

Note:

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

Creates a hosted application.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1401

def create_hosted_application(create_hosted_application_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_hosted_application.' if logger

  raise "Missing the required parameter 'create_hosted_application_details' when calling create_hosted_application." if create_hosted_application_details.nil?

  path = '/hostedApplications'
  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_hosted_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_hosted_application') 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::GenerativeAi::Models::HostedApplication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_hosted_application_iam(create_hosted_application_iam_details, opts = {}) ⇒ Response

Note:

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

Creates a hosted application.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1466

def create_hosted_application_iam(create_hosted_application_iam_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_hosted_application_iam.' if logger

  raise "Missing the required parameter 'create_hosted_application_iam_details' when calling create_hosted_application_iam." if create_hosted_application_iam_details.nil?

  path = '/hostedApplicationsIam'
  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_hosted_application_iam_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_hosted_application_iam') 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::GenerativeAi::Models::HostedApplicationIam'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_hosted_application_storage(create_hosted_application_storage_details, opts = {}) ⇒ Response

Note:

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

Creates a hosted application storage.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1531

def create_hosted_application_storage(create_hosted_application_storage_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_hosted_application_storage.' if logger

  raise "Missing the required parameter 'create_hosted_application_storage_details' when calling create_hosted_application_storage." if create_hosted_application_storage_details.nil?

  path = '/hostedApplicationStorages'
  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_hosted_application_storage_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_hosted_application_storage') 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::GenerativeAi::Models::HostedApplicationStorage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_hosted_deployment(create_hosted_deployment_details, opts = {}) ⇒ Response

Note:

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

Creates a hosted deployment.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1596

def create_hosted_deployment(create_hosted_deployment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_hosted_deployment.' if logger

  raise "Missing the required parameter 'create_hosted_deployment_details' when calling create_hosted_deployment." if create_hosted_deployment_details.nil?

  path = '/hostedDeployments'
  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_hosted_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_hosted_deployment') 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::GenerativeAi::Models::HostedDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_imported_model(create_imported_model_details, opts = {}) ⇒ Response

Note:

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

Import a model from ModelDataSource.

The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the importedModel creation progress.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1664

def create_imported_model(create_imported_model_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_imported_model.' if logger

  raise "Missing the required parameter 'create_imported_model_details' when calling create_imported_model." if create_imported_model_details.nil?

  path = '/importedModels'
  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_imported_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_imported_model') 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::GenerativeAi::Models::ImportedModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_model(create_model_details, opts = {}) ⇒ Response

Note:

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

Creates a custom model by fine-tuning a base model with your own dataset. You can create a new custom models or create a new version of existing custom model..

The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1732

def create_model(create_model_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_model.' if logger

  raise "Missing the required parameter 'create_model_details' when calling create_model." if create_model_details.nil?

  path = '/models'
  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_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_model') 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::GenerativeAi::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_semantic_store(create_semantic_store_details, opts = {}) ⇒ Response

Note:

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

Creates a SemanticStore.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1798

def create_semantic_store(create_semantic_store_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_semantic_store.' if logger

  raise "Missing the required parameter 'create_semantic_store_details' when calling create_semantic_store." if create_semantic_store_details.nil?

  path = '/semanticStores'
  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_semantic_store_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_semantic_store') 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::GenerativeAi::Models::SemanticStore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vector_store_connector(create_vector_store_connector_details, opts = {}) ⇒ Response

Note:

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

Creates a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnector creation progress.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1865

def create_vector_store_connector(create_vector_store_connector_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_vector_store_connector.' if logger

  raise "Missing the required parameter 'create_vector_store_connector_details' when calling create_vector_store_connector." if create_vector_store_connector_details.nil?

  path = '/vectorStoreConnectors'
  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_vector_store_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_vector_store_connector') 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::GenerativeAi::Models::VectorStoreConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vector_store_connector_file_sync(create_vector_store_connector_file_sync_details, opts = {}) ⇒ Response

Note:

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

Creates a File Sync operation for a VectorStoreConnector. The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the vectorStoreConnectorFileSync creation progress.

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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1932

def create_vector_store_connector_file_sync(create_vector_store_connector_file_sync_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#create_vector_store_connector_file_sync.' if logger

  raise "Missing the required parameter 'create_vector_store_connector_file_sync_details' when calling create_vector_store_connector_file_sync." if create_vector_store_connector_file_sync_details.nil?

  path = '/vectorStoreConnectorFileSyncs'
  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_vector_store_connector_file_sync_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#create_vector_store_connector_file_sync') 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::GenerativeAi::Models::VectorStoreConnectorFileSync'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_api_key(api_key_id, opts = {}) ⇒ Response

Note:

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

Deletes an API key.

Parameters:

  • api_key_id (String) —

    The OCID of the APIKey.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 1996

def delete_api_key(api_key_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_api_key.' if logger

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

  path = '/apikeys/{apiKeyId}'.sub('{apiKeyId}', api_key_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: 'GenerativeAiClient#delete_api_key') 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

#delete_dedicated_ai_cluster(dedicated_ai_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes a dedicated AI cluster.

You can only delete clusters without attached resources. Before you delete a hosting dedicated AI cluster, you must delete the endpoints associated to that cluster. Before you delete a fine-tuning dedicated AI cluster, you must delete the custom model on that cluster. The delete action permanently deletes the cluster. This action can't be undone.

Parameters:

  • dedicated_ai_cluster_id (String) —

    The OCID of the dedicated AI cluster.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2062

def delete_dedicated_ai_cluster(dedicated_ai_cluster_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_dedicated_ai_cluster.' if logger

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

  path = '/dedicatedAiClusters/{dedicatedAiClusterId}'.sub('{dedicatedAiClusterId}', dedicated_ai_cluster_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: 'GenerativeAiClient#delete_dedicated_ai_cluster') 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

#delete_endpoint(endpoint_id, opts = {}) ⇒ Response

Note:

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

Deletes an endpoint.

Parameters:

  • endpoint_id (String) —

    The OCID of the endpoint.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2125

def delete_endpoint(endpoint_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_endpoint.' if logger

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

  path = '/endpoints/{endpointId}'.sub('{endpointId}', 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[:'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: 'GenerativeAiClient#delete_endpoint') 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

#delete_generative_ai_private_endpoint(generative_ai_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Deletes a Generative AI private endpoint using privateEndpointId.

Parameters:

  • generative_ai_private_endpoint_id (String) —

    The unique id for a Generative AI private endpoint.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

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

Returns:

  • (Response) —

    A Response object with data of type nil



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2190

def delete_generative_ai_private_endpoint(generative_ai_private_endpoint_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_generative_ai_private_endpoint.' if logger

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

  path = '/generativeAiPrivateEndpoints/{generativeAiPrivateEndpointId}'.sub('{generativeAiPrivateEndpointId}', generative_ai_private_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-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#delete_generative_ai_private_endpoint') 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

#delete_generative_ai_project(generative_ai_project_id, opts = {}) ⇒ Response

Note:

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

Deletes a generativeAiProject.

Parameters:

  • generative_ai_project_id (String) —

    The OCID of the generativeAiProject.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2253

def delete_generative_ai_project(generative_ai_project_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_generative_ai_project.' if logger

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

  path = '/generativeAiProjects/{generativeAiProjectId}'.sub('{generativeAiProjectId}', generative_ai_project_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: 'GenerativeAiClient#delete_generative_ai_project') 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

#delete_hosted_application(hosted_application_id, opts = {}) ⇒ Response

Note:

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

Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can't be undone.

Parameters:

  • hosted_application_id (String) —

    The OCID of the hosted application.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2318

def delete_hosted_application(hosted_application_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_hosted_application.' if logger

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

  path = '/hostedApplications/{hostedApplicationId}'.sub('{hostedApplicationId}', hosted_application_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: 'GenerativeAiClient#delete_hosted_application') 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

#delete_hosted_application_iam(hosted_application_iam_id, opts = {}) ⇒ Response

Note:

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

Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can't be undone.

Parameters:

  • hosted_application_iam_id (String) —

    The OCID of the hosted application.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2383

def delete_hosted_application_iam(hosted_application_iam_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_hosted_application_iam.' if logger

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

  path = '/hostedApplicationsIam/{hostedApplicationIamId}'.sub('{hostedApplicationIamId}', hosted_application_iam_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: 'GenerativeAiClient#delete_hosted_application_iam') 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

#delete_hosted_application_storage(hosted_application_storage_id, opts = {}) ⇒ Response

Note:

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

Deletes a hosted application. You can only delete hosted application without attached resources. Before you delete a hosting hosted application, you must delete the endpoints associated to that application. Before you delete a fine-tuning hosted application, you must delete the custom model on that application. The delete action permanently deletes the cluster. This action can't be undone.

Parameters:

  • hosted_application_storage_id (String) —

    The OCID of the hosted application storage.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2448

def delete_hosted_application_storage(hosted_application_storage_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_hosted_application_storage.' if logger

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

  path = '/hostedApplicationStorages/{hostedApplicationStorageId}'.sub('{hostedApplicationStorageId}', hosted_application_storage_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: 'GenerativeAiClient#delete_hosted_application_storage') 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

#delete_hosted_deployment(hosted_deployment_id, opts = {}) ⇒ Response

Note:

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

Deletes a hosted deployment. You can only delete hosted deployment without attached resources. Before you delete a hosting hosted deployment, you must delete the endpoints associated to that deployment. Before you delete a fine-tuning hosted deployment, you must delete the custom model on that deployment. The delete action permanently deletes the cluster. This action can't be undone.

Parameters:

  • hosted_deployment_id (String) —

    The OCID of the hosted deployment.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2513

def delete_hosted_deployment(hosted_deployment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_hosted_deployment.' if logger

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

  path = '/hostedDeployments/{hostedDeploymentId}'.sub('{hostedDeploymentId}', hosted_deployment_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: 'GenerativeAiClient#delete_hosted_deployment') 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

#delete_hosted_deployment_artifact(hosted_deployment_id, artifact_id, opts = {}) ⇒ Response

Note:

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

delete artifact.

Parameters:

  • hosted_deployment_id (String) —

    The OCID of the hosted deployment.

  • artifact_id (String) —

    The id of the artifact.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2577

def delete_hosted_deployment_artifact(hosted_deployment_id, artifact_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_hosted_deployment_artifact.' if logger

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

  path = '/hostedDeployments/{hostedDeploymentId}/artifacts/{artifactId}'.sub('{hostedDeploymentId}', hosted_deployment_id.to_s).sub('{artifactId}', artifact_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: 'GenerativeAiClient#delete_hosted_deployment_artifact') 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

#delete_imported_model(imported_model_id, opts = {}) ⇒ Response

Note:

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

Deletes an imported model. An imported model shouldn't be deleted if there's one or more active endpoints associated with that imported model.

Parameters:

  • imported_model_id (String) —

    The importedModel OCID

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2642

def delete_imported_model(imported_model_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_imported_model.' if logger

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

  path = '/importedModels/{importedModelId}'.sub('{importedModelId}', imported_model_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: 'GenerativeAiClient#delete_imported_model') 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

#delete_model(model_id, opts = {}) ⇒ Response

Note:

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

Deletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with that model.

Parameters:

  • model_id (String) —

    The model OCID

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2705

def delete_model(model_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_model.' if logger

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

  path = '/models/{modelId}'.sub('{modelId}', model_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: 'GenerativeAiClient#delete_model') 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

#delete_semantic_store(semantic_store_id, opts = {}) ⇒ Response

Note:

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

Deletes a semanticStore.

Parameters:

  • semantic_store_id (String) —

    The OCID of the SemanticStore.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2768

def delete_semantic_store(semantic_store_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_semantic_store.' if logger

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

  path = '/semanticStores/{semanticStoreId}'.sub('{semanticStoreId}', semantic_store_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: 'GenerativeAiClient#delete_semantic_store') 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

#delete_vector_store_connector(vector_store_connector_id, opts = {}) ⇒ Response

Note:

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

Deletes a vectorStoreConnector.

Parameters:

  • vector_store_connector_id (String) —

    The OCID of the VectorStoreConnector.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2831

def delete_vector_store_connector(vector_store_connector_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#delete_vector_store_connector.' if logger

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

  path = '/vectorStoreConnectors/{vectorStoreConnectorId}'.sub('{vectorStoreConnectorId}', vector_store_connector_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: 'GenerativeAiClient#delete_vector_store_connector') 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_api_key(api_key_id, opts = {}) ⇒ Response

Note:

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

Gets information about an API key.

Parameters:

  • api_key_id (String) —

    The OCID of the APIKey.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2889

def get_api_key(api_key_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_api_key.' if logger

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

  path = '/apikeys/{apiKeyId}'.sub('{apiKeyId}', api_key_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: 'GenerativeAiClient#get_api_key') 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::GenerativeAi::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_dedicated_ai_cluster(dedicated_ai_cluster_id, opts = {}) ⇒ Response

Note:

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

Gets information about a dedicated AI cluster.

Parameters:

  • dedicated_ai_cluster_id (String) —

    The OCID of the dedicated AI cluster.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 2947

def get_dedicated_ai_cluster(dedicated_ai_cluster_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_dedicated_ai_cluster.' if logger

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

  path = '/dedicatedAiClusters/{dedicatedAiClusterId}'.sub('{dedicatedAiClusterId}', dedicated_ai_cluster_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: 'GenerativeAiClient#get_dedicated_ai_cluster') 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::GenerativeAi::Models::DedicatedAiCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_endpoint(endpoint_id, opts = {}) ⇒ Response

Note:

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

Gets information about an endpoint.

Parameters:

  • endpoint_id (String) —

    The OCID of the endpoint.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3005

def get_endpoint(endpoint_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_endpoint.' if logger

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

  path = '/endpoints/{endpointId}'.sub('{endpointId}', 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-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: 'GenerativeAiClient#get_endpoint') 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::GenerativeAi::Models::Endpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_generative_ai_private_endpoint(generative_ai_private_endpoint_id, opts = {}) ⇒ Response

Note:

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

Retrieves an Generative AI private endpoint using a privateEndpointId.

Parameters:

  • generative_ai_private_endpoint_id (String) —

    The unique id for a Generative AI private endpoint.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3065

def get_generative_ai_private_endpoint(generative_ai_private_endpoint_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_generative_ai_private_endpoint.' if logger

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

  path = '/generativeAiPrivateEndpoints/{generativeAiPrivateEndpointId}'.sub('{generativeAiPrivateEndpointId}', generative_ai_private_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-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: 'GenerativeAiClient#get_generative_ai_private_endpoint') 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::GenerativeAi::Models::GenerativeAiPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_generative_ai_project(generative_ai_project_id, opts = {}) ⇒ Response

Note:

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

Gets information about a generativeAiProject.

Parameters:

  • generative_ai_project_id (String) —

    The OCID of the generativeAiProject.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3123

def get_generative_ai_project(generative_ai_project_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_generative_ai_project.' if logger

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

  path = '/generativeAiProjects/{generativeAiProjectId}'.sub('{generativeAiProjectId}', generative_ai_project_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: 'GenerativeAiClient#get_generative_ai_project') 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::GenerativeAi::Models::GenerativeAiProject'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_hosted_application(hosted_application_id, opts = {}) ⇒ Response

Note:

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

Gets information about a hosted application.

Parameters:

  • hosted_application_id (String) —

    The OCID of the hosted application.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3181

def get_hosted_application(hosted_application_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_hosted_application.' if logger

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

  path = '/hostedApplications/{hostedApplicationId}'.sub('{hostedApplicationId}', hosted_application_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: 'GenerativeAiClient#get_hosted_application') 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::GenerativeAi::Models::HostedApplication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_hosted_application_iam(hosted_application_iam_id, opts = {}) ⇒ Response

Note:

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

Gets information about a hosted application.

Parameters:

  • hosted_application_iam_id (String) —

    The OCID of the hosted application.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3239

def get_hosted_application_iam(hosted_application_iam_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_hosted_application_iam.' if logger

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

  path = '/hostedApplicationsIam/{hostedApplicationIamId}'.sub('{hostedApplicationIamId}', hosted_application_iam_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: 'GenerativeAiClient#get_hosted_application_iam') 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::GenerativeAi::Models::HostedApplicationIam'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_hosted_application_storage(hosted_application_storage_id, opts = {}) ⇒ Response

Note:

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

Gets information about a hosted application storage.

Parameters:

  • hosted_application_storage_id (String) —

    The OCID of the hosted application storage.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3297

def get_hosted_application_storage(hosted_application_storage_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_hosted_application_storage.' if logger

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

  path = '/hostedApplicationStorages/{hostedApplicationStorageId}'.sub('{hostedApplicationStorageId}', hosted_application_storage_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: 'GenerativeAiClient#get_hosted_application_storage') 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::GenerativeAi::Models::HostedApplicationStorage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_hosted_deployment(hosted_deployment_id, opts = {}) ⇒ Response

Note:

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

Gets information about a hosted deployment.

Parameters:

  • hosted_deployment_id (String) —

    The OCID of the hosted deployment.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3355

def get_hosted_deployment(hosted_deployment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_hosted_deployment.' if logger

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

  path = '/hostedDeployments/{hostedDeploymentId}'.sub('{hostedDeploymentId}', hosted_deployment_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: 'GenerativeAiClient#get_hosted_deployment') 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::GenerativeAi::Models::HostedDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_imported_model(imported_model_id, opts = {}) ⇒ Response

Note:

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

Gets information about an imported model.

Parameters:

  • imported_model_id (String) —

    The importedModel OCID

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3413

def get_imported_model(imported_model_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_imported_model.' if logger

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

  path = '/importedModels/{importedModelId}'.sub('{importedModelId}', imported_model_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: 'GenerativeAiClient#get_imported_model') 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::GenerativeAi::Models::ImportedModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_model(model_id, opts = {}) ⇒ Response

Note:

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

Gets information about a custom model.

Parameters:

  • model_id (String) —

    The model OCID

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3471

def get_model(model_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_model.' if logger

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

  path = '/models/{modelId}'.sub('{modelId}', model_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: 'GenerativeAiClient#get_model') 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::GenerativeAi::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_semantic_store(semantic_store_id, opts = {}) ⇒ Response

Note:

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

Gets information about a semanticStore.

Parameters:

  • semantic_store_id (String) —

    The OCID of the SemanticStore.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3529

def get_semantic_store(semantic_store_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_semantic_store.' if logger

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

  path = '/semanticStores/{semanticStoreId}'.sub('{semanticStoreId}', semantic_store_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: 'GenerativeAiClient#get_semantic_store') 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::GenerativeAi::Models::SemanticStore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vector_store_connector(vector_store_connector_id, opts = {}) ⇒ Response

Note:

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

Gets information about a vectorStoreConnector.

Parameters:

  • vector_store_connector_id (String) —

    The OCID of the VectorStoreConnector.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3587

def get_vector_store_connector(vector_store_connector_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_vector_store_connector.' if logger

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

  path = '/vectorStoreConnectors/{vectorStoreConnectorId}'.sub('{vectorStoreConnectorId}', vector_store_connector_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: 'GenerativeAiClient#get_vector_store_connector') 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::GenerativeAi::Models::VectorStoreConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vector_store_connector_file_sync(vector_store_connector_file_sync_id, opts = {}) ⇒ Response

Note:

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

Gets information about a vectorStoreConnectorFileSync.

Parameters:

  • vector_store_connector_file_sync_id (String) —

    The OCID of the vectorStoreConnectorFileSync.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3645

def get_vector_store_connector_file_sync(vector_store_connector_file_sync_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_vector_store_connector_file_sync.' if logger

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

  path = '/vectorStoreConnectorFileSyncs/{vectorStoreConnectorFileSyncId}'.sub('{vectorStoreConnectorFileSyncId}', vector_store_connector_file_sync_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: 'GenerativeAiClient#get_vector_store_connector_file_sync') 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::GenerativeAi::Models::VectorStoreConnectorFileSync'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vector_store_connector_stats(vector_store_connector_id, opts = {}) ⇒ Response

Note:

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

Gets Sync statistics from a vectorStoreConnector.

Parameters:

  • vector_store_connector_id (String) —

    The OCID of the VectorStoreConnector.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3703

def get_vector_store_connector_stats(vector_store_connector_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_vector_store_connector_stats.' if logger

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

  path = '/vectorStoreConnectors/{vectorStoreConnectorId}/stats'.sub('{vectorStoreConnectorId}', vector_store_connector_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: 'GenerativeAiClient#get_vector_store_connector_stats') 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::GenerativeAi::Models::VectorStoreConnectorStats'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Gets the details of a work request.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3761

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'GenerativeAiClient#get_work_request') 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::GenerativeAi::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_api_keys(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the ApiKeys of a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only resources that their lifecycle state matches the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the APIKey.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: displayName, timeCreated

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3835

def list_api_keys(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_api_keys.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_api_keys." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::ApiKey::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::ApiKey::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  path = '/apikeys'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_api_keys') 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::GenerativeAi::Models::ApiKeyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_dedicated_ai_clusters(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the dedicated AI clusters in a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the dedicated AI cluster.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName, lifecycleState

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 3928

def list_dedicated_ai_clusters(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_dedicated_ai_clusters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_dedicated_ai_clusters." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::DedicatedAiCluster::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::DedicatedAiCluster::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, lifecycleState.'
  end

  path = '/dedicatedAiClusters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_dedicated_ai_clusters') 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::GenerativeAi::Models::DedicatedAiClusterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_endpoints(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the endpoints of a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only resources that their lifecycle state matches the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the endpoint.

  • :generative_ai_private_endpoint_id (String) —

    The OCID of the private endpoint.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: displayName, timeCreated

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4022

def list_endpoints(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_endpoints.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::Endpoint::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::Endpoint::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  path = '/endpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:generativeAiPrivateEndpointId] = opts[:generative_ai_private_endpoint_id] if opts[:generative_ai_private_endpoint_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_endpoints') 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::GenerativeAi::Models::EndpointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_generative_ai_private_endpoints(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists all Generative AI private endpoints in the specified compartment.

Allowed values are: timeCreated

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :id (String) —

    The OCID of the private endpoint.

  • :lifecycle_state (String) —

    The lifecycle state of Generative AI private endpoints.

  • :sort_by (String) —

    The field used to sort the results. Multiple fields aren't supported. (default to timeCreated)

  • :resource_type (String) —

    Query by the resource type of Generative AI private endpoints.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4120

def list_generative_ai_private_endpoints(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_generative_ai_private_endpoints.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_generative_ai_private_endpoints." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end

  if opts[:resource_type] && !OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint::RESOURCE_TYPE_ENUM.include?(opts[:resource_type])
    raise 'Invalid value for "resource_type", must be one of the values in OCI::GenerativeAi::Models::GenerativeAiPrivateEndpoint::RESOURCE_TYPE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  path = '/generativeAiPrivateEndpoints'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:resourceType] = opts[:resource_type] if opts[:resource_type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'GenerativeAiClient#list_generative_ai_private_endpoints') 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::GenerativeAi::Models::GenerativeAiPrivateEndpointCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_generative_ai_projects(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the generativeAiProjects of a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycle state matches the given value.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the generativeAiProject.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: displayName, timeCreated

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4218

def list_generative_ai_projects(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_generative_ai_projects.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_generative_ai_projects." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::GenerativeAiProject::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::GenerativeAiProject::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  path = '/generativeAiProjects'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_generative_ai_projects') 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::GenerativeAi::Models::GenerativeAiProjectCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_hosted_application_storages(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the hosted application storage in a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state.

  • :hosted_application_storage_type (String) —

    The type of the hosted application storage.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the hosted application storage.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName, lifecycleState

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4312

def list_hosted_application_storages(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_hosted_application_storages.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_hosted_application_storages." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::HostedApplicationStorage::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::HostedApplicationStorage::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:hosted_application_storage_type] && !OCI::GenerativeAi::Models::HostedApplicationStorage::STORAGE_TYPE_ENUM.include?(opts[:hosted_application_storage_type])
    raise 'Invalid value for "hosted_application_storage_type", must be one of the values in OCI::GenerativeAi::Models::HostedApplicationStorage::STORAGE_TYPE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, lifecycleState.'
  end

  path = '/hostedApplicationStorages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:hostedApplicationStorageType] = opts[:hosted_application_storage_type] if opts[:hosted_application_storage_type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_hosted_application_storages') 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::GenerativeAi::Models::HostedApplicationStorageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_hosted_applications(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the hosted applications in a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the hosted application.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName, lifecycleState

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4410

def list_hosted_applications(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_hosted_applications.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_hosted_applications." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::HostedApplicationBase::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::HostedApplicationBase::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, lifecycleState.'
  end

  path = '/hostedApplications'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_hosted_applications') 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::GenerativeAi::Models::HostedApplicationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_hosted_applications_iam(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the hosted applications in a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only the hosted applications that their lifecycle state matches the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the hosted application.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName, lifecycleState

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4503

def list_hosted_applications_iam(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_hosted_applications_iam.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_hosted_applications_iam." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::HostedApplicationBase::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::HostedApplicationBase::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, lifecycleState.'
  end

  path = '/hostedApplicationsIam'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_hosted_applications_iam') 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::GenerativeAi::Models::HostedApplicationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_hosted_deployments(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the hosted applications in a specific compartment. Provide either applicationId or applicationIamId to filter by parent.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :application_id (String) —

    The OCID of the HostedApplication parent.

  • :lifecycle_state (String) —

    A filter to return only the hosted deployments that their lifecycle state matches the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the hosted deployment.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: timeCreated, displayName, lifecycleState

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4597

def list_hosted_deployments(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_hosted_deployments.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_hosted_deployments." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::HostedDeployment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::HostedDeployment::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName lifecycleState].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, lifecycleState.'
  end

  path = '/hostedDeployments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:applicationId] = opts[:application_id] if opts[:application_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_hosted_deployments') 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::GenerativeAi::Models::HostedDeploymentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_imported_models(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists imported models in a specific compartment. Allowed values are: displayName, lifecycleState, timeCreated

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :vendor (String) —

    A filter to return only resources that match the entire vendor given.

  • :capability (Array<String>) —

    A filter to return only resources their capability matches the given capability. Allowed values are: TEXT_TO_TEXT, IMAGE_TEXT_TO_TEXT, EMBEDDING, RERANK, TEXT_TO_IMAGE, IMAGE_TEXT_TO_IMAGE, IMAGE_TEXT_TO_VIDEO, IMAGE_TO_IMAGE, REALTIME, AUDIO_TO_AUDIO, AUDIO_TO_TEXT, TEXT_TO_AUDIO, TEXT_TO_VIDEO

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The ID of the importedModel.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. (default to timeCreated)

Returns:



4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4693

def list_imported_models(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_imported_models.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_imported_models." if compartment_id.nil?


  capability_allowable_values = %w[TEXT_TO_TEXT IMAGE_TEXT_TO_TEXT EMBEDDING RERANK TEXT_TO_IMAGE IMAGE_TEXT_TO_IMAGE IMAGE_TEXT_TO_VIDEO IMAGE_TO_IMAGE REALTIME AUDIO_TO_AUDIO AUDIO_TO_TEXT TEXT_TO_AUDIO TEXT_TO_VIDEO]
  if opts[:capability] && !opts[:capability].empty?
    opts[:capability].each do |val_to_check|
      unless capability_allowable_values.include?(val_to_check)
        raise 'Invalid value for "capability", must be one of TEXT_TO_TEXT, IMAGE_TEXT_TO_TEXT, EMBEDDING, RERANK, TEXT_TO_IMAGE, IMAGE_TEXT_TO_IMAGE, IMAGE_TEXT_TO_VIDEO, IMAGE_TO_IMAGE, REALTIME, AUDIO_TO_AUDIO, AUDIO_TO_TEXT, TEXT_TO_AUDIO, TEXT_TO_VIDEO.'
      end
    end
  end

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::ImportedModel::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::ImportedModel::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName lifecycleState timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, lifecycleState, timeCreated.'
  end

  path = '/importedModels'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vendor] = opts[:vendor] if opts[:vendor]
  query_params[:capability] = OCI::ApiClient.build_collection_params(opts[:capability], :multi) if opts[:capability] && !opts[:capability].empty?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_imported_models') 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::GenerativeAi::Models::ImportedModelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_models(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the models in a specific compartment. Includes pretrained base models and fine-tuned custom models. Allowed values are: displayName, lifecycleState, timeCreated

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :vendor (String) —

    A filter to return only resources that match the entire vendor given.

  • :capability (Array<String>) —

    A filter to return only resources their capability matches the given capability. Allowed values are: TEXT_GENERATION, TEXT_SUMMARIZATION, TEXT_EMBEDDINGS, FINE_TUNE, CHAT, TEXT_RERANK, TEXT_TO_IMAGE, IMAGE_TEXT_TO_IMAGE, IMAGE_TEXT_TO_TEXT, IMAGE_TEXT_TO_VIDEO, IMAGE_TO_IMAGE, REALTIME, AUDIO_TO_AUDIO, AUDIO_TO_TEXT, TEXT_TO_AUDIO, TEXT_TO_VIDEO

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The ID of the model.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. (default to timeCreated)

Returns:



4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4800

def list_models(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_models.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_models." if compartment_id.nil?


  capability_allowable_values = %w[TEXT_GENERATION TEXT_SUMMARIZATION TEXT_EMBEDDINGS FINE_TUNE CHAT TEXT_RERANK TEXT_TO_IMAGE IMAGE_TEXT_TO_IMAGE IMAGE_TEXT_TO_TEXT IMAGE_TEXT_TO_VIDEO IMAGE_TO_IMAGE REALTIME AUDIO_TO_AUDIO AUDIO_TO_TEXT TEXT_TO_AUDIO TEXT_TO_VIDEO]
  if opts[:capability] && !opts[:capability].empty?
    opts[:capability].each do |val_to_check|
      unless capability_allowable_values.include?(val_to_check)
        raise 'Invalid value for "capability", must be one of TEXT_GENERATION, TEXT_SUMMARIZATION, TEXT_EMBEDDINGS, FINE_TUNE, CHAT, TEXT_RERANK, TEXT_TO_IMAGE, IMAGE_TEXT_TO_IMAGE, IMAGE_TEXT_TO_TEXT, IMAGE_TEXT_TO_VIDEO, IMAGE_TO_IMAGE, REALTIME, AUDIO_TO_AUDIO, AUDIO_TO_TEXT, TEXT_TO_AUDIO, TEXT_TO_VIDEO.'
      end
    end
  end

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::Model::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::Model::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName lifecycleState timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, lifecycleState, timeCreated.'
  end

  path = '/models'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vendor] = opts[:vendor] if opts[:vendor]
  query_params[:capability] = OCI::ApiClient.build_collection_params(opts[:capability], :multi) if opts[:capability] && !opts[:capability].empty?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_models') 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::GenerativeAi::Models::ModelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_semantic_stores(opts = {}) ⇒ Response

Note:

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

Lists the SemanticStores given specific filter.

Parameters:

  • 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

  • :compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • :lifecycle_state (Array<String>) —

    A filter to return only resources whose lifecycle state matches the given array. Allowed values are: ACTIVE, CREATING, UPDATING, DELETING, DELETED, FAILED

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :id (String) —

    The OCID of the SemanticStore.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: displayName, timeCreated

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :data_source_querying_connection_id (String) —

    A filter to return only resources whose queryingConnectionId matches with this id.

Returns:



4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 4908

def list_semantic_stores(opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_semantic_stores.' if logger



  lifecycle_state_allowable_values = %w[ACTIVE CREATING UPDATING DELETING DELETED FAILED]
  if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
    opts[:lifecycle_state].each do |val_to_check|
      unless lifecycle_state_allowable_values.include?(val_to_check)
        raise 'Invalid value for "lifecycle_state", must be one of ACTIVE, CREATING, UPDATING, DELETING, DELETED, FAILED.'
      end
    end
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  path = '/semanticStores'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:dataSourceQueryingConnectionId] = opts[:data_source_querying_connection_id] if opts[:data_source_querying_connection_id]

  # 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: 'GenerativeAiClient#list_semantic_stores') 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::GenerativeAi::Models::SemanticStoreCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vector_store_connector_file_sync_ingestion_logs(vector_store_connector_file_sync_id, opts = {}) ⇒ Response

Note:

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

Gets Ingestion logs for a vectorStoreConnectorFileSync operation. Allowed values are: status, fileSize, filePath

Parameters:

  • vector_store_connector_file_sync_id (String) —

    The OCID of the vectorStoreConnectorFileSync.

  • 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

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycle state matches the given value

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for status is ascending. (default to status)

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

Returns:



5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5004

def list_vector_store_connector_file_sync_ingestion_logs(vector_store_connector_file_sync_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_vector_store_connector_file_sync_ingestion_logs.' if logger

  raise "Missing the required parameter 'vector_store_connector_file_sync_id' when calling list_vector_store_connector_file_sync_ingestion_logs." if vector_store_connector_file_sync_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::VectorStoreConnectorFileSync::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::VectorStoreConnectorFileSync::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_by] && !%w[status fileSize filePath].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of status, fileSize, filePath.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'vector_store_connector_file_sync_id' must not be blank" if OCI::Internal::Util.blank_string?(vector_store_connector_file_sync_id)

  path = '/vectorStoreConnectorFileSyncs/{vectorStoreConnectorFileSyncId}/ingestionLogs'.sub('{vectorStoreConnectorFileSyncId}', vector_store_connector_file_sync_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'GenerativeAiClient#list_vector_store_connector_file_sync_ingestion_logs') 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::GenerativeAi::Models::FileSyncIngestionLogsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vector_store_connector_file_syncs(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the vectorStoreConnectorFileSyncs of a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycle state matches the given value

  • :id (String) —

    The OCID of the vectorStoreConnectorFileSync.

  • :vector_store_connector_id (String) —

    The OCID of the VectorStoreConnector.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated) Allowed values are: displayName, timeCreated

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5096

def list_vector_store_connector_file_syncs(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_vector_store_connector_file_syncs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_vector_store_connector_file_syncs." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::VectorStoreConnectorFileSync::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::VectorStoreConnectorFileSync::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated.'
  end

  path = '/vectorStoreConnectorFileSyncs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:vectorStoreConnectorId] = opts[:vector_store_connector_id] if opts[:vector_store_connector_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_vector_store_connector_file_syncs') 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::GenerativeAi::Models::VectorStoreConnectorFileSyncCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vector_store_connector_ingestion_logs(vector_store_connector_id, opts = {}) ⇒ Response

Note:

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

Gets Ingestion logs for a vectorStoreConnector. Allowed values are: status, fileSize, filePath

Parameters:

  • vector_store_connector_id (String) —

    The OCID of the VectorStoreConnector.

  • 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

  • :status (String) —

    A filter to return only the Sync Logs whose status matches the given value.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for status is ascending. (default to status)

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

Returns:



5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5187

def list_vector_store_connector_ingestion_logs(vector_store_connector_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_vector_store_connector_ingestion_logs.' if logger

  raise "Missing the required parameter 'vector_store_connector_id' when calling list_vector_store_connector_ingestion_logs." if vector_store_connector_id.nil?

  if opts[:status] && !OCI::GenerativeAi::Models::VectorStoreConnectorIngestionLogs::STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::GenerativeAi::Models::VectorStoreConnectorIngestionLogs::STATUS_ENUM.'
  end

  if opts[:sort_by] && !%w[status fileSize filePath].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of status, fileSize, filePath.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'vector_store_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(vector_store_connector_id)

  path = '/vectorStoreConnectors/{vectorStoreConnectorId}/ingestionLogs'.sub('{vectorStoreConnectorId}', vector_store_connector_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'GenerativeAiClient#list_vector_store_connector_ingestion_logs') 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::GenerativeAi::Models::VectorStoreConnectorIngestionLogsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vector_store_connectors(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the vectorStoreConnectors of a specific compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :vector_store_id (String) —

    The openai compatible id of the VectorStore.

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycle state matches the given value.

  • :display_name (String) —

    A filter to return only resources that match the given name exactly.

  • :id (String) —

    The OCID of the VectorStoreConnector.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for name is ascending. (default to timeCreated) Allowed values are: name, timeCreated

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5279

def list_vector_store_connectors(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_vector_store_connectors.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_vector_store_connectors." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::GenerativeAi::Models::VectorStoreConnector::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GenerativeAi::Models::VectorStoreConnector::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[name timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, timeCreated.'
  end

  path = '/vectorStoreConnectors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vectorStoreId] = opts[:vector_store_id] if opts[:vector_store_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_vector_store_connectors') 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::GenerativeAi::Models::VectorStoreConnectorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Lists the errors for a work request. Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. (default to timestamp)

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

Returns:



5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5369

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

  if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timestamp.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'GenerativeAiClient#list_work_request_errors') 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::GenerativeAi::Models::WorkRequestErrorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Lists the logs for a work request. Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work request.

  • 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. (default to timestamp)

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

Returns:



5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5451

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

  if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timestamp.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'GenerativeAiClient#list_work_request_logs') 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::GenerativeAi::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the work requests in a compartment. Allowed values are: timeAccepted

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • 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

  • :work_request_id (String) —

    The OCID of the asynchronous work request.

  • :status (String) —

    A filter to return only the resources that match the given lifecycle state.

  • :resource_id (String) —

    The OCID of the resource affected by the work request.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. (default to timeAccepted)

Returns:



5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5536

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

  if opts[:status] && !OCI::GenerativeAi::Models::OPERATION_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::GenerativeAi::Models::OPERATION_STATUS_ENUM.'
  end

  if opts[:sort_order] && !OCI::GenerativeAi::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GenerativeAi::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GenerativeAiClient#list_work_requests') 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::GenerativeAi::Models::WorkRequestSummaryCollection'
    )
  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.



100
101
102
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 100

def logger
  @api_client.config.logger
end

#renew_api_key(api_key_id, renew_api_key_details, opts = {}) ⇒ Response

Note:

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

Renew the primary or secondary key.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:



5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5625

def renew_api_key(api_key_id, renew_api_key_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#renew_api_key.' if logger

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

  path = '/apikeys/{apiKeyId}/actions/renew'.sub('{apiKeyId}', api_key_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]
  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(renew_api_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#renew_api_key') 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::GenerativeAi::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_api_key_state(api_key_id, set_api_key_state_details, opts = {}) ⇒ Response

Note:

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

Set state of the key.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :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 running 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 removed from the system, then a retry of the original creation request might be rejected.

Returns:



5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5699

def set_api_key_state(api_key_id, set_api_key_state_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#set_api_key_state.' if logger

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

  path = '/apikeys/{apiKeyId}/actions/setstate'.sub('{apiKeyId}', api_key_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]
  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(set_api_key_state_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#set_api_key_state') 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::GenerativeAi::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_api_key(api_key_id, update_api_key_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an apiKey.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5767

def update_api_key(api_key_id, update_api_key_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_api_key.' if logger

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

  path = '/apikeys/{apiKeyId}'.sub('{apiKeyId}', api_key_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_api_key_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_api_key') 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::GenerativeAi::Models::ApiKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_dedicated_ai_cluster(dedicated_ai_cluster_id, update_dedicated_ai_cluster_details, opts = {}) ⇒ Response

Note:

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

Updates a dedicated AI cluster.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5833

def update_dedicated_ai_cluster(dedicated_ai_cluster_id, update_dedicated_ai_cluster_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_dedicated_ai_cluster.' if logger

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

  path = '/dedicatedAiClusters/{dedicatedAiClusterId}'.sub('{dedicatedAiClusterId}', dedicated_ai_cluster_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_dedicated_ai_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_dedicated_ai_cluster') 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::GenerativeAi::Models::DedicatedAiCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_endpoint(endpoint_id, update_endpoint_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an endpoint.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5899

def update_endpoint(endpoint_id, update_endpoint_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_endpoint.' if logger

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

  path = '/endpoints/{endpointId}'.sub('{endpointId}', 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[:'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_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_endpoint') 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::GenerativeAi::Models::Endpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_generative_ai_private_endpoint(generative_ai_private_endpoint_id, update_generative_ai_private_endpoint_details, opts = {}) ⇒ Response

Note:

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

Updates a Generative AI private endpoint using a privateEndpointId.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

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

Returns:



5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 5968

def update_generative_ai_private_endpoint(generative_ai_private_endpoint_id, update_generative_ai_private_endpoint_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_generative_ai_private_endpoint.' if logger

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

  path = '/generativeAiPrivateEndpoints/{generativeAiPrivateEndpointId}'.sub('{generativeAiPrivateEndpointId}', generative_ai_private_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-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_generative_ai_private_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_generative_ai_private_endpoint') 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::GenerativeAi::Models::GenerativeAiPrivateEndpoint'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_generative_ai_project(generative_ai_project_id, update_generative_ai_project_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a generativeAiProject.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6034

def update_generative_ai_project(generative_ai_project_id, update_generative_ai_project_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_generative_ai_project.' if logger

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

  path = '/generativeAiProjects/{generativeAiProjectId}'.sub('{generativeAiProjectId}', generative_ai_project_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_generative_ai_project_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_generative_ai_project') 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::GenerativeAi::Models::GenerativeAiProject'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_hosted_application(hosted_application_id, update_hosted_application_details, opts = {}) ⇒ Response

Note:

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

Updates a hosted application.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6100

def update_hosted_application(hosted_application_id, update_hosted_application_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_hosted_application.' if logger

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

  path = '/hostedApplications/{hostedApplicationId}'.sub('{hostedApplicationId}', hosted_application_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_hosted_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_hosted_application') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_hosted_application_iam(hosted_application_iam_id, update_hosted_application_iam_details, opts = {}) ⇒ Response

Note:

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

Updates a hosted application.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6165

def update_hosted_application_iam(hosted_application_iam_id, update_hosted_application_iam_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_hosted_application_iam.' if logger

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

  path = '/hostedApplicationsIam/{hostedApplicationIamId}'.sub('{hostedApplicationIamId}', hosted_application_iam_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_hosted_application_iam_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_hosted_application_iam') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_hosted_deployment(hosted_deployment_id, update_hosted_deployment_details, opts = {}) ⇒ Response

Note:

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

Updates a hosted deployment.

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_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 running 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 removed from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6236

def update_hosted_deployment(hosted_deployment_id, update_hosted_deployment_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_hosted_deployment.' if logger

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

  path = '/hostedDeployments/{hostedDeploymentId}'.sub('{hostedDeploymentId}', hosted_deployment_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-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(update_hosted_deployment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_hosted_deployment') 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::GenerativeAi::Models::HostedDeployment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_imported_model(imported_model_id, update_imported_model_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of an imported model such as name, description, freeform tags, and defined tags.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6304

def update_imported_model(imported_model_id, update_imported_model_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_imported_model.' if logger

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

  path = '/importedModels/{importedModelId}'.sub('{importedModelId}', imported_model_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_imported_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_imported_model') 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::GenerativeAi::Models::ImportedModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_model(model_id, update_model_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6370

def update_model(model_id, update_model_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_model.' if logger

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

  path = '/models/{modelId}'.sub('{modelId}', model_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_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_model') 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::GenerativeAi::Models::Model'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_semantic_store(semantic_store_id, update_semantic_store_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a SemanticStore.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6436

def update_semantic_store(semantic_store_id, update_semantic_store_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_semantic_store.' if logger

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

  path = '/semanticStores/{semanticStoreId}'.sub('{semanticStoreId}', semantic_store_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_semantic_store_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_semantic_store') 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::GenerativeAi::Models::SemanticStore'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vector_store_connector(vector_store_connector_id, update_vector_store_connector_details, opts = {}) ⇒ Response

Note:

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

Updates the properties of a vectorStoreConnector.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
 
# File 'lib/oci/generative_ai/generative_ai_client.rb', line 6502

def update_vector_store_connector(vector_store_connector_id, update_vector_store_connector_details, opts = {})
  logger.debug 'Calling operation GenerativeAiClient#update_vector_store_connector.' if logger

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

  path = '/vectorStoreConnectors/{vectorStoreConnectorId}'.sub('{vectorStoreConnectorId}', vector_store_connector_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_vector_store_connector_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GenerativeAiClient#update_vector_store_connector') 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::GenerativeAi::Models::VectorStoreConnector'
    )
  end
  # rubocop:enable Metrics/BlockLength
end