GenerateSqlFromNlDetails¶

class oci.generative_ai_data.models.GenerateSqlFromNlDetails(**kwargs)¶

Bases: object

The data to create a GenerateSqlFromNlJob.

Attributes

`COMPLETION_MODE_BACKGROUND_JOB`	A constant which can be used with the completion_mode property of a GenerateSqlFromNlDetails.
`COMPLETION_MODE_WAIT_FOR_COMPLETION`	A constant which can be used with the completion_mode property of a GenerateSqlFromNlDetails.
`completion_mode`	Gets the completion_mode of this GenerateSqlFromNlDetails.
`defined_tags`	Gets the defined_tags of this GenerateSqlFromNlDetails.
`description`	Gets the description of this GenerateSqlFromNlDetails.
`display_name`	Gets the display_name of this GenerateSqlFromNlDetails.
`freeform_tags`	Gets the freeform_tags of this GenerateSqlFromNlDetails.
`input_natural_language_query`	[Required] Gets the input_natural_language_query of this GenerateSqlFromNlDetails.
`model_id`	Gets the model_id of this GenerateSqlFromNlDetails.

Methods

__init__(**kwargs) Initializes a new GenerateSqlFromNlDetails object with values from keyword arguments.

COMPLETION_MODE_BACKGROUND_JOB = 'BACKGROUND_JOB'¶: A constant which can be used with the completion_mode property of a GenerateSqlFromNlDetails. This constant has a value of “BACKGROUND_JOB”

COMPLETION_MODE_WAIT_FOR_COMPLETION = 'WAIT_FOR_COMPLETION'¶: A constant which can be used with the completion_mode property of a GenerateSqlFromNlDetails. This constant has a value of “WAIT_FOR_COMPLETION”

__init__(**kwargs)¶

Initializes a new GenerateSqlFromNlDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

description (str) – The value to assign to the description property of this GenerateSqlFromNlDetails.
display_name (str) – The value to assign to the display_name property of this GenerateSqlFromNlDetails.
input_natural_language_query (str) – The value to assign to the input_natural_language_query property of this GenerateSqlFromNlDetails.
model_id (str) – The value to assign to the model_id property of this GenerateSqlFromNlDetails.
completion_mode (str) – The value to assign to the completion_mode property of this GenerateSqlFromNlDetails. Allowed values for this property are: “WAIT_FOR_COMPLETION”, “BACKGROUND_JOB”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this GenerateSqlFromNlDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this GenerateSqlFromNlDetails.

completion_mode¶

Gets the completion_mode of this GenerateSqlFromNlDetails. 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.

Allowed values for this property are: “WAIT_FOR_COMPLETION”, “BACKGROUND_JOB”

Returns:	The completion_mode of this GenerateSqlFromNlDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this GenerateSqlFromNlDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this GenerateSqlFromNlDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this GenerateSqlFromNlDetails. An optional description of the GenerateSqlFromNlJob.

Returns:	The description of this GenerateSqlFromNlDetails.
Return type:	str

display_name¶

Gets the display_name of this GenerateSqlFromNlDetails. A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns:	The display_name of this GenerateSqlFromNlDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this GenerateSqlFromNlDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this GenerateSqlFromNlDetails.
Return type:	dict(str, str)

input_natural_language_query¶

[Required] Gets the input_natural_language_query of this GenerateSqlFromNlDetails. A user-provided query or instruction written in plain, conversational language. This input is intended to capture the user’s intent, question, or command without requiring technical syntax or structured formatting. The query should clearly express what the user wants to know or accomplish, allowing the system to interpret and respond appropriately.

Returns:	The input_natural_language_query of this GenerateSqlFromNlDetails.
Return type:	str

model_id¶

Gets the model_id of this GenerateSqlFromNlDetails. 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

Returns:	The model_id of this GenerateSqlFromNlDetails.
Return type:	str