-
Notifications
You must be signed in to change notification settings - Fork 585
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-bedrock-agent-runtime): This release introduces the abili…
…ty to generate SQL using natural language, through a new GenerateQuery API (with native integration into Knowledge Bases); ability to ingest and retrieve images through Bedrock Data Automation; and ability to create a Knowledge Base backed by Kendra GenAI Index.
- Loading branch information
awstools
committed
Dec 4, 2024
1 parent
ac7f368
commit 99b090b
Showing
13 changed files
with
1,155 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
145 changes: 145 additions & 0 deletions
145
clients/client-bedrock-agent-runtime/src/commands/GenerateQueryCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| // smithy-typescript generated code | ||
| import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
| import { Command as $Command } from "@smithy/smithy-client"; | ||
| import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
|
||
| import { | ||
| BedrockAgentRuntimeClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes, | ||
| } from "../BedrockAgentRuntimeClient"; | ||
| import { commonParams } from "../endpoint/EndpointParameters"; | ||
| import { | ||
| GenerateQueryRequest, | ||
| GenerateQueryRequestFilterSensitiveLog, | ||
| GenerateQueryResponse, | ||
| GenerateQueryResponseFilterSensitiveLog, | ||
| } from "../models/models_0"; | ||
| import { de_GenerateQueryCommand, se_GenerateQueryCommand } from "../protocols/Aws_restJson1"; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export type { __MetadataBearer }; | ||
| export { $Command }; | ||
| /** | ||
| * @public | ||
| * | ||
| * The input for {@link GenerateQueryCommand}. | ||
| */ | ||
| export interface GenerateQueryCommandInput extends GenerateQueryRequest {} | ||
| /** | ||
| * @public | ||
| * | ||
| * The output of {@link GenerateQueryCommand}. | ||
| */ | ||
| export interface GenerateQueryCommandOutput extends GenerateQueryResponse, __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <p>Generates an SQL query from a natural language query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-generate-query.html">Generate a query for structured data</a> in the Amazon Bedrock User Guide.</p> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { BedrockAgentRuntimeClient, GenerateQueryCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import | ||
| * // const { BedrockAgentRuntimeClient, GenerateQueryCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import | ||
| * const client = new BedrockAgentRuntimeClient(config); | ||
| * const input = { // GenerateQueryRequest | ||
| * queryGenerationInput: { // QueryGenerationInput | ||
| * type: "TEXT", // required | ||
| * text: "STRING_VALUE", // required | ||
| * }, | ||
| * transformationConfiguration: { // TransformationConfiguration | ||
| * mode: "TEXT_TO_SQL", // required | ||
| * textToSqlConfiguration: { // TextToSqlConfiguration | ||
| * type: "KNOWLEDGE_BASE", // required | ||
| * knowledgeBaseConfiguration: { // TextToSqlKnowledgeBaseConfiguration | ||
| * knowledgeBaseArn: "STRING_VALUE", // required | ||
| * }, | ||
| * }, | ||
| * }, | ||
| * }; | ||
| * const command = new GenerateQueryCommand(input); | ||
| * const response = await client.send(command); | ||
| * // { // GenerateQueryResponse | ||
| * // queries: [ // GeneratedQueries | ||
| * // { // GeneratedQuery | ||
| * // type: "REDSHIFT_SQL", | ||
| * // sql: "STRING_VALUE", | ||
| * // }, | ||
| * // ], | ||
| * // }; | ||
| * | ||
| * ``` | ||
| * | ||
| * @param GenerateQueryCommandInput - {@link GenerateQueryCommandInput} | ||
| * @returns {@link GenerateQueryCommandOutput} | ||
| * @see {@link GenerateQueryCommandInput} for command's `input` shape. | ||
| * @see {@link GenerateQueryCommandOutput} for command's `response` shape. | ||
| * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. | ||
| * | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p> | ||
| * | ||
| * @throws {@link BadGatewayException} (server fault) | ||
| * <p>There was an issue with a dependency due to a server issue. Retry your request.</p> | ||
| * | ||
| * @throws {@link ConflictException} (client fault) | ||
| * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p> | ||
| * | ||
| * @throws {@link DependencyFailedException} (client fault) | ||
| * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * <p>An internal server error occurred. Retry your request.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p> | ||
| * | ||
| * @throws {@link ServiceQuotaExceededException} (client fault) | ||
| * <p>The number of requests exceeds the service quota. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * <p>The number of requests exceeds the limit. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * <p>Input validation failed. Check your request parameters and retry the request.</p> | ||
| * | ||
| * @throws {@link BedrockAgentRuntimeServiceException} | ||
| * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p> | ||
| * | ||
| * @public | ||
| */ | ||
| export class GenerateQueryCommand extends $Command | ||
| .classBuilder< | ||
| GenerateQueryCommandInput, | ||
| GenerateQueryCommandOutput, | ||
| BedrockAgentRuntimeClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes | ||
| >() | ||
| .ep(commonParams) | ||
| .m(function (this: any, Command: any, cs: any, config: BedrockAgentRuntimeClientResolvedConfig, o: any) { | ||
| return [ | ||
| getSerdePlugin(config, this.serialize, this.deserialize), | ||
| getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
| ]; | ||
| }) | ||
| .s("AmazonBedrockAgentRunTimeService", "GenerateQuery", {}) | ||
| .n("BedrockAgentRuntimeClient", "GenerateQueryCommand") | ||
| .f(GenerateQueryRequestFilterSensitiveLog, GenerateQueryResponseFilterSensitiveLog) | ||
| .ser(se_GenerateQueryCommand) | ||
| .de(de_GenerateQueryCommand) | ||
| .build() { | ||
| /** @internal type navigation helper, not in runtime. */ | ||
| protected declare static __types: { | ||
| api: { | ||
| input: GenerateQueryRequest; | ||
| output: GenerateQueryResponse; | ||
| }; | ||
| sdk: { | ||
| input: GenerateQueryCommandInput; | ||
| output: GenerateQueryCommandOutput; | ||
| }; | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.