Generative AI Functions

CHANGE_DEDICATED_AI_CLUSTER_COMPARTMENT Function

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.

Syntax

FUNCTION change_dedicated_ai_cluster_compartment (
  dedicated_ai_cluster_id varchar2,
  change_dedicated_ai_cluster_compartment_details dbms_cloud_oci_generative_ai_change_dedicated_ai_cluster_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_change_dedicated_ai_cluster_compartment_response_t;

Parameters

Parameter	Description
`dedicated_ai_cluster_id`	(required) The OCID of the dedicated AI cluster.
`change_dedicated_ai_cluster_compartment_details`	(required) The information to be updated.
`if_match`	(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`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_ENDPOINT_COMPARTMENT Function

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.

Syntax

FUNCTION change_endpoint_compartment (
  endpoint_id varchar2,
  change_endpoint_compartment_details dbms_cloud_oci_generative_ai_change_endpoint_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_change_endpoint_compartment_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`change_endpoint_compartment_details`	(required) The endpoint information to be updated.
`if_match`	(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`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MODEL_COMPARTMENT Function

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

Syntax

FUNCTION change_model_compartment (
  model_id varchar2,
  change_model_compartment_details dbms_cloud_oci_generative_ai_change_model_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_change_model_compartment_response_t;

Parameters

Parameter	Description
`model_id`	(required) The model OCID
`change_model_compartment_details`	(required) The information to be updated.
`if_match`	(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`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DEDICATED_AI_CLUSTER Function

Creates a dedicated AI cluster.

Syntax

FUNCTION create_dedicated_ai_cluster (
  create_dedicated_ai_cluster_details dbms_cloud_oci_generative_ai_create_dedicated_ai_cluster_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_create_dedicated_ai_cluster_response_t;

Parameters

Parameter	Description
`create_dedicated_ai_cluster_details`	(required) Details for the new dedicated AI cluster.
`opc_retry_token`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ENDPOINT Function

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

Syntax

FUNCTION create_endpoint (
  create_endpoint_details dbms_cloud_oci_generative_ai_create_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_create_endpoint_response_t;

Parameters

Parameter	Description
`create_endpoint_details`	(required) Details for the new endpoint.
`opc_retry_token`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MODEL Function

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.

Syntax

FUNCTION create_model (
  create_model_details dbms_cloud_oci_generative_ai_create_model_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_create_model_response_t;

Parameters

Parameter	Description
`create_model_details`	(required) Details for the new model.
`opc_retry_token`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DEDICATED_AI_CLUSTER Function

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.

Syntax

FUNCTION delete_dedicated_ai_cluster (
  dedicated_ai_cluster_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_delete_dedicated_ai_cluster_response_t;

Parameters

Parameter	Description
`dedicated_ai_cluster_id`	(required) The OCID of the dedicated AI cluster.
`if_match`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ENDPOINT Function

Deletes an endpoint.

Syntax

FUNCTION delete_endpoint (
  endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_delete_endpoint_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`if_match`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MODEL Function

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

Syntax

FUNCTION delete_model (
  model_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_delete_model_response_t;

Parameters

Parameter	Description
`model_id`	(required) The model OCID
`if_match`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DEDICATED_AI_CLUSTER Function

Gets information about a dedicated AI cluster.

Syntax

FUNCTION get_dedicated_ai_cluster (
  dedicated_ai_cluster_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_get_dedicated_ai_cluster_response_t;

Parameters

Parameter	Description
`dedicated_ai_cluster_id`	(required) The OCID of the dedicated AI cluster.
`opc_request_id`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ENDPOINT Function

Gets information about an endpoint.

Syntax

FUNCTION get_endpoint (
  endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_get_endpoint_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`opc_request_id`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MODEL Function

Gets information about a custom model.

Syntax

FUNCTION get_model (
  model_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_get_model_response_t;

Parameters

Parameter	Description
`model_id`	(required) The model OCID
`opc_request_id`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the details of a work request.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous work request.
`opc_request_id`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DEDICATED_AI_CLUSTERS Function

Lists the dedicated AI clusters in a specific compartment.

Syntax

FUNCTION list_dedicated_ai_clusters (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_list_dedicated_ai_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`id`	(optional) The OCID of the dedicated AI cluster.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ENDPOINTS Function

Lists the endpoints of a specific compartment.

Syntax

FUNCTION list_endpoints (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_list_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources that their lifecycle state matches the given lifecycle state.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`id`	(optional) The OCID of the endpoint.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MODELS Function

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

Syntax

FUNCTION list_models (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  vendor varchar2 DEFAULT NULL,
  capability dbms_cloud_oci_generative_ai_varchar2_tbl DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_list_models_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`opc_request_id`	(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`	(optional) A filter to return only resources that match the entire vendor given.
`capability`	(optional) A filter to return only resources their capability matches the given capability. Allowed values are: 'TEXT_GENERATION', 'TEXT_SUMMARIZATION', 'TEXT_EMBEDDINGS', 'FINE_TUNE'
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`id`	(optional) The ID of the model.
`limit`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Lists the errors for a work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous work request.
`opc_request_id`	(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`	(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`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Lists the logs for a work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous work request.
`opc_request_id`	(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`	(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`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`work_request_id`	(optional) The OCID of the asynchronous work request.
`status`	(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`	(optional) The OCID of the resource affected by the work request.
`opc_request_id`	(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`	(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`	(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`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending. Allowed values are: 'timeAccepted'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DEDICATED_AI_CLUSTER Function

Updates a dedicated AI cluster.

Syntax

FUNCTION update_dedicated_ai_cluster (
  dedicated_ai_cluster_id varchar2,
  update_dedicated_ai_cluster_details dbms_cloud_oci_generative_ai_update_dedicated_ai_cluster_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_update_dedicated_ai_cluster_response_t;

Parameters

Parameter	Description
`dedicated_ai_cluster_id`	(required) The OCID of the dedicated AI cluster.
`update_dedicated_ai_cluster_details`	(required) The information to be updated.
`if_match`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ENDPOINT Function

Updates the properties of an endpoint.

Syntax

FUNCTION update_endpoint (
  endpoint_id varchar2,
  update_endpoint_details dbms_cloud_oci_generative_ai_update_endpoint_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_update_endpoint_response_t;

Parameters

Parameter	Description
`endpoint_id`	(required) The OCID of the endpoint.
`update_endpoint_details`	(required) The information to be updated.
`if_match`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MODEL Function

Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.

Syntax

FUNCTION update_model (
  model_id varchar2,
  update_model_details dbms_cloud_oci_generative_ai_update_model_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ga_generative_ai_update_model_response_t;

Parameters

Parameter	Description
`model_id`	(required) The model OCID
`update_model_details`	(required) The model information to be updated.
`if_match`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://generativeai.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_DEDICATED_AI_CLUSTER_COMPARTMENT Function 🔗

CHANGE_ENDPOINT_COMPARTMENT Function 🔗

CHANGE_MODEL_COMPARTMENT Function 🔗

CREATE_DEDICATED_AI_CLUSTER Function 🔗

CREATE_ENDPOINT Function 🔗

CREATE_MODEL Function 🔗

DELETE_DEDICATED_AI_CLUSTER Function 🔗

DELETE_ENDPOINT Function 🔗

DELETE_MODEL Function 🔗

GET_DEDICATED_AI_CLUSTER Function 🔗

GET_ENDPOINT Function 🔗

GET_MODEL Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_DEDICATED_AI_CLUSTERS Function 🔗

LIST_ENDPOINTS Function 🔗

LIST_MODELS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

UPDATE_DEDICATED_AI_CLUSTER Function 🔗

UPDATE_ENDPOINT Function 🔗

UPDATE_MODEL Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_DEDICATED_AI_CLUSTER_COMPARTMENT Function

CHANGE_ENDPOINT_COMPARTMENT Function

CHANGE_MODEL_COMPARTMENT Function

CREATE_DEDICATED_AI_CLUSTER Function

CREATE_ENDPOINT Function

CREATE_MODEL Function

DELETE_DEDICATED_AI_CLUSTER Function

DELETE_ENDPOINT Function

DELETE_MODEL Function

GET_DEDICATED_AI_CLUSTER Function

GET_ENDPOINT Function

GET_MODEL Function

GET_WORK_REQUEST Function

LIST_DEDICATED_AI_CLUSTERS Function

LIST_ENDPOINTS Function

LIST_MODELS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

UPDATE_DEDICATED_AI_CLUSTER Function

UPDATE_ENDPOINT Function

UPDATE_MODEL Function