generative-ai
=================

Description
-----------
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 CLI to create and manage `dedicated AI clusters <https://docs.cloud.oracle.com/api/#/en/generative-ai/latest/DedicatedAiCluster/>`__, `endpoints <https://docs.cloud.oracle.com/api/#/en/generative-ai/latest/Endpoint/>`__, `custom models <https://docs.cloud.oracle.com/api/#/en/generative-ai/latest/Model/>`__, and `work requests <https://docs.cloud.oracle.com/api/#/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 CLI].

To learn more about the service, see the `Generative AI documentation <https://docs.cloud.oracle.com/iaas/Content/generative-ai/home.htm>`__.

Available Commands
------------------
* :doc:`api-key </cmdref/generative-ai/api-key>`

  * :doc:`change-compartment </cmdref/generative-ai/api-key/change-compartment>`
  * :doc:`create </cmdref/generative-ai/api-key/create>`
  * :doc:`delete </cmdref/generative-ai/api-key/delete>`
  * :doc:`get </cmdref/generative-ai/api-key/get>`
  * :doc:`renew </cmdref/generative-ai/api-key/renew>`
  * :doc:`set-api-key-state </cmdref/generative-ai/api-key/set-api-key-state>`
  * :doc:`update </cmdref/generative-ai/api-key/update>`

* :doc:`api-key-collection </cmdref/generative-ai/api-key-collection>`

  * :doc:`list-api-keys </cmdref/generative-ai/api-key-collection/list-api-keys>`

* :doc:`dedicated-ai-cluster </cmdref/generative-ai/dedicated-ai-cluster>`

  * :doc:`change-compartment </cmdref/generative-ai/dedicated-ai-cluster/change-compartment>`
  * :doc:`create </cmdref/generative-ai/dedicated-ai-cluster/create>`
  * :doc:`delete </cmdref/generative-ai/dedicated-ai-cluster/delete>`
  * :doc:`get </cmdref/generative-ai/dedicated-ai-cluster/get>`
  * :doc:`update </cmdref/generative-ai/dedicated-ai-cluster/update>`

* :doc:`dedicated-ai-cluster-collection </cmdref/generative-ai/dedicated-ai-cluster-collection>`

  * :doc:`list-dedicated-ai-clusters </cmdref/generative-ai/dedicated-ai-cluster-collection/list-dedicated-ai-clusters>`

* :doc:`endpoint </cmdref/generative-ai/endpoint>`

  * :doc:`change-compartment </cmdref/generative-ai/endpoint/change-compartment>`
  * :doc:`create </cmdref/generative-ai/endpoint/create>`
  * :doc:`delete </cmdref/generative-ai/endpoint/delete>`
  * :doc:`get </cmdref/generative-ai/endpoint/get>`
  * :doc:`update </cmdref/generative-ai/endpoint/update>`

* :doc:`endpoint-collection </cmdref/generative-ai/endpoint-collection>`

  * :doc:`list-endpoints </cmdref/generative-ai/endpoint-collection/list-endpoints>`

* :doc:`file-sync-ingestion-logs-collection </cmdref/generative-ai/file-sync-ingestion-logs-collection>`

  * :doc:`list-vector-store-connector-file-sync-ingestion-logs </cmdref/generative-ai/file-sync-ingestion-logs-collection/list-vector-store-connector-file-sync-ingestion-logs>`

* :doc:`generative-ai-private-endpoint </cmdref/generative-ai/generative-ai-private-endpoint>`

  * :doc:`change-compartment </cmdref/generative-ai/generative-ai-private-endpoint/change-compartment>`
  * :doc:`create </cmdref/generative-ai/generative-ai-private-endpoint/create>`
  * :doc:`delete </cmdref/generative-ai/generative-ai-private-endpoint/delete>`
  * :doc:`get </cmdref/generative-ai/generative-ai-private-endpoint/get>`
  * :doc:`update </cmdref/generative-ai/generative-ai-private-endpoint/update>`

* :doc:`generative-ai-private-endpoint-collection </cmdref/generative-ai/generative-ai-private-endpoint-collection>`

  * :doc:`list-generative-ai-private-endpoints </cmdref/generative-ai/generative-ai-private-endpoint-collection/list-generative-ai-private-endpoints>`

* :doc:`generative-ai-project </cmdref/generative-ai/generative-ai-project>`

  * :doc:`change-compartment </cmdref/generative-ai/generative-ai-project/change-compartment>`
  * :doc:`create </cmdref/generative-ai/generative-ai-project/create>`
  * :doc:`delete </cmdref/generative-ai/generative-ai-project/delete>`
  * :doc:`get </cmdref/generative-ai/generative-ai-project/get>`
  * :doc:`update </cmdref/generative-ai/generative-ai-project/update>`

* :doc:`generative-ai-project-collection </cmdref/generative-ai/generative-ai-project-collection>`

  * :doc:`list-generative-ai-projects </cmdref/generative-ai/generative-ai-project-collection/list-generative-ai-projects>`

