|
37 | 37 | "documentation":"<p>Deletes memory from the specified memory identifier.</p>",
|
38 | 38 | "idempotent":true
|
39 | 39 | },
|
| 40 | + "GenerateQuery":{ |
| 41 | + "name":"GenerateQuery", |
| 42 | + "http":{ |
| 43 | + "method":"POST", |
| 44 | + "requestUri":"/generateQuery", |
| 45 | + "responseCode":200 |
| 46 | + }, |
| 47 | + "input":{"shape":"GenerateQueryRequest"}, |
| 48 | + "output":{"shape":"GenerateQueryResponse"}, |
| 49 | + "errors":[ |
| 50 | + {"shape":"ConflictException"}, |
| 51 | + {"shape":"ResourceNotFoundException"}, |
| 52 | + {"shape":"ValidationException"}, |
| 53 | + {"shape":"InternalServerException"}, |
| 54 | + {"shape":"DependencyFailedException"}, |
| 55 | + {"shape":"BadGatewayException"}, |
| 56 | + {"shape":"ThrottlingException"}, |
| 57 | + {"shape":"AccessDeniedException"}, |
| 58 | + {"shape":"ServiceQuotaExceededException"} |
| 59 | + ], |
| 60 | + "documentation":"<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>" |
| 61 | + }, |
40 | 62 | "GetAgentMemory":{
|
41 | 63 | "name":"GetAgentMemory",
|
42 | 64 | "http":{
|
|
1737 | 1759 | "type":"list",
|
1738 | 1760 | "member":{"shape":"FunctionDefinition"}
|
1739 | 1761 | },
|
| 1762 | + "GenerateQueryRequest":{ |
| 1763 | + "type":"structure", |
| 1764 | + "required":[ |
| 1765 | + "queryGenerationInput", |
| 1766 | + "transformationConfiguration" |
| 1767 | + ], |
| 1768 | + "members":{ |
| 1769 | + "queryGenerationInput":{ |
| 1770 | + "shape":"QueryGenerationInput", |
| 1771 | + "documentation":"<p>Specifies information about a natural language query to transform into SQL.</p>" |
| 1772 | + }, |
| 1773 | + "transformationConfiguration":{ |
| 1774 | + "shape":"TransformationConfiguration", |
| 1775 | + "documentation":"<p>Specifies configurations for transforming the natural language query into SQL.</p>" |
| 1776 | + } |
| 1777 | + } |
| 1778 | + }, |
| 1779 | + "GenerateQueryResponse":{ |
| 1780 | + "type":"structure", |
| 1781 | + "members":{ |
| 1782 | + "queries":{ |
| 1783 | + "shape":"GeneratedQueries", |
| 1784 | + "documentation":"<p>A list of objects, each of which defines a generated query that can correspond to the natural language queries.</p>" |
| 1785 | + } |
| 1786 | + } |
| 1787 | + }, |
| 1788 | + "GeneratedQueries":{ |
| 1789 | + "type":"list", |
| 1790 | + "member":{"shape":"GeneratedQuery"}, |
| 1791 | + "min":0 |
| 1792 | + }, |
| 1793 | + "GeneratedQuery":{ |
| 1794 | + "type":"structure", |
| 1795 | + "members":{ |
| 1796 | + "sql":{ |
| 1797 | + "shape":"String", |
| 1798 | + "documentation":"<p>An SQL query that corresponds to the natural language query.</p>" |
| 1799 | + }, |
| 1800 | + "type":{ |
| 1801 | + "shape":"GeneratedQueryType", |
| 1802 | + "documentation":"<p>The type of transformed query.</p>" |
| 1803 | + } |
| 1804 | + }, |
| 1805 | + "documentation":"<p>Contains information about a query generated for a natural language query.</p>", |
| 1806 | + "sensitive":true |
| 1807 | + }, |
| 1808 | + "GeneratedQueryType":{ |
| 1809 | + "type":"string", |
| 1810 | + "enum":["REDSHIFT_SQL"] |
| 1811 | + }, |
1740 | 1812 | "GeneratedResponsePart":{
|
1741 | 1813 | "type":"structure",
|
1742 | 1814 | "members":{
|
|
2485 | 2557 | "documentation":"<p>Contains information about the prompt to optimize.</p>",
|
2486 | 2558 | "union":true
|
2487 | 2559 | },
|
| 2560 | + "InputQueryType":{ |
| 2561 | + "type":"string", |
| 2562 | + "enum":["TEXT"] |
| 2563 | + }, |
2488 | 2564 | "InputText":{
|
2489 | 2565 | "type":"string",
|
2490 | 2566 | "max":25000000,
|
|
2838 | 2914 | },
|
2839 | 2915 | "documentation":"<p> Details of the knowledge base associated withe inline agent. </p>"
|
2840 | 2916 | },
|
| 2917 | + "KnowledgeBaseArn":{ |
| 2918 | + "type":"string", |
| 2919 | + "max":128, |
| 2920 | + "min":0, |
| 2921 | + "pattern":"^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" |
| 2922 | + }, |
2841 | 2923 | "KnowledgeBaseConfiguration":{
|
2842 | 2924 | "type":"structure",
|
2843 | 2925 | "required":[
|
|
2929 | 3011 | "members":{
|
2930 | 3012 | "content":{
|
2931 | 3013 | "shape":"RetrievalResultContent",
|
2932 |
| - "documentation":"<p>Contains a chunk of text from a data source in the knowledge base.</p>" |
| 3014 | + "documentation":"<p>Contains information about the content of the chunk.</p>" |
2933 | 3015 | },
|
2934 | 3016 | "location":{
|
2935 | 3017 | "shape":"RetrievalResultLocation",
|
|
3807 | 3889 | },
|
3808 | 3890 | "documentation":"<p>Contains the parameters in the request body.</p>"
|
3809 | 3891 | },
|
| 3892 | + "QueryGenerationInput":{ |
| 3893 | + "type":"structure", |
| 3894 | + "required":[ |
| 3895 | + "text", |
| 3896 | + "type" |
| 3897 | + ], |
| 3898 | + "members":{ |
| 3899 | + "text":{ |
| 3900 | + "shape":"QueryGenerationInputTextString", |
| 3901 | + "documentation":"<p>The text of the query.</p>" |
| 3902 | + }, |
| 3903 | + "type":{ |
| 3904 | + "shape":"InputQueryType", |
| 3905 | + "documentation":"<p>The type of the query.</p>" |
| 3906 | + } |
| 3907 | + }, |
| 3908 | + "documentation":"<p>Contains information about a natural language query to transform into SQL.</p>", |
| 3909 | + "sensitive":true |
| 3910 | + }, |
| 3911 | + "QueryGenerationInputTextString":{ |
| 3912 | + "type":"string", |
| 3913 | + "max":20000, |
| 3914 | + "min":1 |
| 3915 | + }, |
3810 | 3916 | "QueryTransformationConfiguration":{
|
3811 | 3917 | "type":"structure",
|
3812 | 3918 | "required":["type"],
|
|
3818 | 3924 | },
|
3819 | 3925 | "documentation":"<p>To split up the prompt and retrieve multiple sources, set the transformation type to <code>QUERY_DECOMPOSITION</code>.</p>"
|
3820 | 3926 | },
|
| 3927 | + "QueryTransformationMode":{ |
| 3928 | + "type":"string", |
| 3929 | + "enum":["TEXT_TO_SQL"] |
| 3930 | + }, |
3821 | 3931 | "QueryTransformationType":{
|
3822 | 3932 | "type":"string",
|
3823 | 3933 | "enum":["QUERY_DECOMPOSITION"]
|
|
4286 | 4396 | },
|
4287 | 4397 | "RetrievalResultContent":{
|
4288 | 4398 | "type":"structure",
|
4289 |
| - "required":["text"], |
4290 | 4399 | "members":{
|
| 4400 | + "byteContent":{ |
| 4401 | + "shape":"String", |
| 4402 | + "documentation":"<p>A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: <code>data:image/jpeg;base64,${base64-encoded string}</code>.</p>" |
| 4403 | + }, |
| 4404 | + "row":{ |
| 4405 | + "shape":"RetrievalResultContentRow", |
| 4406 | + "documentation":"<p>Specifies information about the rows with the cells to return in retrieval.</p>" |
| 4407 | + }, |
4291 | 4408 | "text":{
|
4292 | 4409 | "shape":"String",
|
4293 | 4410 | "documentation":"<p>The cited text from the data source.</p>"
|
| 4411 | + }, |
| 4412 | + "type":{ |
| 4413 | + "shape":"RetrievalResultContentType", |
| 4414 | + "documentation":"<p>The type of content in the retrieval result.</p>" |
| 4415 | + } |
| 4416 | + }, |
| 4417 | + "documentation":"<p>Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax\">Retrieve response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax\">RetrieveAndGenerate response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax\">InvokeAgent response</a> – in the <code>content</code> field</p> </li> </ul>", |
| 4418 | + "sensitive":true |
| 4419 | + }, |
| 4420 | + "RetrievalResultContentColumn":{ |
| 4421 | + "type":"structure", |
| 4422 | + "members":{ |
| 4423 | + "columnName":{ |
| 4424 | + "shape":"String", |
| 4425 | + "documentation":"<p>The name of the column.</p>" |
| 4426 | + }, |
| 4427 | + "columnValue":{ |
| 4428 | + "shape":"String", |
| 4429 | + "documentation":"<p>The value in the column.</p>" |
| 4430 | + }, |
| 4431 | + "type":{ |
| 4432 | + "shape":"RetrievalResultContentColumnType", |
| 4433 | + "documentation":"<p>The data type of the value.</p>" |
4294 | 4434 | }
|
4295 | 4435 | },
|
4296 |
| - "documentation":"<p>Contains the cited text from the data source.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax\">Retrieve response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax\">RetrieveAndGenerate response</a> – in the <code>content</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax\">InvokeAgent response</a> – in the <code>content</code> field</p> </li> </ul>", |
| 4436 | + "documentation":"<p>Contains information about a column with a cell to return in retrieval.</p>", |
| 4437 | + "sensitive":true |
| 4438 | + }, |
| 4439 | + "RetrievalResultContentColumnType":{ |
| 4440 | + "type":"string", |
| 4441 | + "enum":[ |
| 4442 | + "BLOB", |
| 4443 | + "BOOLEAN", |
| 4444 | + "DOUBLE", |
| 4445 | + "NULL", |
| 4446 | + "LONG", |
| 4447 | + "STRING" |
| 4448 | + ] |
| 4449 | + }, |
| 4450 | + "RetrievalResultContentRow":{ |
| 4451 | + "type":"list", |
| 4452 | + "member":{"shape":"RetrievalResultContentColumn"}, |
4297 | 4453 | "sensitive":true
|
4298 | 4454 | },
|
| 4455 | + "RetrievalResultContentType":{ |
| 4456 | + "type":"string", |
| 4457 | + "enum":[ |
| 4458 | + "TEXT", |
| 4459 | + "IMAGE", |
| 4460 | + "ROW" |
| 4461 | + ] |
| 4462 | + }, |
4299 | 4463 | "RetrievalResultCustomDocumentLocation":{
|
4300 | 4464 | "type":"structure",
|
4301 | 4465 | "members":{
|
|
4306 | 4470 | },
|
4307 | 4471 | "documentation":"<p>Contains information about the location of a document in a custom data source.</p>"
|
4308 | 4472 | },
|
| 4473 | + "RetrievalResultKendraDocumentLocation":{ |
| 4474 | + "type":"structure", |
| 4475 | + "members":{ |
| 4476 | + "uri":{ |
| 4477 | + "shape":"String", |
| 4478 | + "documentation":"<p>The document's uri.</p>" |
| 4479 | + } |
| 4480 | + }, |
| 4481 | + "documentation":"<p>The location of a result in Amazon Kendra.</p>" |
| 4482 | + }, |
4309 | 4483 | "RetrievalResultLocation":{
|
4310 | 4484 | "type":"structure",
|
4311 | 4485 | "required":["type"],
|
|
4318 | 4492 | "shape":"RetrievalResultCustomDocumentLocation",
|
4319 | 4493 | "documentation":"<p>Specifies the location of a document in a custom data source.</p>"
|
4320 | 4494 | },
|
| 4495 | + "kendraDocumentLocation":{ |
| 4496 | + "shape":"RetrievalResultKendraDocumentLocation", |
| 4497 | + "documentation":"<p>The location of a document in Amazon Kendra.</p>" |
| 4498 | + }, |
4321 | 4499 | "s3Location":{
|
4322 | 4500 | "shape":"RetrievalResultS3Location",
|
4323 | 4501 | "documentation":"<p>The S3 data source location.</p>"
|
|
4330 | 4508 | "shape":"RetrievalResultSharePointLocation",
|
4331 | 4509 | "documentation":"<p>The SharePoint data source location.</p>"
|
4332 | 4510 | },
|
| 4511 | + "sqlLocation":{ |
| 4512 | + "shape":"RetrievalResultSqlLocation", |
| 4513 | + "documentation":"<p>Specifies information about the SQL query used to retrieve the result.</p>" |
| 4514 | + }, |
4333 | 4515 | "type":{
|
4334 | 4516 | "shape":"RetrievalResultLocationType",
|
4335 | 4517 | "documentation":"<p>The type of data source location.</p>"
|
|
4339 | 4521 | "documentation":"<p>The web URL/URLs data source location.</p>"
|
4340 | 4522 | }
|
4341 | 4523 | },
|
4342 |
| - "documentation":"<p>Contains information about the data source location.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax\">Retrieve response</a> – in the <code>location</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax\">RetrieveAndGenerate response</a> – in the <code>location</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax\">InvokeAgent response</a> – in the <code>locatino</code> field</p> </li> </ul>", |
| 4524 | + "documentation":"<p>Contains information about the data source location.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax\">Retrieve response</a> – in the <code>location</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax\">RetrieveAndGenerate response</a> – in the <code>location</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax\">InvokeAgent response</a> – in the <code>location</code> field</p> </li> </ul>", |
4343 | 4525 | "sensitive":true
|
4344 | 4526 | },
|
4345 | 4527 | "RetrievalResultLocationType":{
|
|
4350 | 4532 | "CONFLUENCE",
|
4351 | 4533 | "SALESFORCE",
|
4352 | 4534 | "SHAREPOINT",
|
4353 |
| - "CUSTOM" |
| 4535 | + "CUSTOM", |
| 4536 | + "KENDRA", |
| 4537 | + "SQL" |
4354 | 4538 | ]
|
4355 | 4539 | },
|
4356 | 4540 | "RetrievalResultMetadata":{
|
|
4401 | 4585 | },
|
4402 | 4586 | "documentation":"<p>The SharePoint data source location.</p>"
|
4403 | 4587 | },
|
| 4588 | + "RetrievalResultSqlLocation":{ |
| 4589 | + "type":"structure", |
| 4590 | + "members":{ |
| 4591 | + "query":{ |
| 4592 | + "shape":"String", |
| 4593 | + "documentation":"<p>The SQL query used to retrieve the result.</p>" |
| 4594 | + } |
| 4595 | + }, |
| 4596 | + "documentation":"<p>Contains information about the SQL query used to retrieve the result.</p>" |
| 4597 | + }, |
4404 | 4598 | "RetrievalResultWebLocation":{
|
4405 | 4599 | "type":"structure",
|
4406 | 4600 | "members":{
|
|
5038 | 5232 | "documentation":"<p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax\">RetrieveAndGenerate response</a> – in the <code>textResponsePart</code> field</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax\">InvokeAgent response</a> – in the <code>textResponsePart</code> field</p> </li> </ul>",
|
5039 | 5233 | "sensitive":true
|
5040 | 5234 | },
|
| 5235 | + "TextToSqlConfiguration":{ |
| 5236 | + "type":"structure", |
| 5237 | + "required":["type"], |
| 5238 | + "members":{ |
| 5239 | + "knowledgeBaseConfiguration":{ |
| 5240 | + "shape":"TextToSqlKnowledgeBaseConfiguration", |
| 5241 | + "documentation":"<p>Specifies configurations for a knowledge base to use in transformation.</p>" |
| 5242 | + }, |
| 5243 | + "type":{ |
| 5244 | + "shape":"TextToSqlConfigurationType", |
| 5245 | + "documentation":"<p>The type of resource to use in transformation.</p>" |
| 5246 | + } |
| 5247 | + }, |
| 5248 | + "documentation":"<p>Contains configurations for transforming text to SQL.</p>" |
| 5249 | + }, |
| 5250 | + "TextToSqlConfigurationType":{ |
| 5251 | + "type":"string", |
| 5252 | + "enum":["KNOWLEDGE_BASE"] |
| 5253 | + }, |
| 5254 | + "TextToSqlKnowledgeBaseConfiguration":{ |
| 5255 | + "type":"structure", |
| 5256 | + "required":["knowledgeBaseArn"], |
| 5257 | + "members":{ |
| 5258 | + "knowledgeBaseArn":{ |
| 5259 | + "shape":"KnowledgeBaseArn", |
| 5260 | + "documentation":"<p>The ARN of the knowledge base</p>" |
| 5261 | + } |
| 5262 | + }, |
| 5263 | + "documentation":"<p>Contains configurations for a knowledge base to use in transformation.</p>" |
| 5264 | + }, |
5041 | 5265 | "ThrottlingException":{
|
5042 | 5266 | "type":"structure",
|
5043 | 5267 | "members":{
|
|
5143 | 5367 | "event":true,
|
5144 | 5368 | "sensitive":true
|
5145 | 5369 | },
|
| 5370 | + "TransformationConfiguration":{ |
| 5371 | + "type":"structure", |
| 5372 | + "required":["mode"], |
| 5373 | + "members":{ |
| 5374 | + "mode":{ |
| 5375 | + "shape":"QueryTransformationMode", |
| 5376 | + "documentation":"<p>The mode of the transformation.</p>" |
| 5377 | + }, |
| 5378 | + "textToSqlConfiguration":{ |
| 5379 | + "shape":"TextToSqlConfiguration", |
| 5380 | + "documentation":"<p>Specifies configurations for transforming text to SQL.</p>" |
| 5381 | + } |
| 5382 | + }, |
| 5383 | + "documentation":"<p>Contains configurations for transforming the natural language query into SQL.</p>" |
| 5384 | + }, |
5146 | 5385 | "Type":{
|
5147 | 5386 | "type":"string",
|
5148 | 5387 | "enum":[
|
|
0 commit comments