{ "version": "2.0", "metadata": { "apiVersion": "2023-07-26", "endpointPrefix": "bedrock-agent-runtime", "jsonVersion": "1.1", "protocol": "rest-json", "serviceFullName": "Agents for Amazon Bedrock Runtime", "serviceId": "Bedrock Agent Runtime", "signatureVersion": "v4", "signingName": "bedrock", "uid": "bedrock-agent-runtime-2023-07-26" }, "operations": { "InvokeAgent": { "http": { "requestUri": "/agents/{agentId}/agentAliases/{agentAliasId}/sessions/{sessionId}/text", "responseCode": 200 }, "input": { "type": "structure", "required": [ "agentAliasId", "agentId", "sessionId" ], "members": { "agentAliasId": { "location": "uri", "locationName": "agentAliasId" }, "agentId": { "location": "uri", "locationName": "agentId" }, "enableTrace": { "type": "boolean" }, "endSession": { "type": "boolean" }, "inputText": { "type": "string", "sensitive": true }, "sessionId": { "location": "uri", "locationName": "sessionId" }, "sessionState": { "type": "structure", "members": { "invocationId": {}, "promptSessionAttributes": { "type": "map", "key": {}, "value": {} }, "returnControlInvocationResults": { "type": "list", "member": { "type": "structure", "members": { "apiResult": { "type": "structure", "required": [ "actionGroup" ], "members": { "actionGroup": {}, "apiPath": { "shape": "Sd" }, "httpMethod": {}, "httpStatusCode": { "type": "integer" }, "responseBody": { "shape": "Sf" }, "responseState": {} } }, "functionResult": { "type": "structure", "required": [ "actionGroup" ], "members": { "actionGroup": {}, "function": {}, "responseBody": { "shape": "Sf" }, "responseState": {} } } }, "union": true } }, "sessionAttributes": { "type": "map", "key": {}, "value": {} } } } } }, "output": { "type": "structure", "required": [ "completion", "contentType", "sessionId" ], "members": { "completion": { "type": "structure", "members": { "accessDeniedException": { "type": "structure", "members": { "message": {} }, "error": { "httpStatusCode": 403, "senderFault": true }, "exception": true }, "badGatewayException": { "type": "structure", "members": { "message": {}, "resourceName": {} }, "error": { "httpStatusCode": 502 }, "exception": true, "fault": true }, "chunk": { "type": "structure", "members": { "attribution": { "type": "structure", "members": { "citations": { "shape": "Sr" } } }, "bytes": { "type": "blob", "sensitive": true } }, "event": true, "sensitive": true }, "conflictException": { "type": "structure", "members": { "message": {} }, "error": { "httpStatusCode": 409, "senderFault": true }, "exception": true }, "dependencyFailedException": { "type": "structure", "members": { "message": {}, "resourceName": {} }, "error": { "httpStatusCode": 424, "senderFault": true }, "exception": true }, "internalServerException": { "type": "structure", "members": { "message": {} }, "error": { "httpStatusCode": 500 }, "exception": true, "fault": true }, "resourceNotFoundException": { "type": "structure", "members": { "message": {} }, "error": { "httpStatusCode": 404, "senderFault": true }, "exception": true }, "returnControl": { "type": "structure", "members": { "invocationId": {}, "invocationInputs": { "type": "list", "member": { "type": "structure", "members": { "apiInvocationInput": { "type": "structure", "required": [ "actionGroup" ], "members": { "actionGroup": {}, "apiPath": { "shape": "Sd" }, "httpMethod": {}, "parameters": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "type": {}, "value": {} } } }, "requestBody": { "type": "structure", "members": { "content": { "type": "map", "key": {}, "value": { "type": "structure", "members": { "properties": { "type": "list", "member": { "shape": "S1m" } } } } } } } } }, "functionInvocationInput": { "type": "structure", "required": [ "actionGroup" ], "members": { "actionGroup": {}, "function": {}, "parameters": { "type": "list", "member": { "type": "structure", "members": { "name": {}, "type": {}, "value": {} } } } } } }, "union": true } } }, "event": true, "sensitive": true }, "serviceQuotaExceededException": { "type": "structure", "members": { "message": {} }, "error": { "httpStatusCode": 400, "senderFault": true }, "exception": true }, "throttlingException": { "type": "structure", "members": { "message": {} }, "error": { "httpStatusCode": 429, "senderFault": true }, "exception": true }, "trace": { "type": "structure", "members": { "agentAliasId": {}, "agentId": {}, "agentVersion": {}, "sessionId": {}, "trace": { "type": "structure", "members": { "failureTrace": { "type": "structure", "members": { "failureReason": { "type": "string", "sensitive": true }, "traceId": {} }, "sensitive": true }, "orchestrationTrace": { "type": "structure", "members": { "invocationInput": { "type": "structure", "members": { "actionGroupInvocationInput": { "type": "structure", "members": { "actionGroupName": { "type": "string", "sensitive": true }, "apiPath": { "shape": "Sd" }, "function": { "type": "string", "sensitive": true }, "parameters": { "shape": "S23" }, "requestBody": { "type": "structure", "members": { "content": { "type": "map", "key": {}, "value": { "shape": "S23" } } } }, "verb": { "type": "string", "sensitive": true } } }, "invocationType": {}, "knowledgeBaseLookupInput": { "type": "structure", "members": { "knowledgeBaseId": { "type": "string", "sensitive": true }, "text": { "type": "string", "sensitive": true } } }, "traceId": {} }, "sensitive": true }, "modelInvocationInput": { "shape": "S2b" }, "observation": { "type": "structure", "members": { "actionGroupInvocationOutput": { "type": "structure", "members": { "text": { "type": "string", "sensitive": true } } }, "finalResponse": { "type": "structure", "members": { "text": { "type": "string", "sensitive": true } } }, "knowledgeBaseLookupOutput": { "type": "structure", "members": { "retrievedReferences": { "shape": "Sy" } } }, "repromptResponse": { "type": "structure", "members": { "source": { "type": "string", "sensitive": true }, "text": {} }, "sensitive": true }, "traceId": {}, "type": {} }, "sensitive": true }, "rationale": { "type": "structure", "members": { "text": { "shape": "S2w" }, "traceId": {} }, "sensitive": true } }, "sensitive": true, "union": true }, "postProcessingTrace": { "type": "structure", "members": { "modelInvocationInput": { "shape": "S2b" }, "modelInvocationOutput": { "type": "structure", "members": { "parsedResponse": { "type": "structure", "members": { "text": { "type": "string", "sensitive": true } }, "sensitive": true }, "traceId": {} }, "sensitive": true } }, "sensitive": true, "union": true }, "preProcessingTrace": { "type": "structure", "members": { "modelInvocationInput": { "shape": "S2b" }, "modelInvocationOutput": { "type": "structure", "members": { "parsedResponse": { "type": "structure", "members": { "isValid": { "type": "boolean" }, "rationale": { "shape": "S2w" } }, "sensitive": true }, "traceId": {} }, "sensitive": true } }, "sensitive": true, "union": true } }, "sensitive": true, "union": true } }, "event": true, "sensitive": true }, "validationException": { "type": "structure", "members": { "message": {} }, "error": { "httpStatusCode": 400, "senderFault": true }, "exception": true } }, "eventstream": true }, "contentType": { "location": "header", "locationName": "x-amzn-bedrock-agent-content-type" }, "sessionId": { "location": "header", "locationName": "x-amz-bedrock-agent-session-id" } }, "payload": "completion" } }, "Retrieve": { "http": { "requestUri": "/knowledgebases/{knowledgeBaseId}/retrieve", "responseCode": 200 }, "input": { "type": "structure", "required": [ "knowledgeBaseId", "retrievalQuery" ], "members": { "knowledgeBaseId": { "location": "uri", "locationName": "knowledgeBaseId" }, "nextToken": {}, "retrievalConfiguration": { "shape": "S39" }, "retrievalQuery": { "type": "structure", "required": [ "text" ], "members": { "text": {} }, "sensitive": true } } }, "output": { "type": "structure", "required": [ "retrievalResults" ], "members": { "nextToken": {}, "retrievalResults": { "type": "list", "member": { "type": "structure", "required": [ "content" ], "members": { "content": { "shape": "S10" }, "location": { "shape": "S11" }, "metadata": { "shape": "S14" }, "score": { "type": "double" } } }, "sensitive": true } } } }, "RetrieveAndGenerate": { "http": { "requestUri": "/retrieveAndGenerate", "responseCode": 200 }, "input": { "type": "structure", "required": [ "input" ], "members": { "input": { "type": "structure", "required": [ "text" ], "members": { "text": {} }, "sensitive": true }, "retrieveAndGenerateConfiguration": { "type": "structure", "required": [ "type" ], "members": { "externalSourcesConfiguration": { "type": "structure", "required": [ "modelArn", "sources" ], "members": { "generationConfiguration": { "type": "structure", "members": { "additionalModelRequestFields": { "shape": "S3u" }, "guardrailConfiguration": { "shape": "S3x" }, "inferenceConfig": { "shape": "S40" }, "promptTemplate": { "shape": "S45" } } }, "modelArn": {}, "sources": { "type": "list", "member": { "type": "structure", "required": [ "sourceType" ], "members": { "byteContent": { "type": "structure", "required": [ "contentType", "data", "identifier" ], "members": { "contentType": {}, "data": { "type": "blob", "sensitive": true }, "identifier": { "type": "string", "sensitive": true } } }, "s3Location": { "type": "structure", "required": [ "uri" ], "members": { "uri": {} } }, "sourceType": {} } } } } }, "knowledgeBaseConfiguration": { "type": "structure", "required": [ "knowledgeBaseId", "modelArn" ], "members": { "generationConfiguration": { "type": "structure", "members": { "additionalModelRequestFields": { "shape": "S3u" }, "guardrailConfiguration": { "shape": "S3x" }, "inferenceConfig": { "shape": "S40" }, "promptTemplate": { "shape": "S45" } } }, "knowledgeBaseId": {}, "modelArn": {}, "retrievalConfiguration": { "shape": "S39" } } }, "type": {} } }, "sessionConfiguration": { "type": "structure", "required": [ "kmsKeyArn" ], "members": { "kmsKeyArn": {} } }, "sessionId": {} } }, "output": { "type": "structure", "required": [ "output", "sessionId" ], "members": { "citations": { "shape": "Sr" }, "guardrailAction": {}, "output": { "type": "structure", "required": [ "text" ], "members": { "text": {} }, "sensitive": true }, "sessionId": {} } } } }, "shapes": { "Sd": { "type": "string", "sensitive": true }, "Sf": { "type": "map", "key": {}, "value": { "type": "structure", "members": { "body": {} } } }, "Sr": { "type": "list", "member": { "type": "structure", "members": { "generatedResponsePart": { "type": "structure", "members": { "textResponsePart": { "type": "structure", "members": { "span": { "type": "structure", "members": { "end": { "type": "integer" }, "start": { "type": "integer" } } }, "text": {} }, "sensitive": true } } }, "retrievedReferences": { "shape": "Sy" } } } }, "Sy": { "type": "list", "member": { "type": "structure", "members": { "content": { "shape": "S10" }, "location": { "shape": "S11" }, "metadata": { "shape": "S14" } } } }, "S10": { "type": "structure", "required": [ "text" ], "members": { "text": {} }, "sensitive": true }, "S11": { "type": "structure", "required": [ "type" ], "members": { "s3Location": { "type": "structure", "members": { "uri": {} } }, "type": {} }, "sensitive": true }, "S14": { "type": "map", "key": {}, "value": { "type": "structure", "members": {}, "document": true }, "sensitive": true }, "S1m": { "type": "structure", "members": { "name": {}, "type": {}, "value": {} } }, "S23": { "type": "list", "member": { "shape": "S1m" } }, "S2b": { "type": "structure", "members": { "inferenceConfiguration": { "type": "structure", "members": { "maximumLength": { "type": "integer" }, "stopSequences": { "type": "list", "member": {} }, "temperature": { "type": "float" }, "topK": { "type": "integer" }, "topP": { "type": "float" } } }, "overrideLambda": {}, "parserMode": {}, "promptCreationMode": {}, "text": { "type": "string", "sensitive": true }, "traceId": {}, "type": {} }, "sensitive": true }, "S2w": { "type": "string", "sensitive": true }, "S39": { "type": "structure", "required": [ "vectorSearchConfiguration" ], "members": { "vectorSearchConfiguration": { "type": "structure", "members": { "filter": { "shape": "S3b" }, "numberOfResults": { "type": "integer" }, "overrideSearchType": {} } } } }, "S3b": { "type": "structure", "members": { "andAll": { "shape": "S3c" }, "equals": { "shape": "S3d" }, "greaterThan": { "shape": "S3d" }, "greaterThanOrEquals": { "shape": "S3d" }, "in": { "shape": "S3d" }, "lessThan": { "shape": "S3d" }, "lessThanOrEquals": { "shape": "S3d" }, "notEquals": { "shape": "S3d" }, "notIn": { "shape": "S3d" }, "orAll": { "shape": "S3c" }, "startsWith": { "shape": "S3d" } }, "sensitive": true, "union": true }, "S3c": { "type": "list", "member": { "shape": "S3b" } }, "S3d": { "type": "structure", "required": [ "key", "value" ], "members": { "key": {}, "value": { "type": "structure", "members": {}, "document": true } } }, "S3u": { "type": "map", "key": {}, "value": { "type": "structure", "members": {}, "document": true } }, "S3x": { "type": "structure", "required": [ "guardrailId", "guardrailVersion" ], "members": { "guardrailId": {}, "guardrailVersion": {} } }, "S40": { "type": "structure", "members": { "textInferenceConfig": { "type": "structure", "members": { "maxTokens": { "type": "integer" }, "stopSequences": { "type": "list", "member": {} }, "temperature": { "type": "float" }, "topP": { "type": "float" } } } } }, "S45": { "type": "structure", "members": { "textPromptTemplate": { "type": "string", "sensitive": true } } } } }