* :doc:`hosted-application </cmdref/generative-ai/hosted-application>`

  * :doc:`change-compartment </cmdref/generative-ai/hosted-application/change-compartment>`
  * :doc:`create </cmdref/generative-ai/hosted-application/create>`
  * :doc:`delete </cmdref/generative-ai/hosted-application/delete>`
  * :doc:`get </cmdref/generative-ai/hosted-application/get>`
  * :doc:`update </cmdref/generative-ai/hosted-application/update>`

* :doc:`hosted-application-collection </cmdref/generative-ai/hosted-application-collection>`

  * :doc:`list-hosted-applications </cmdref/generative-ai/hosted-application-collection/list-hosted-applications>`

* :doc:`hosted-application-storage </cmdref/generative-ai/hosted-application-storage>`

  * :doc:`change-compartment </cmdref/generative-ai/hosted-application-storage/change-compartment>`
  * :doc:`create </cmdref/generative-ai/hosted-application-storage/create>`
  * :doc:`delete </cmdref/generative-ai/hosted-application-storage/delete>`
  * :doc:`get </cmdref/generative-ai/hosted-application-storage/get>`

* :doc:`hosted-application-storage-collection </cmdref/generative-ai/hosted-application-storage-collection>`

  * :doc:`list-hosted-application-storages </cmdref/generative-ai/hosted-application-storage-collection/list-hosted-application-storages>`

* :doc:`hosted-deployment </cmdref/generative-ai/hosted-deployment>`

  * :doc:`add </cmdref/generative-ai/hosted-deployment/add>`
  * :doc:`add-artifact-create-single-docker-artifact-details </cmdref/generative-ai/hosted-deployment/add-artifact-create-single-docker-artifact-details>`
  * :doc:`create </cmdref/generative-ai/hosted-deployment/create>`
  * :doc:`create-hosted-deployment-single-docker-artifact </cmdref/generative-ai/hosted-deployment/create-hosted-deployment-single-docker-artifact>`
  * :doc:`delete </cmdref/generative-ai/hosted-deployment/delete>`
  * :doc:`delete-hosted-deployment-artifact </cmdref/generative-ai/hosted-deployment/delete-hosted-deployment-artifact>`
  * :doc:`get </cmdref/generative-ai/hosted-deployment/get>`
  * :doc:`update </cmdref/generative-ai/hosted-deployment/update>`

* :doc:`hosted-deployment-collection </cmdref/generative-ai/hosted-deployment-collection>`

  * :doc:`list-hosted-deployments </cmdref/generative-ai/hosted-deployment-collection/list-hosted-deployments>`

* :doc:`imported-model </cmdref/generative-ai/imported-model>`

  * :doc:`change-compartment </cmdref/generative-ai/imported-model/change-compartment>`
  * :doc:`create-from-huggingface </cmdref/generative-ai/imported-model/create-from-huggingface>`
  * :doc:`create-from-objectstorage </cmdref/generative-ai/imported-model/create-from-objectstorage>`
  * :doc:`delete </cmdref/generative-ai/imported-model/delete>`
  * :doc:`get </cmdref/generative-ai/imported-model/get>`
  * :doc:`update </cmdref/generative-ai/imported-model/update>`

* :doc:`imported-model-collection </cmdref/generative-ai/imported-model-collection>`

  * :doc:`list-imported-models </cmdref/generative-ai/imported-model-collection/list-imported-models>`

* :doc:`model </cmdref/generative-ai/model>`

  * :doc:`change-compartment </cmdref/generative-ai/model/change-compartment>`
  * :doc:`create </cmdref/generative-ai/model/create>`
  * :doc:`delete </cmdref/generative-ai/model/delete>`
  * :doc:`get </cmdref/generative-ai/model/get>`
  * :doc:`update </cmdref/generative-ai/model/update>`

* :doc:`model-collection </cmdref/generative-ai/model-collection>`

  * :doc:`list-models </cmdref/generative-ai/model-collection/list-models>`

* :doc:`semantic-store </cmdref/generative-ai/semantic-store>`

  * :doc:`change-compartment </cmdref/generative-ai/semantic-store/change-compartment>`
  * :doc:`create </cmdref/generative-ai/semantic-store/create>`
  * :doc:`delete </cmdref/generative-ai/semantic-store/delete>`
  * :doc:`get </cmdref/generative-ai/semantic-store/get>`
  * :doc:`update </cmdref/generative-ai/semantic-store/update>`

* :doc:`semantic-store-collection </cmdref/generative-ai/semantic-store-collection>`

  * :doc:`list-semantic-stores </cmdref/generative-ai/semantic-store-collection/list-semantic-stores>`

