Bedrock Agent Runtime  >  Operations  >  generate_query

generate_query

Operation

generate_query async

generate_query(input: GenerateQueryInput, plugins: list[Plugin] | None = None) -> GenerateQueryOutput

Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.

Parameters:

Name	Type	Description	Default
input	GenerateQueryInput	An instance of GenerateQueryInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
GenerateQueryOutput	An instance of GenerateQueryOutput.

Input

GenerateQueryInput dataclass

Dataclass for GenerateQueryInput structure.

Attributes

query_generation_input class-attribute instance-attribute

query_generation_input: QueryGenerationInput | None = field(repr=False, default=None)

Specifies information about a natural language query to transform into SQL.

transformation_configuration class-attribute instance-attribute

transformation_configuration: TransformationConfiguration | None = None

Specifies configurations for transforming the natural language query into SQL.

Output

GenerateQueryOutput dataclass

Dataclass for GenerateQueryOutput structure.

Attributes

queries class-attribute instance-attribute

queries: list[GeneratedQuery] | None = None

A list of objects, each of which defines a generated query that can correspond to the natural language queries.