Generate Query

bedrockagentruntime_generate_query

R Documentation

Generates an SQL query from a natural language query¶

Description¶

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.

Usage¶

bedrockagentruntime_generate_query(queryGenerationInput,
  transformationConfiguration)

Arguments¶

queryGenerationInput

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

transformationConfiguration

[required] Specifies configurations for transforming the natural language query into SQL.

Value¶

A list with the following syntax:

list(
  queries = list(
    list(
      sql = "string",
      type = "REDSHIFT_SQL"
    )
  )
)

Request syntax¶

svc$generate_query(
  queryGenerationInput = list(
    text = "string",
    type = "TEXT"
  ),
  transformationConfiguration = list(
    mode = "TEXT_TO_SQL",
    textToSqlConfiguration = list(
      knowledgeBaseConfiguration = list(
        knowledgeBaseArn = "string"
      ),
      type = "KNOWLEDGE_BASE"
    )
  )
)