* :doc:`vector-store-connector </cmdref/generative-ai/vector-store-connector>`

  * :doc:`create </cmdref/generative-ai/vector-store-connector/create>`
  * :doc:`create-vector-store-connector-oci-object-storage-configuration </cmdref/generative-ai/vector-store-connector/create-vector-store-connector-oci-object-storage-configuration>`
  * :doc:`create-vector-store-connector-schedule-cron-config </cmdref/generative-ai/vector-store-connector/create-vector-store-connector-schedule-cron-config>`
  * :doc:`create-vector-store-connector-schedule-interval-config </cmdref/generative-ai/vector-store-connector/create-vector-store-connector-schedule-interval-config>`
  * :doc:`delete </cmdref/generative-ai/vector-store-connector/delete>`
  * :doc:`get </cmdref/generative-ai/vector-store-connector/get>`
  * :doc:`update </cmdref/generative-ai/vector-store-connector/update>`
  * :doc:`update-vector-store-connector-oci-object-storage-configuration </cmdref/generative-ai/vector-store-connector/update-vector-store-connector-oci-object-storage-configuration>`
  * :doc:`update-vector-store-connector-schedule-cron-config </cmdref/generative-ai/vector-store-connector/update-vector-store-connector-schedule-cron-config>`
  * :doc:`update-vector-store-connector-schedule-interval-config </cmdref/generative-ai/vector-store-connector/update-vector-store-connector-schedule-interval-config>`

* :doc:`vector-store-connector-collection </cmdref/generative-ai/vector-store-connector-collection>`

  * :doc:`list-vector-store-connectors </cmdref/generative-ai/vector-store-connector-collection/list-vector-store-connectors>`

* :doc:`vector-store-connector-file-sync </cmdref/generative-ai/vector-store-connector-file-sync>`

  * :doc:`cancel </cmdref/generative-ai/vector-store-connector-file-sync/cancel>`
  * :doc:`create </cmdref/generative-ai/vector-store-connector-file-sync/create>`
  * :doc:`get </cmdref/generative-ai/vector-store-connector-file-sync/get>`

* :doc:`vector-store-connector-file-sync-collection </cmdref/generative-ai/vector-store-connector-file-sync-collection>`

  * :doc:`list-vector-store-connector-file-syncs </cmdref/generative-ai/vector-store-connector-file-sync-collection/list-vector-store-connector-file-syncs>`

* :doc:`vector-store-connector-ingestion-logs-collection </cmdref/generative-ai/vector-store-connector-ingestion-logs-collection>`

  * :doc:`list-vector-store-connector-ingestion-logs </cmdref/generative-ai/vector-store-connector-ingestion-logs-collection/list-vector-store-connector-ingestion-logs>`

* :doc:`vector-store-connector-stats </cmdref/generative-ai/vector-store-connector-stats>`

  * :doc:`get </cmdref/generative-ai/vector-store-connector-stats/get>`

* :doc:`work-request </cmdref/generative-ai/work-request>`

  * :doc:`get </cmdref/generative-ai/work-request/get>`
  * :doc:`list </cmdref/generative-ai/work-request/list>`

* :doc:`work-request-error </cmdref/generative-ai/work-request-error>`

  * :doc:`list </cmdref/generative-ai/work-request-error/list>`

* :doc:`work-request-log-entry </cmdref/generative-ai/work-request-log-entry>`

  * :doc:`list-work-request-logs </cmdref/generative-ai/work-request-log-entry/list-work-request-logs>`


.. toctree::
    :hidden:

    /cmdref/generative-ai/api-key
    /cmdref/generative-ai/api-key-collection
    /cmdref/generative-ai/dedicated-ai-cluster
    /cmdref/generative-ai/dedicated-ai-cluster-collection
    /cmdref/generative-ai/endpoint
    /cmdref/generative-ai/endpoint-collection
    /cmdref/generative-ai/file-sync-ingestion-logs-collection
    /cmdref/generative-ai/generative-ai-private-endpoint
    /cmdref/generative-ai/generative-ai-private-endpoint-collection
    /cmdref/generative-ai/generative-ai-project
    /cmdref/generative-ai/generative-ai-project-collection
    /cmdref/generative-ai/hosted-application
    /cmdref/generative-ai/hosted-application-collection
    /cmdref/generative-ai/hosted-application-storage
    /cmdref/generative-ai/hosted-application-storage-collection
    /cmdref/generative-ai/hosted-deployment
    /cmdref/generative-ai/hosted-deployment-collection
    /cmdref/generative-ai/imported-model
    /cmdref/generative-ai/imported-model-collection
    /cmdref/generative-ai/model
    /cmdref/generative-ai/model-collection
    /cmdref/generative-ai/semantic-store
    /cmdref/generative-ai/semantic-store-collection
    /cmdref/generative-ai/vector-store-connector
    /cmdref/generative-ai/vector-store-connector-collection
    /cmdref/generative-ai/vector-store-connector-file-sync
    /cmdref/generative-ai/vector-store-connector-file-sync-collection
    /cmdref/generative-ai/vector-store-connector-ingestion-logs-collection
    /cmdref/generative-ai/vector-store-connector-stats
    /cmdref/generative-ai/work-request
    /cmdref/generative-ai/work-request-error
    /cmdref/generative-ai/work-request-log-entry