5.1 Prerequisites

Before using the model command, ensure that the following prerequisites are met:

  • For model ingest and model delete, connect SQLcl to an Oracle Database that supports the Oracle AI Vector Search features and Vector Database APIs required by these commands. See Overview of Oracle Vector AI Search
  • Ensure that the connected database user has the privileges required to create and use vector tables and indexes, and to execute the required vector database APIs.
  • Ensure that you have access to the required OCI Generative AI model and compartment. See OCI Generative AI Models
  • Ensure that the OCI identity used by SQLcl has permission to invoke the selected model. See IAM Policies for Generative AI.
  • Ensure that files supplied to model ingest are accessible and readable by the SQLcl process.

5.1.1 OCI Authentication

The model command supports OCI profile authentication and instance principal authentication.

To use an OCI profile, select the profile before configuring a model:

SQL> OCI PROFILE <profile-name> 

By default, SQLcl reads OCI profiles from the following configuration file:

~/.oci/config 

To use a different OCI configuration file, specify the -config-path option when configuring the model.

If you do not select an OCI profile, SQLcl uses instance principal authentication. In this case, SQLcl must run on an OCI resource that is configured to use instance principals and has the required IAM policies to access OCI Generative AI. For more information about IAM policies, see IAM Policies for OCI Generative AI.

The compartment OCID is required when configuring either model. The selected OCI profile or instance principal must be able to access the compartment and invoke the requested model.

For more information, see Configuring the OCI Profile.

5.1.2 Local Configuration File

SQLcl stores model configuration in:

~/.dbtools/sqlcl/model_config.json 

The file is created automatically after the first successful model config command. It stores the configured chat-model and embedding-model settings.