|
116 | 116 | "BedrockModelArn": { |
117 | 117 | "base": null, |
118 | 118 | "refs": { |
| 119 | + "ExternalSourcesRetrieveAndGenerateConfiguration$modelArn": "<p>The modelArn used with the external source wrapper object in the retrieveAndGenerate function.</p>", |
119 | 120 | "KnowledgeBaseRetrieveAndGenerateConfiguration$modelArn": "<p>The ARN of the foundation model used to generate a response.</p>" |
120 | 121 | } |
121 | 122 | }, |
|
127 | 128 | "PreProcessingParsedResponse$isValid": "<p>Whether the user input is valid or not. If <code>false</code>, the agent doesn't proceed to orchestration.</p>" |
128 | 129 | } |
129 | 130 | }, |
| 131 | + "ByteContentBlob": { |
| 132 | + "base": null, |
| 133 | + "refs": { |
| 134 | + "ByteContentDoc$data": "<p>The byte value of the file to upload, encoded as a Base-64 string.</p>" |
| 135 | + } |
| 136 | + }, |
| 137 | + "ByteContentDoc": { |
| 138 | + "base": "<p>This property contains the document to chat with, along with its attributes.</p>", |
| 139 | + "refs": { |
| 140 | + "ExternalSource$byteContent": "<p>The identifier, contentType, and data of the external source wrapper object.</p>" |
| 141 | + } |
| 142 | + }, |
130 | 143 | "Citation": { |
131 | 144 | "base": "<p>An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the 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>citations</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>citations</code> field</p> </li> </ul>", |
132 | 145 | "refs": { |
|
158 | 171 | "RequestBody$content": "<p>The content in the request body.</p>" |
159 | 172 | } |
160 | 173 | }, |
| 174 | + "ContentType": { |
| 175 | + "base": null, |
| 176 | + "refs": { |
| 177 | + "ByteContentDoc$contentType": "<p>The MIME type of the document contained in the wrapper object.</p>" |
| 178 | + } |
| 179 | + }, |
161 | 180 | "CreationMode": { |
162 | 181 | "base": null, |
163 | 182 | "refs": { |
|
177 | 196 | "KnowledgeBaseRetrievalResult$score": "<p>The level of relevance of the result to the query.</p>" |
178 | 197 | } |
179 | 198 | }, |
| 199 | + "ExternalSource": { |
| 200 | + "base": "<p>The unique external source of the content contained in the wrapper object.</p>", |
| 201 | + "refs": { |
| 202 | + "ExternalSources$member": null |
| 203 | + } |
| 204 | + }, |
| 205 | + "ExternalSourceType": { |
| 206 | + "base": null, |
| 207 | + "refs": { |
| 208 | + "ExternalSource$sourceType": "<p>The source type of the external source wrapper object.</p>" |
| 209 | + } |
| 210 | + }, |
| 211 | + "ExternalSources": { |
| 212 | + "base": null, |
| 213 | + "refs": { |
| 214 | + "ExternalSourcesRetrieveAndGenerateConfiguration$sources": "<p>The document used with the external source wrapper object in the retrieveAndGenerate function.</p>" |
| 215 | + } |
| 216 | + }, |
| 217 | + "ExternalSourcesGenerationConfiguration": { |
| 218 | + "base": "<p>Contains the generation configuration of the external source wrapper object.</p>", |
| 219 | + "refs": { |
| 220 | + "ExternalSourcesRetrieveAndGenerateConfiguration$generationConfiguration": "<p>The prompt used with the external source wrapper object with the retrieveAndGenerate function.</p>" |
| 221 | + } |
| 222 | + }, |
| 223 | + "ExternalSourcesRetrieveAndGenerateConfiguration": { |
| 224 | + "base": "<p>The configurations of the external source wrapper object in the retrieveAndGenerate function.</p>", |
| 225 | + "refs": { |
| 226 | + "RetrieveAndGenerateConfiguration$externalSourcesConfiguration": "<p>The configuration used with the external source wrapper object in the retrieveAndGenerate function.</p>" |
| 227 | + } |
| 228 | + }, |
180 | 229 | "FailureReasonString": { |
181 | 230 | "base": null, |
182 | 231 | "refs": { |
|
269 | 318 | "KnowledgeBaseRetrieveAndGenerateConfiguration$generationConfiguration": "<p>Contains configurations for response generation based on the knowwledge base query results.</p>" |
270 | 319 | } |
271 | 320 | }, |
| 321 | + "Identifier": { |
| 322 | + "base": null, |
| 323 | + "refs": { |
| 324 | + "ByteContentDoc$identifier": "<p>The file name of the document contained in the wrapper object.</p>" |
| 325 | + } |
| 326 | + }, |
272 | 327 | "InferenceConfiguration": { |
273 | 328 | "base": "<p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html\">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html\">Inference parameters for foundation models</a>.</p>", |
274 | 329 | "refs": { |
|
557 | 612 | "PromptTemplate": { |
558 | 613 | "base": "<p>Contains the template for the prompt that's sent to the model for response generation. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt\">Knowledge base prompt templates</a>.</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_RequestSyntax\">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p> </li> </ul>", |
559 | 614 | "refs": { |
| 615 | + "ExternalSourcesGenerationConfiguration$promptTemplate": "<p>Contain the textPromptTemplate string for the external source wrapper object.</p>", |
560 | 616 | "GenerationConfiguration$promptTemplate": "<p>Contains the template for the prompt that's sent to the model for response generation.</p>" |
561 | 617 | } |
562 | 618 | }, |
|
769 | 825 | "ResponseStream$returnControl": "<p>Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.</p>" |
770 | 826 | } |
771 | 827 | }, |
| 828 | + "S3ObjectDoc": { |
| 829 | + "base": "<p>The unique wrapper object of the document from the S3 location.</p>", |
| 830 | + "refs": { |
| 831 | + "ExternalSource$s3Location": "<p>The S3 location of the external source wrapper object.</p>" |
| 832 | + } |
| 833 | + }, |
| 834 | + "S3Uri": { |
| 835 | + "base": null, |
| 836 | + "refs": { |
| 837 | + "S3ObjectDoc$uri": "<p>The file location of the S3 wrapper object.</p>" |
| 838 | + } |
| 839 | + }, |
772 | 840 | "SearchType": { |
773 | 841 | "base": null, |
774 | 842 | "refs": { |
|
0 commit comments