generate_query¶
Operation¶
generate_query
¶
generate_query(request: GenerateQueryInput | GenerateQueryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GenerateQueryInputDict]) -> 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 |
|---|---|---|---|
request
|
GenerateQueryInput | GenerateQueryInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GenerateQueryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GenerateQueryOutput
|
An instance of |
generate_query
async
¶
generate_query(request: GenerateQueryInput | GenerateQueryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GenerateQueryInputDict]) -> 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 |
|---|---|---|---|
request
|
GenerateQueryInput | GenerateQueryInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GenerateQueryInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GenerateQueryOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GenerateQueryInputDict
¶
Bases: TypedDict
Dictionary form of GenerateQueryInput.
Attributes¶
query_generation_input
instance-attribute
¶
query_generation_input: Required[QueryGenerationInput | QueryGenerationInputDict]
Specifies information about a natural language query to transform into SQL.
transformation_configuration
instance-attribute
¶
transformation_configuration: Required[TransformationConfiguration | TransformationConfigurationDict]
Specifies configurations for transforming the natural language query into SQL.
GenerateQueryInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GenerateQueryInput structure.
Attributes¶
query_generation_input
class-attribute
instance-attribute
¶
query_generation_input: QueryGenerationInput | None = ...
Specifies information about a natural language query to transform into SQL.
transformation_configuration
class-attribute
instance-attribute
¶
transformation_configuration: TransformationConfiguration | None = ...
Specifies configurations for transforming the natural language query into SQL.
Output¶
GenerateQueryOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GenerateQueryOutput structure.
Attributes¶
queries
class-attribute
instance-attribute
¶
queries: list[GeneratedQuery] | None = ...
A list of objects, each of which defines a generated query that can correspond to the natural language queries.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.