"generate"
**********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Generates a SQL query from a natural language input for the specified
SemanticStore.

This operation creates a GenerateSqlFromNlJob. The request can either
be processed as a background job or wait for completion, depending on
completionMode.

If modelId is provided, the service validates it and uses it for
schema-linking in table selection, SQL generation, and SQL refinement.
If modelId is omitted, the service default model is used. The response
includes the modelId used for generation.

Clients should inspect lifecycleState in the response: - If
lifecycleState is SUCCEEDED, SQL generation is complete and the result
is available in jobOutput. - If lifecycleState is ACCEPTED or
IN_PROGRESS, poll GetGenerateSqlFromNlJob using the returned job id. -
If lifecycleState is FAILED or CANCELED, SQL generation did not
complete. See lifecycleDetails for more information.

The GetGenerateSqlFromNlJob endpoint is the source of truth for final
job state and result availability.


Usage
=====

   oci generative-ai-data generate-sql-jobs generate [OPTIONS]


Required Parameters
===================

--nl-query [text]

A user-provided query or instruction written in plain, conversational
language.

--semantic-store-id [text]

The OCID of the semantic store


Optional Parameters
===================

--completion-mode [text]

Controls whether GenerateSqlFromNl should be accepted as a background
job or wait for completion. BACKGROUND_JOB accepts the request for
background processing and returns a pollable job. WAIT_FOR_COMPLETION
waits for completion within the service-defined timeout.

Accepted values are:

   BACKGROUND_JOB, WAIT_FOR_COMPLETION

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. Example: *{“foo-namespace”: {“bar-key”: “value”}}* This is
a complex type whose value must be valid JSON. The value can be
provided as a string on the command line or passed in as a file using
the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--description [text]

An optional description of the GenerateSqlFromNlJob.

--display-name [text]

A user-friendly display name. It does not have to be unique and can be
modified. Avoid entering confidential information.

--freeform-tags [complex type]

Simple key-value pair that is applied without any predefined name,
type or scope. Exists for cross-compatibility only. Example: *{“bar-
key”: “value”}* This is a complex type whose value must be valid JSON.
The value can be provided as a string on the command line or passed in
as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--if-match [text]

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.

--model-id [text]

The generative AI modelId to use for Generate SQL. You can use the
ListModels API to list the available models. https://docs.oracle.com
/en-us/iaas/api/#/en/generative-ai/20231130/ModelCollection/ListModels


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--enable-dual-stack", "--enable-propagation", "--
endpoint", "--federation-endpoint", "--generate-full-command-json-
input", "--generate-param-json-input", "--help", "--latest-version", "
--max-retries", "--no-retry", "--opc-client-request-id", "--opc-
request-id", "--output", "--profile", "--proxy", "--query", "--raw-
output", "--read-timeout", "--realm-specific-endpoint", "--region", "
--release-info", "--request-id", "--version", "-?", "-d", "-h", "-i",
"-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export nl_query=<substitute-value-of-nl_query> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-data/generate-sql-jobs/generate.html#cmdoption-nl-query
       export semantic_store_id=<substitute-value-of-semantic_store_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/generative-ai-data/generate-sql-jobs/generate.html#cmdoption-semantic-store-id

       oci generative-ai-data generate-sql-jobs generate --nl-query $nl_query --semantic-store-id $semantic_store_id
