Class GenerateSqlFromNlDetails

The data to create a GenerateSqlFromNlJob.

Inheritance

object

GenerateSqlFromNlDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GenerativeaidataService.Models

Assembly: OCI.DotNetSDK.Generativeaidata.dll

Syntax

public class GenerateSqlFromNlDetails

Properties

CompletionMode

Declaration

[JsonProperty(PropertyName = "completionMode")]
[JsonConverter(typeof(StringEnumConverter))]
public CompletionMode? CompletionMode { get; set; }

Property Value

Type	Description
CompletionMode?	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.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	An optional description of the GenerateSqlFromNlJob.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

InputNaturalLanguageQuery

Declaration

[Required(ErrorMessage = "InputNaturalLanguageQuery is required.")]
[JsonProperty(PropertyName = "inputNaturalLanguageQuery")]
public string InputNaturalLanguageQuery { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

ModelId

Declaration

[JsonProperty(PropertyName = "modelId")]
public string ModelId { get; set; }

Property Value

Type	Description
string	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