GenerativeAiClient

class oci.generative_ai.GenerativeAiClient(config, **kwargs)

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](#/en/generative-ai/latest/DedicatedAiCluster/), [endpoints](#/en/generative-ai/latest/Endpoint/), [custom models](#/en/generative-ai/latest/Model/), and [work requests](#/en/generative-ai/latest/WorkRequest/) 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](/iaas/api/#/en/generative-ai-inference/latest/).

To learn more about the service, see the [Generative AI documentation](/iaas/Content/generative-ai/home.htm).

Methods:

__init__(config, **kwargs)	Creates a new service client
add_artifact(add_artifact_details, ...)	add image with isAutoDeploy flag.
cancel_vector_store_connector_file_sync(...)	Cancels a vectorStoreConnectorFileSync.
change_api_key_compartment(api_key_id, ...)	Moves an API key into a different compartment within the same tenancy.
change_dedicated_ai_cluster_compartment(...)	Moves a dedicated AI cluster into a different compartment within the same tenancy.
change_endpoint_compartment(endpoint_id, ...)	Moves an endpoint into a different compartment within the same tenancy.
change_generative_ai_private_endpoint_compartment(...)	Moves a Generative AI private endpoint into a different compartment.
change_generative_ai_project_compartment(...)	Moves a generativeAiProject into a different compartment within the same tenancy.
change_hosted_application_compartment(...)	Moves a hosted application into a different compartment within the same tenancy.
change_hosted_application_iam_compartment(...)	Moves a hosted application into a different compartment within the same tenancy.
change_hosted_application_storage_compartment(...)	Moves a hosted application storage into a different compartment within the same tenancy.
change_imported_model_compartment(...)	Moves an imported model into a different compartment.
change_model_compartment(model_id, ...)	Moves a custom model into a different compartment.
change_routing_profile_compartment(...)	Moves a routing profile into a different compartment within the same tenancy.
change_semantic_store_compartment(...)	Moves a SemanticStore into a different compartment within the same tenancy.
create_api_key(create_api_key_details, **kwargs)	Creates a new API key in the specified compartment.
create_dedicated_ai_cluster(...)	Creates a dedicated AI cluster.
create_endpoint(create_endpoint_details, ...)	Creates an endpoint.
create_generative_ai_private_endpoint(...)	Creates a Generative AI private endpoint.
create_generative_ai_project(...)	Creates a GenerativeAiProject.
create_hosted_application(...)	Creates a hosted application.
create_hosted_application_iam(...)	Creates a hosted application.
create_hosted_application_storage(...)	Creates a hosted application storage.
create_hosted_deployment(...)	Creates a hosted deployment.
create_imported_model(...)	Import a model from ModelDataSource.
create_model(create_model_details, **kwargs)	Creates a custom model by fine-tuning a base model with your own dataset.
create_routing_profile(...)	Creates a routing profile.
create_sandbox_warm_pool(project_id, ...)	Creates a named MANAGED or CUSTOM pool.
create_semantic_store(...)	Creates a SemanticStore.
create_vector_store_connector(...)	Creates a VectorStoreConnector.
create_vector_store_connector_file_sync(...)	Creates a File Sync operation for a VectorStoreConnector.
delete_api_key(api_key_id, **kwargs)	Deletes an API key.
delete_dedicated_ai_cluster(...)	Deletes a dedicated AI cluster.
delete_endpoint(endpoint_id, **kwargs)	Deletes an endpoint.
delete_generative_ai_private_endpoint(...)	Deletes a Generative AI private endpoint using privateEndpointId.
delete_generative_ai_project(...)	Deletes a generativeAiProject.
delete_hosted_application(...)	Deletes a hosted application.
delete_hosted_application_iam(...)	Deletes a hosted application.
delete_hosted_application_storage(...)	Deletes a hosted application.
delete_hosted_deployment(...)	Deletes a hosted deployment.
delete_hosted_deployment_artifact(...)	delete artifact.
delete_imported_model(imported_model_id, ...)	Deletes an imported model.
delete_model(model_id, **kwargs)	Deletes a custom model.
delete_routing_profile(routing_profile_id, ...)	Deletes a routing profile.
delete_sandbox_warm_pool(project_id, name, ...)	Deletes a named MANAGED or CUSTOM pool through a CP Work Request.
delete_semantic_store(semantic_store_id, ...)	Deletes a semanticStore.
delete_vector_store_connector(...)	Deletes a vectorStoreConnector.
get_api_key(api_key_id, **kwargs)	Gets information about an API key.
get_dedicated_ai_cluster(...)	Gets information about a dedicated AI cluster.
get_endpoint(endpoint_id, **kwargs)	Gets information about an endpoint.
get_generative_ai_private_endpoint(...)	Retrieves an Generative AI private endpoint using a privateEndpointId.
get_generative_ai_project(...)	Gets information about a generativeAiProject.
get_hosted_application(...)	Gets information about a hosted application.
get_hosted_application_iam(...)	Gets information about a hosted application.
get_hosted_application_storage(...)	Gets information about a hosted application storage.
get_hosted_deployment(hosted_deployment_id, ...)	Gets information about a hosted deployment.
get_imported_model(imported_model_id, **kwargs)	Gets information about an imported model.
get_model(model_id, **kwargs)	Gets information about a custom model.
get_routing_profile(routing_profile_id, **kwargs)	Gets information about a routing profile.
get_sandbox_warm_pool(project_id, name, **kwargs)	Gets authoritative CP configuration and management lifecycle for the current pool incarnation, including DELETING until pool cleanup completes.
get_semantic_store(semantic_store_id, **kwargs)	Gets information about a semanticStore.
get_vector_store_connector(...)	Gets information about a vectorStoreConnector.
get_vector_store_connector_file_sync(...)	Gets information about a vectorStoreConnectorFileSync.
get_vector_store_connector_stats(...)	Gets Sync statistics from a vectorStoreConnector.
get_work_request(work_request_id, **kwargs)	Gets the details of a work request.
list_api_keys(compartment_id, **kwargs)	Lists the ApiKeys of a specific compartment.
list_dedicated_ai_clusters(compartment_id, ...)	Lists the dedicated AI clusters in a specific compartment.
list_dedicated_ai_clusters_allocatable_gpus(...)	Lists the allocatable GPUs for launching dedicated AI clusters tied to a specific capacity reservation id.
list_endpoints(compartment_id, **kwargs)	Lists the endpoints of a specific compartment.
list_generative_ai_private_endpoints(...)	Lists all Generative AI private endpoints in the specified compartment.
list_generative_ai_projects(compartment_id, ...)	Lists the generativeAiProjects of a specific compartment.
list_hosted_application_storages(...)	Lists the hosted application storage in a specific compartment.
list_hosted_applications(compartment_id, ...)	Lists the hosted applications in a specific compartment.
list_hosted_applications_iam(compartment_id, ...)	Lists the hosted applications in a specific compartment.
list_hosted_deployments(compartment_id, **kwargs)	Lists the hosted applications in a specific compartment.
list_imported_models(compartment_id, **kwargs)	Lists imported models in a specific compartment.
list_model_discovery(compartment_id, **kwargs)	Retrieves a list of models along with their capabilities, supported features, and deployment availability.
list_models(compartment_id, **kwargs)	Lists the models in a specific compartment.
list_routing_profiles(compartment_id, **kwargs)	Lists the routing profiles of a specific compartment.
list_sandbox_warm_pools(project_id, **kwargs)	Lists named MANAGED and CUSTOM pools for Sandbox-enabled Projects, including zero targets and in-progress management operations.
list_semantic_stores(**kwargs)	Lists the SemanticStores given specific filter.
list_vector_store_connector_file_sync_ingestion_logs(...)	Gets Ingestion logs for a vectorStoreConnectorFileSync operation.
list_vector_store_connector_file_syncs(...)	Lists the vectorStoreConnectorFileSyncs of a specific compartment.
list_vector_store_connector_ingestion_logs(...)	Gets Ingestion logs for a vectorStoreConnector.
list_vector_store_connectors(compartment_id, ...)	Lists the vectorStoreConnectors of a specific compartment.
list_work_request_errors(work_request_id, ...)	Lists the errors for a work request.
list_work_request_logs(work_request_id, **kwargs)	Lists the logs for a work request.
list_work_requests(compartment_id, **kwargs)	Lists the work requests in a compartment.
renew_api_key(api_key_id, ...)	Renew the primary or secondary key.
set_api_key_state(api_key_id, ...)	Set state of the key.
update_api_key(api_key_id, ...)	Updates the properties of an apiKey.
update_dedicated_ai_cluster(...)	Updates a dedicated AI cluster.
update_endpoint(endpoint_id, ...)	Updates the properties of an endpoint.
update_generative_ai_private_endpoint(...)	Updates a Generative AI private endpoint using a privateEndpointId.
update_generative_ai_project(...)	Updates the properties of a generativeAiProject.
update_hosted_application(...)	Updates a hosted application.
update_hosted_application_iam(...)	Updates a hosted application.
update_hosted_deployment(...)	Updates a hosted deployment.
update_imported_model(imported_model_id, ...)	Updates the properties of an imported model such as name, description, freeform tags, and defined tags.
update_model(model_id, update_model_details, ...)	Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.
update_routing_profile(routing_profile_id, ...)	Updates the properties of a routing profile.
update_sandbox_warm_pool(project_id, name, ...)	Only desiredCapacity may change.
update_semantic_store(semantic_store_id, ...)	Updates the properties of a SemanticStore.
update_vector_store_connector(...)	Updates the properties of a vectorStoreConnector.

__init__(config, **kwargs)

Creates a new service client

Parameters

• config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()

• service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.

• timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.

• signer (AbstractBaseSigner) –

  (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

  One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

• retry_strategy (obj) –

  (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

  This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

• circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.

• circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.

• client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.

• allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

• enable_strict_url_encoding – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this client should enable strict url encoding in path params of a request. By default, the client will not enable strict url encoding

add_artifact(add_artifact_details, hosted_deployment_id, **kwargs)

add image with isAutoDeploy flag.

Parameters

• add_artifact_details (oci.generative_ai.models.AddArtifactDetails) – (required) Details for the new artifact.

• hosted_deployment_id (str) –

  (required) The OCID of the hosted deployment.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

cancel_vector_store_connector_file_sync(vector_store_connector_file_sync_id, **kwargs)

Cancels a vectorStoreConnectorFileSync.

Parameters

• vector_store_connector_file_sync_id (str) –

  (required) The OCID of the vectorStoreConnectorFileSync.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_api_key_compartment(api_key_id, change_api_key_compartment_details, **kwargs)

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

• api_key_id (str) –

  (required) The OCID of the APIKey.

• change_api_key_compartment_details (oci.generative_ai.models.ChangeApiKeyCompartmentDetails) – (required) The API key information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_dedicated_ai_cluster_compartment(dedicated_ai_cluster_id, change_dedicated_ai_cluster_compartment_details, **kwargs)

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

• dedicated_ai_cluster_id (str) –

  (required) The OCID of the dedicated AI cluster.

• change_dedicated_ai_cluster_compartment_details (oci.generative_ai.models.ChangeDedicatedAiClusterCompartmentDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_endpoint_compartment(endpoint_id, change_endpoint_compartment_details, **kwargs)

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

• endpoint_id (str) –

  (required) The OCID of the endpoint.

• change_endpoint_compartment_details (oci.generative_ai.models.ChangeEndpointCompartmentDetails) – (required) The endpoint information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_generative_ai_private_endpoint_compartment(generative_ai_private_endpoint_id, change_generative_ai_private_endpoint_compartment_details, **kwargs)

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

Parameters

• generative_ai_private_endpoint_id (str) – (required) The unique id for a Generative AI private endpoint.

• change_generative_ai_private_endpoint_compartment_details (oci.generative_ai.models.ChangeGenerativeAiPrivateEndpointCompartmentDetails) – (required) Details for changing a Generative AI private endpoint’s compartment.

• opc_request_id (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_generative_ai_project_compartment(generative_ai_project_id, change_generative_ai_project_compartment_details, **kwargs)

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

• generative_ai_project_id (str) –

  (required) The OCID of the generativeAiProject.

• change_generative_ai_project_compartment_details (oci.generative_ai.models.ChangeGenerativeAiProjectCompartmentDetails) – (required) The generativeAiProject information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_hosted_application_compartment(hosted_application_id, change_hosted_application_compartment_details, **kwargs)

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

• hosted_application_id (str) –

  (required) The OCID of the hosted application.

• change_hosted_application_compartment_details (oci.generative_ai.models.ChangeHostedApplicationCompartmentDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_hosted_application_iam_compartment(hosted_application_iam_id, change_hosted_application_compartment_details, **kwargs)

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

• hosted_application_iam_id (str) –

  (required) The OCID of the hosted application.

• change_hosted_application_compartment_details (oci.generative_ai.models.ChangeHostedApplicationCompartmentDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_hosted_application_storage_compartment(hosted_application_storage_id, change_hosted_application_storage_compartment_details, **kwargs)

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

• hosted_application_storage_id (str) –

  (required) The OCID of the hosted application storage.

• change_hosted_application_storage_compartment_details (oci.generative_ai.models.ChangeHostedApplicationStorageCompartmentDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_imported_model_compartment(imported_model_id, change_imported_model_compartment_details, **kwargs)

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

Parameters

• imported_model_id (str) – (required) The importedModel OCID

• change_imported_model_compartment_details (oci.generative_ai.models.ChangeImportedModelCompartmentDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_model_compartment(model_id, change_model_compartment_details, **kwargs)

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

Parameters

• model_id (str) – (required) The model OCID

• change_model_compartment_details (oci.generative_ai.models.ChangeModelCompartmentDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_routing_profile_compartment(routing_profile_id, change_routing_profile_compartment_details, **kwargs)

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

Parameters

• routing_profile_id (str) –

  (required) The OCID of the routing profile.

• change_routing_profile_compartment_details (oci.generative_ai.models.ChangeRoutingProfileCompartmentDetails) – (required) The routing profile information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

change_semantic_store_compartment(semantic_store_id, change_semantic_store_compartment_details, **kwargs)

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

• semantic_store_id (str) –

  (required) The OCID of the SemanticStore.

• change_semantic_store_compartment_details (oci.generative_ai.models.ChangeSemanticStoreCompartmentDetails) – (required) The SemanticStore information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

create_api_key(create_api_key_details, **kwargs)

Creates a new API key in the specified compartment.

Parameters

• create_api_key_details (oci.generative_ai.models.CreateApiKeyDetails) – (required) Details for the new apiKey.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ApiKey

Return type

Response

Example

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

create_dedicated_ai_cluster(create_dedicated_ai_cluster_details, **kwargs)

Creates a dedicated AI cluster.

Parameters

• create_dedicated_ai_cluster_details (oci.generative_ai.models.CreateDedicatedAiClusterDetails) – (required) Details for the new dedicated AI cluster.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type DedicatedAiCluster

Return type

Response

Example

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

create_endpoint(create_endpoint_details, **kwargs)

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

• create_endpoint_details (oci.generative_ai.models.CreateEndpointDetails) – (required) Details for the new endpoint.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Endpoint

Return type

Response

Example

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

create_generative_ai_private_endpoint(create_generative_ai_private_endpoint_details, **kwargs)

Creates a Generative AI private endpoint.

Parameters

• create_generative_ai_private_endpoint_details (oci.generative_ai.models.CreateGenerativeAiPrivateEndpointDetails) – (required) The parameters required to create a private endpoint.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiPrivateEndpoint

Return type

Response

Example

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

create_generative_ai_project(create_generative_ai_project_details, **kwargs)

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

• create_generative_ai_project_details (oci.generative_ai.models.CreateGenerativeAiProjectDetails) – (required) Details for the new generativeAiProject.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiProject

Return type

Response

Example

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

create_hosted_application(create_hosted_application_details, **kwargs)

Creates a hosted application.

Parameters

• create_hosted_application_details (oci.generative_ai.models.CreateHostedApplicationDetails) – (required) Details for the new hosted application.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplication

Return type

Response

Example

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

create_hosted_application_iam(create_hosted_application_iam_details, **kwargs)

Creates a hosted application.

Parameters

• create_hosted_application_iam_details (oci.generative_ai.models.CreateHostedApplicationIamDetails) – (required) Details for the new hosted application.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplicationIam

Return type

Response

Example

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

create_hosted_application_storage(create_hosted_application_storage_details, **kwargs)

Creates a hosted application storage.

Parameters

• create_hosted_application_storage_details (oci.generative_ai.models.CreateHostedApplicationStorageDetails) – (required) Details for the new hosted application storage.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplicationStorage

Return type

Response

Example

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

create_hosted_deployment(create_hosted_deployment_details, **kwargs)

Creates a hosted deployment.

Parameters

• create_hosted_deployment_details (oci.generative_ai.models.CreateHostedDeploymentDetails) – (required) Details for the new hosted deployment.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedDeployment

Return type

Response

Example

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

create_imported_model(create_imported_model_details, **kwargs)

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

• create_imported_model_details (oci.generative_ai.models.CreateImportedModelDetails) – (required) Details for importing a model.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ImportedModel

Return type

Response

Example

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

create_model(create_model_details, **kwargs)

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

• create_model_details (oci.generative_ai.models.CreateModelDetails) – (required) Details for the new model.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Model

Return type

Response

Example

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

create_routing_profile(create_routing_profile_details, **kwargs)

Creates a routing profile.

Parameters

• create_routing_profile_details (oci.generative_ai.models.CreateRoutingProfileDetails) – (required) Details for the new routing profile.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type RoutingProfile

Return type

Response

Example

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

create_sandbox_warm_pool(project_id, create_sandbox_warm_pool_details, **kwargs)

Creates a named MANAGED or CUSTOM pool. MANAGED uses the service-provided python-3.11 runtime and requires containerImage to be omitted. CUSTOM requires a digest-pinned containerImage. Project-wide shape capacity limits include named pools of both types and reserved default pools. Type, image, shape and name are immutable. The CP atomically persists CREATING and a Work Request, then its workflow prepares an immutable pool-owned template and applies the pool configuration. Each MANAGED pool has a distinct template based on the service runtime configuration, isolated from other pools of the same shape. ACTIVE means configuration was applied and verified; it does not require ready members, a successful image boot or available cluster capacity. Zero capacity pauses idle prewarming. An ACTIVE named pool can still create Sandboxes through cold fallback when its applied template is available. Retry identity and configuration are persisted atomically. Within the 24-hour retry-token validity period, the same token and input identify the original pool id, including after name reuse. A retry never creates or selects a replacement pool. A retry after the original pool is deleted returns 409; changed input with the same token conflicts. Reserved default names cannot be reused for either type.

Parameters

• project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.

• create_sandbox_warm_pool_details (oci.generative_ai.models.CreateSandboxWarmPoolDetails) – (required) Desired warm-pool configuration to persist.

• opc_request_id (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SandboxWarmPool

Return type

Response

Example

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

create_semantic_store(create_semantic_store_details, **kwargs)

Creates a SemanticStore.

Parameters

• create_semantic_store_details (oci.generative_ai.models.CreateSemanticStoreDetails) – (required) Details for the new SemanticStore.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SemanticStore

Return type

Response

Example

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

create_vector_store_connector(create_vector_store_connector_details, **kwargs)

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

• create_vector_store_connector_details (oci.generative_ai.models.CreateVectorStoreConnectorDetails) – (required) Details for the new vectorStoreConnector.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnector

Return type

Response

Example

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

create_vector_store_connector_file_sync(create_vector_store_connector_file_sync_details, **kwargs)

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

• create_vector_store_connector_file_sync_details (oci.generative_ai.models.CreateVectorStoreConnectorFileSyncDetails) – (required) Details for the new vectorStoreConnectorFileSync.

• opc_retry_token (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnectorFileSync

Return type

Response

Example

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

delete_api_key(api_key_id, **kwargs)

Deletes an API key.

Parameters

• api_key_id (str) –

  (required) The OCID of the APIKey.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_dedicated_ai_cluster(dedicated_ai_cluster_id, **kwargs)

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 (str) –

  (required) The OCID of the dedicated AI cluster.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_endpoint(endpoint_id, **kwargs)

Deletes an endpoint.

Parameters

• endpoint_id (str) –

  (required) The OCID of the endpoint.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_generative_ai_private_endpoint(generative_ai_private_endpoint_id, **kwargs)

Deletes a Generative AI private endpoint using privateEndpointId.

Parameters

• generative_ai_private_endpoint_id (str) – (required) The unique id for a Generative AI private endpoint.

• opc_request_id (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_generative_ai_project(generative_ai_project_id, **kwargs)

Deletes a generativeAiProject.

Parameters

• generative_ai_project_id (str) –

  (required) The OCID of the generativeAiProject.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_hosted_application(hosted_application_id, **kwargs)

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 (str) –

  (required) The OCID of the hosted application.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_hosted_application_iam(hosted_application_iam_id, **kwargs)

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 (str) –

  (required) The OCID of the hosted application.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_hosted_application_storage(hosted_application_storage_id, **kwargs)

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 (str) –

  (required) The OCID of the hosted application storage.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_hosted_deployment(hosted_deployment_id, **kwargs)

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 (str) –

  (required) The OCID of the hosted deployment.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_hosted_deployment_artifact(hosted_deployment_id, artifact_id, **kwargs)

delete artifact.

Parameters

• hosted_deployment_id (str) –

  (required) The OCID of the hosted deployment.

• artifact_id (str) – (required) The id of the artifact.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_imported_model(imported_model_id, **kwargs)

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 (str) – (required) The importedModel OCID

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_model(model_id, **kwargs)

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 (str) – (required) The model OCID

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_routing_profile(routing_profile_id, **kwargs)

Deletes a routing profile.

Parameters

• routing_profile_id (str) –

  (required) The OCID of the routing profile.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_sandbox_warm_pool(project_id, name, **kwargs)

Deletes a named MANAGED or CUSTOM pool through a CP Work Request. Reserved MANAGED default entries cannot be deleted and return 409. CP persists DELETING and closes admission as the new configuration propagates, drains idle members and deletes the pool resource. The management response does not promise immediate global admission closure or completed cleanup. Already-adopted customer Sandboxes survive and retain required template dependencies. Get and List continue to show DELETING until pool cleanup completes. The CP then records DELETED and releases the name. Name reuse always allocates a new id and materialized names. Retained templates may outlive the pool while customer Sandboxes still depend on them. A repeated delete during DELETING returns the existing Work Request. A missing name returns 404. After name reuse, the path identifies the new pool; use the original if-match ETag to prevent deleting it. Conflicting operations return 409 and stale if-match returns 412.

Parameters

• project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.

• name (str) – (required) Immutable name within the Project.

• opc_request_id (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_semantic_store(semantic_store_id, **kwargs)

Deletes a semanticStore.

Parameters

• semantic_store_id (str) –

  (required) The OCID of the SemanticStore.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

delete_vector_store_connector(vector_store_connector_id, **kwargs)

Deletes a vectorStoreConnector.

Parameters

• vector_store_connector_id (str) –

  (required) The OCID of the VectorStoreConnector.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

get_api_key(api_key_id, **kwargs)

Gets information about an API key.

Parameters

• api_key_id (str) –

  (required) The OCID of the APIKey.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ApiKey

Return type

Response

Example

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

get_dedicated_ai_cluster(dedicated_ai_cluster_id, **kwargs)

Gets information about a dedicated AI cluster.

Parameters

• dedicated_ai_cluster_id (str) –

  (required) The OCID of the dedicated AI cluster.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type DedicatedAiCluster

Return type

Response

Example

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

get_endpoint(endpoint_id, **kwargs)

Gets information about an endpoint.

Parameters

• endpoint_id (str) –

  (required) The OCID of the endpoint.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Endpoint

Return type

Response

Example

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

get_generative_ai_private_endpoint(generative_ai_private_endpoint_id, **kwargs)

Retrieves an Generative AI private endpoint using a privateEndpointId.

Parameters

• generative_ai_private_endpoint_id (str) – (required) The unique id for a Generative AI private endpoint.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiPrivateEndpoint

Return type

Response

Example

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

get_generative_ai_project(generative_ai_project_id, **kwargs)

Gets information about a generativeAiProject.

Parameters

• generative_ai_project_id (str) –

  (required) The OCID of the generativeAiProject.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiProject

Return type

Response

Example

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

get_hosted_application(hosted_application_id, **kwargs)

Gets information about a hosted application.

Parameters

• hosted_application_id (str) –

  (required) The OCID of the hosted application.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplication

Return type

Response

Example

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

get_hosted_application_iam(hosted_application_iam_id, **kwargs)

Gets information about a hosted application.

Parameters

• hosted_application_iam_id (str) –

  (required) The OCID of the hosted application.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplicationIam

Return type

Response

Example

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

get_hosted_application_storage(hosted_application_storage_id, **kwargs)

Gets information about a hosted application storage.

Parameters

• hosted_application_storage_id (str) –

  (required) The OCID of the hosted application storage.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplicationStorage

Return type

Response

Example

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

get_hosted_deployment(hosted_deployment_id, **kwargs)

Gets information about a hosted deployment.

Parameters

• hosted_deployment_id (str) –

  (required) The OCID of the hosted deployment.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedDeployment

Return type

Response

Example

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

get_imported_model(imported_model_id, **kwargs)

Gets information about an imported model.

Parameters

• imported_model_id (str) – (required) The importedModel OCID

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ImportedModel

Return type

Response

Example

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

get_model(model_id, **kwargs)

Gets information about a custom model.

Parameters

• model_id (str) – (required) The model OCID

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Model

Return type

Response

Example

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

get_routing_profile(routing_profile_id, **kwargs)

Gets information about a routing profile.

Parameters

• routing_profile_id (str) –

  (required) The OCID of the routing profile.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type RoutingProfile

Return type

Response

Example

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

get_sandbox_warm_pool(project_id, name, **kwargs)

Gets authoritative CP configuration and management lifecycle for the current pool incarnation, including DELETING until pool cleanup completes. Returns 404 after deletion completes unless the name has been reused for a new id. A best-effort runtime observation may report ready idle capacity. A runtime read failure returns UNAVAILABLE without failing the configuration read. ACTIVE does not imply runtime capacity is ready. The configuration ETag excludes runtime changes; it must not be used to suppress runtime observations with a conditional not-modified response.

Parameters

• project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.

• name (str) – (required) Immutable name within the Project.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SandboxWarmPool

Return type

Response

Example

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

get_semantic_store(semantic_store_id, **kwargs)

Gets information about a semanticStore.

Parameters

• semantic_store_id (str) –

  (required) The OCID of the SemanticStore.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SemanticStore

Return type

Response

Example

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

get_vector_store_connector(vector_store_connector_id, **kwargs)

Gets information about a vectorStoreConnector.

Parameters

• vector_store_connector_id (str) –

  (required) The OCID of the VectorStoreConnector.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnector

Return type

Response

Example

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

get_vector_store_connector_file_sync(vector_store_connector_file_sync_id, **kwargs)

Gets information about a vectorStoreConnectorFileSync.

Parameters

• vector_store_connector_file_sync_id (str) –

  (required) The OCID of the vectorStoreConnectorFileSync.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnectorFileSync

Return type

Response

Example

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

get_vector_store_connector_stats(vector_store_connector_id, **kwargs)

Gets Sync statistics from a vectorStoreConnector.

Parameters

• vector_store_connector_id (str) –

  (required) The OCID of the VectorStoreConnector.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnectorStats

Return type

Response

Example

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

get_work_request(work_request_id, **kwargs)

Gets the details of a work request.

Parameters

• work_request_id (str) –

  (required) The OCID of the asynchronous work request.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequest

Return type

Response

Example

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

list_api_keys(compartment_id, **kwargs)

Lists the ApiKeys of a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the APIKey.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “timeCreated”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ApiKeyCollection

Return type

Response

Example

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

list_dedicated_ai_clusters(compartment_id, **kwargs)

Lists the dedicated AI clusters in a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the dedicated AI cluster.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “timeCreated”, “displayName”, “lifecycleState”

• capacity_reservation_id (str) –

  (optional) The OCID of the capacity reservation.

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type DedicatedAiClusterCollection

Return type

Response

Example

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

list_dedicated_ai_clusters_allocatable_gpus(compartment_id, capacity_reservation_id, **kwargs)

Lists the allocatable GPUs for launching dedicated AI clusters tied to a specific capacity reservation id.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• capacity_reservation_id (str) –

  (required) The OCID of the capacity reservation.

• compute_shape (str) – (optional) The compute shape to use to filter allocatable GPUs. For example, BM.GPU.A10.4.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type AllocatableGpuCollection

Return type

Response

Example

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

list_endpoints(compartment_id, **kwargs)

Lists the endpoints of a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the endpoint.

• generative_ai_private_endpoint_id (str) –

  (optional) The OCID of the private endpoint.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “timeCreated”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type EndpointCollection

Return type

Response

Example

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

list_generative_ai_private_endpoints(compartment_id, **kwargs)

Lists all Generative AI private endpoints in the specified compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• id (str) –

  (optional) The OCID of the private endpoint.

• lifecycle_state (str) –

  (optional) The lifecycle state of Generative AI private endpoints.

  Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• sort_by (str) –

  (optional) The field used to sort the results. Multiple fields aren’t supported.

  Allowed values are: “timeCreated”

• resource_type (str) –

  (optional) Query by the resource type of Generative AI private endpoints.

  Allowed values are: “APPLICATION”, “ENDPOINT”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiPrivateEndpointCollection

Return type

Response

Example

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

list_generative_ai_projects(compartment_id, **kwargs)

Lists the generativeAiProjects of a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the generativeAiProject.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “timeCreated”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiProjectCollection

Return type

Response

Example

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

list_hosted_application_storages(compartment_id, **kwargs)

Lists the hosted application storage in a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• hosted_application_storage_type (str) –

  (optional) The type of the hosted application storage.

  Allowed values are: “CACHE”, “POSTGRESQL”, “ADB”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the hosted application storage.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “timeCreated”, “displayName”, “lifecycleState”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplicationStorageCollection

Return type

Response

Example

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

list_hosted_applications(compartment_id, **kwargs)

Lists the hosted applications in a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the hosted application.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “timeCreated”, “displayName”, “lifecycleState”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplicationCollection

Return type

Response

Example

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

list_hosted_applications_iam(compartment_id, **kwargs)

Lists the hosted applications in a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the hosted application.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “timeCreated”, “displayName”, “lifecycleState”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedApplicationCollection

Return type

Response

Example

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

list_hosted_deployments(compartment_id, **kwargs)

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

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• application_id (str) –

  (optional) The OCID of the HostedApplication parent.

• lifecycle_state (str) –

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

  Allowed values are: “CREATING”, “NEEDS_ATTENTION”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the hosted deployment.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “timeCreated”, “displayName”, “lifecycleState”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedDeploymentCollection

Return type

Response

Example

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

list_imported_models(compartment_id, **kwargs)

Lists imported models in a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• opc_request_id (str) – (optional) 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 (str) – (optional) A filter to return only resources that match the entire vendor given.

• capability (list[str]) –

  (optional) 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”, “AUDIO_TEXT_TO_TEXT”, “AUDIO_TRANSLATION”, “VIDEO_TEXT_TO_TEXT”

• lifecycle_state (str) –

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

  Allowed values are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) – (optional) The ID of the importedModel.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “lifecycleState”, “timeCreated”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ImportedModelCollection

Return type

Response

Example

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

list_model_discovery(compartment_id, **kwargs)

Retrieves a list of models along with their capabilities, supported features, and deployment availability. Results can be filtered by attributes such as region, realm, model identifier, supported inference APIs, serving modes, and access type.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• realm (list[str]) – (optional) A filter to return only resources whose realm matches the given realm.

• region (list[str]) – (optional) A filter to return only resources whose region matches the given region.

• model_id (str) – (optional) A filter to return only resources whose model identifier matches the given modelId.

• serving_mode (list[str]) –

  (optional) A filter to return only resources whose serving modes match the given servingModes.

  Allowed values are: “ON_DEMAND”, “DEDICATED”

• api_capability (list[str]) – (optional) Filter models that support any of the specified API capabilities.

• capability (list[str]) –

  (optional) 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”, “AUDIO_TEXT_TO_TEXT”, “AUDIO_TRANSLATION”, “VIDEO_TEXT_TO_TEXT”

• model_access (list[str]) –

  (optional) Filter models by access type.

  Allowed values are: “HOSTED”, “PROXY”

• is_deprecated (bool) – (optional) If true, return only deprecated models; if false, exclude deprecated models.

• is_on_demand_retired (bool) – (optional) Filter models based on on-demand retirement status.

• is_dedicated_retired (bool) – (optional) Filter models based on dedicated retirement status.

• opc_request_id (str) – (optional) 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.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ModelDiscoveryCollection

Return type

Response

Example

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

list_models(compartment_id, **kwargs)

Lists the models in a specific compartment. Includes pretrained base models and fine-tuned custom models.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• opc_request_id (str) – (optional) 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 (str) – (optional) A filter to return only resources that match the entire vendor given.

• capability (list[str]) –

  (optional) 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”, “AUDIO_TEXT_TO_TEXT”, “AUDIO_TRANSLATION”, “VIDEO_TEXT_TO_TEXT”

• lifecycle_state (str) –

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

  Allowed values are: “ACTIVE”, “CREATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) – (optional) The ID of the model.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “lifecycleState”, “timeCreated”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ModelCollection

Return type

Response

Example

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

list_routing_profiles(compartment_id, **kwargs)

Lists the routing profiles of a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the routing profile.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “timeCreated”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type RoutingProfileCollection

Return type

Response

Example

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

list_sandbox_warm_pools(project_id, **kwargs)

Lists named MANAGED and CUSTOM pools for Sandbox-enabled Projects, including zero targets and in-progress management operations. Reserved defaults can be resized but cannot be created or deleted by customers. DELETED resources are excluded. Responses include CP management lifecycle but do not perform runtime reads or return ready capacity.

Parameters

• project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.

• opc_request_id (str) – (optional) 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.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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.

• name (str) – (optional) Exact name filter.

• type (str) –

  (optional) Filter by type.

  Allowed values are: “MANAGED”, “CUSTOM”

• shape (str) –

  (optional) Filter by shape.

  Allowed values are: “SMALL”, “MEDIUM”, “LARGE”

• sort_by (str) –

  (optional) Filter by sortBy.

  Allowed values are: “timeCreated”, “name”

• sort_order (str) –

  (optional) Filter by sortOrder.

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SandboxWarmPoolCollection

Return type

Response

Example

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

list_semantic_stores(**kwargs)

Lists the SemanticStores given specific filter.

Parameters

• compartment_id (str) –

  (optional) The OCID of the compartment in which to list resources.

• lifecycle_state (list[str]) –

  (optional) A filter to return only resources whose lifecycle state matches the given array.

  Allowed values are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given display name exactly.

• id (str) –

  (optional) The OCID of the SemanticStore.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “timeCreated”

• opc_request_id (str) – (optional) 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 (str) – (optional) A filter to return only resources whose queryingConnectionId matches with this id.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SemanticStoreCollection

Return type

Response

Example

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

list_vector_store_connector_file_sync_ingestion_logs(vector_store_connector_file_sync_id, **kwargs)

Gets Ingestion logs for a vectorStoreConnectorFileSync operation.

Parameters

• vector_store_connector_file_sync_id (str) –

  (required) The OCID of the vectorStoreConnectorFileSync.

• lifecycle_state (str) –

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

  Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) – (optional) 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 (str) –

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

  Allowed values are: “status”, “fileSize”, “filePath”

• sort_order (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type FileSyncIngestionLogsCollection

Return type

Response

Example

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

list_vector_store_connector_file_syncs(compartment_id, **kwargs)

Lists the vectorStoreConnectorFileSyncs of a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

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

  Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

• id (str) –

  (optional) The OCID of the vectorStoreConnectorFileSync.

• vector_store_connector_id (str) –

  (optional) The OCID of the VectorStoreConnector.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) – (optional) A filter to return only resources that match the given display name exactly.

• sort_order (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “displayName”, “timeCreated”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnectorFileSyncCollection

Return type

Response

Example

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

list_vector_store_connector_ingestion_logs(vector_store_connector_id, **kwargs)

Gets Ingestion logs for a vectorStoreConnector.

Parameters

• vector_store_connector_id (str) –

  (required) The OCID of the VectorStoreConnector.

• status (str) –

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

  Allowed values are: “COMPLETED”, “CANCELLED”, “FAILED”, “QUEUED”, “IN_PROGRESS”

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) – (optional) 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 (str) –

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

  Allowed values are: “status”, “fileSize”, “filePath”

• sort_order (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnectorIngestionLogsCollection

Return type

Response

Example

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

list_vector_store_connectors(compartment_id, **kwargs)

Lists the vectorStoreConnectors of a specific compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• vector_store_id (str) – (optional) The openai compatible id of the VectorStore.

• lifecycle_state (str) –

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

  Allowed values are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the given name exactly.

• id (str) –

  (optional) The OCID of the VectorStoreConnector.

• limit (int) –

  (optional) 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.

• page (str) –

  (optional) 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 (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

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

  Allowed values are: “name”, “timeCreated”

• opc_request_id (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnectorCollection

Return type

Response

Example

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

list_work_request_errors(work_request_id, **kwargs)

Lists the errors for a work request.

Parameters

• work_request_id (str) –

  (required) The OCID of the asynchronous work request.

• opc_request_id (str) – (optional) 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 (str) –

  (optional) 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 (int) –

  (optional) 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.

• sort_by (str) –

  (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.

  Allowed values are: “timestamp”

• sort_order (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequestErrorCollection

Return type

Response

Example

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

list_work_request_logs(work_request_id, **kwargs)

Lists the logs for a work request.

Parameters

• work_request_id (str) –

  (required) The OCID of the asynchronous work request.

• opc_request_id (str) – (optional) 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 (str) –

  (optional) 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 (int) –

  (optional) 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.

• sort_by (str) –

  (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending.

  Allowed values are: “timestamp”

• sort_order (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequestLogEntryCollection

Return type

Response

Example

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

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• work_request_id (str) –

  (optional) The OCID of the asynchronous work request.

• status (str) –

  (optional) A filter to return only the resources that match the given lifecycle state.

  Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

• resource_id (str) –

  (optional) The OCID of the resource affected by the work request.

• opc_request_id (str) – (optional) 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 (str) –

  (optional) 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 (int) –

  (optional) 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.

• sort_order (str) –

  (optional) The sort order to use, either ‘ASC’ or ‘DESC’.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

  (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

  Allowed values are: “timeAccepted”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type WorkRequestSummaryCollection

Return type

Response

Example

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

renew_api_key(api_key_id, renew_api_key_details, **kwargs)

Renew the primary or secondary key.

Parameters

• api_key_id (str) –

  (required) The OCID of the APIKey.

• renew_api_key_details (oci.generative_ai.models.RenewApiKeyDetails) – (required) The information to be renewed.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ApiKey

Return type

Response

Example

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

set_api_key_state(api_key_id, set_api_key_state_details, **kwargs)

Set state of the key.

Parameters

• api_key_id (str) –

  (required) The OCID of the APIKey.

• set_api_key_state_details (oci.generative_ai.models.SetApiKeyStateDetails) – (required) The information for setting key state.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ApiKey

Return type

Response

Example

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

update_api_key(api_key_id, update_api_key_details, **kwargs)

Updates the properties of an apiKey.

Parameters

• api_key_id (str) –

  (required) The OCID of the APIKey.

• update_api_key_details (oci.generative_ai.models.UpdateApiKeyDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ApiKey

Return type

Response

Example

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

update_dedicated_ai_cluster(dedicated_ai_cluster_id, update_dedicated_ai_cluster_details, **kwargs)

Updates a dedicated AI cluster.

Parameters

• dedicated_ai_cluster_id (str) –

  (required) The OCID of the dedicated AI cluster.

• update_dedicated_ai_cluster_details (oci.generative_ai.models.UpdateDedicatedAiClusterDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type DedicatedAiCluster

Return type

Response

Example

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

update_endpoint(endpoint_id, update_endpoint_details, **kwargs)

Updates the properties of an endpoint.

Parameters

• endpoint_id (str) –

  (required) The OCID of the endpoint.

• update_endpoint_details (oci.generative_ai.models.UpdateEndpointDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Endpoint

Return type

Response

Example

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

update_generative_ai_private_endpoint(generative_ai_private_endpoint_id, update_generative_ai_private_endpoint_details, **kwargs)

Updates a Generative AI private endpoint using a privateEndpointId.

Parameters

• generative_ai_private_endpoint_id (str) – (required) The unique id for a Generative AI private endpoint.

• update_generative_ai_private_endpoint_details (oci.generative_ai.models.UpdateGenerativeAiPrivateEndpointDetails) – (required) Details for updating a Generative AI private endpoint.

• opc_request_id (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiPrivateEndpoint

Return type

Response

Example

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

update_generative_ai_project(generative_ai_project_id, update_generative_ai_project_details, **kwargs)

Updates the properties of a generativeAiProject.

Parameters

• generative_ai_project_id (str) –

  (required) The OCID of the generativeAiProject.

• update_generative_ai_project_details (oci.generative_ai.models.UpdateGenerativeAiProjectDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type GenerativeAiProject

Return type

Response

Example

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

update_hosted_application(hosted_application_id, update_hosted_application_details, **kwargs)

Updates a hosted application.

Parameters

• hosted_application_id (str) –

  (required) The OCID of the hosted application.

• update_hosted_application_details (oci.generative_ai.models.UpdateHostedApplicationDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

update_hosted_application_iam(hosted_application_iam_id, update_hosted_application_iam_details, **kwargs)

Updates a hosted application.

Parameters

• hosted_application_iam_id (str) –

  (required) The OCID of the hosted application.

• update_hosted_application_iam_details (oci.generative_ai.models.UpdateHostedApplicationIamDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type

Response

Example

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

update_hosted_deployment(hosted_deployment_id, update_hosted_deployment_details, **kwargs)

Updates a hosted deployment.

Parameters

• hosted_deployment_id (str) –

  (required) The OCID of the hosted deployment.

• update_hosted_deployment_details (oci.generative_ai.models.UpdateHostedDeploymentDetails) – (required) update hosted deployment.

• if_match (str) – (optional) 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 (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type HostedDeployment

Return type

Response

Example

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

update_imported_model(imported_model_id, update_imported_model_details, **kwargs)

Updates the properties of an imported model such as name, description, freeform tags, and defined tags.

Parameters

• imported_model_id (str) – (required) The importedModel OCID

• update_imported_model_details (oci.generative_ai.models.UpdateImportedModelDetails) – (required) The model information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type ImportedModel

Return type

Response

Example

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

update_model(model_id, update_model_details, **kwargs)

Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.

Parameters

• model_id (str) – (required) The model OCID

• update_model_details (oci.generative_ai.models.UpdateModelDetails) – (required) The model information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type Model

Return type

Response

Example

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

update_routing_profile(routing_profile_id, update_routing_profile_details, **kwargs)

Updates the properties of a routing profile.

Parameters

• routing_profile_id (str) –

  (required) The OCID of the routing profile.

• update_routing_profile_details (oci.generative_ai.models.UpdateRoutingProfileDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type RoutingProfile

Return type

Response

Example

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

update_sandbox_warm_pool(project_id, name, update_sandbox_warm_pool_details, **kwargs)

Only desiredCapacity may change. If desiredCapacity is omitted, the current desired capacity is preserved. An empty update object is allowed; an explicit null value for desiredCapacity is not allowed. Named MANAGED and CUSTOM pools and reserved MANAGED defaults can be resized. Default-pool updates use the existing Project configuration workflow; no separate desired configuration is created for those entries. CP persists UPDATING and a Work Request, applies the desired replica count, then returns the pool to ACTIVE after verifying the configuration. The workflow does not wait for ready members. Zero pauses idle prewarming. Once the pool is ACTIVE, named-pool Sandbox creation can still cold-start from its available applied template when no eligible warm member is available, regardless of the capacity target. Already-admitted Sandboxes continue. Unnamed Sandbox creation retains its existing behavior. Concurrent management operations return 409. If provided, if-match must match the current configuration ETag; otherwise this operation returns 412.

Parameters

• project_id (str) – (required) Owning Generative AI Project OCID. Resolve parent compartment for authorization.

• name (str) – (required) Immutable name within the Project.

• update_sandbox_warm_pool_details (oci.generative_ai.models.UpdateSandboxWarmPoolDetails) – (required) Replacement desired capacity to persist.

• opc_request_id (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SandboxWarmPool

Return type

Response

Example

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

update_semantic_store(semantic_store_id, update_semantic_store_details, **kwargs)

Updates the properties of a SemanticStore.

Parameters

• semantic_store_id (str) –

  (required) The OCID of the SemanticStore.

• update_semantic_store_details (oci.generative_ai.models.UpdateSemanticStoreDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type SemanticStore

Return type

Response

Example

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

update_vector_store_connector(vector_store_connector_id, update_vector_store_connector_details, **kwargs)

Updates the properties of a vectorStoreConnector.

Parameters

• vector_store_connector_id (str) –

  (required) The OCID of the VectorStoreConnector.

• update_vector_store_connector_details (oci.generative_ai.models.UpdateVectorStoreConnectorDetails) – (required) The information to be updated.

• if_match (str) – (optional) 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 (str) – (optional) 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.

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

• enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type VectorStoreConnector

Return type

Response

Example

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