|
219 | 219 | {"shape":"AccessDeniedException"}, |
220 | 220 | {"shape":"ServiceQuotaExceededException"} |
221 | 221 | ], |
222 | | - "documentation":"<note> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events\">Trace enablement</a>.</p> </li> <li> <p>To stream agent responses, make sure that only orchestration prompt is enabled. Agent streaming is not supported for the following steps: </p> <ul> <li> <p> <code>Pre-processing</code> </p> </li> <li> <p> <code>Post-processing</code> </p> </li> <li> <p>Agent with 1 Knowledge base and <code>User Input</code> not enabled</p> </li> </ul> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response contains both <b>chunk</b> and <b>trace</b> attributes.</p> <p>The final response is returned in the <code>bytes</code> field of the <code>chunk</code> object. The <code>InvokeAgent</code> returns one chunk for the entire interaction.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>" |
| 222 | + "documentation":"<note> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events\">Trace enablement</a>.</p> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response contains both <b>chunk</b> and <b>trace</b> attributes.</p> <p>The final response is returned in the <code>bytes</code> field of the <code>chunk</code> object. The <code>InvokeAgent</code> returns one chunk for the entire interaction.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>" |
223 | 223 | }, |
224 | 224 | "InvokeFlow":{ |
225 | 225 | "name":"InvokeFlow", |
|
2081 | 2081 | "shape":"FlowTraceConditionNodeResultEvent", |
2082 | 2082 | "documentation":"<p>Contains information about an output from a condition node.</p>" |
2083 | 2083 | }, |
| 2084 | + "nodeActionTrace":{ |
| 2085 | + "shape":"FlowTraceNodeActionEvent", |
| 2086 | + "documentation":"<p>Contains information about an action (operation) called by a node. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html\">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>" |
| 2087 | + }, |
2084 | 2088 | "nodeInputTrace":{ |
2085 | 2089 | "shape":"FlowTraceNodeInputEvent", |
2086 | 2090 | "documentation":"<p>Contains information about the input into a node.</p>" |
|
2148 | 2152 | "documentation":"<p>Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html\">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>", |
2149 | 2153 | "event":true |
2150 | 2154 | }, |
| 2155 | + "FlowTraceNodeActionEvent":{ |
| 2156 | + "type":"structure", |
| 2157 | + "required":[ |
| 2158 | + "nodeName", |
| 2159 | + "operationName", |
| 2160 | + "requestId", |
| 2161 | + "serviceName", |
| 2162 | + "timestamp" |
| 2163 | + ], |
| 2164 | + "members":{ |
| 2165 | + "nodeName":{ |
| 2166 | + "shape":"NodeName", |
| 2167 | + "documentation":"<p>The name of the node that called the operation.</p>" |
| 2168 | + }, |
| 2169 | + "operationName":{ |
| 2170 | + "shape":"String", |
| 2171 | + "documentation":"<p>The name of the operation that the node called.</p>" |
| 2172 | + }, |
| 2173 | + "requestId":{ |
| 2174 | + "shape":"String", |
| 2175 | + "documentation":"<p>The ID of the request that the node made to the operation.</p>" |
| 2176 | + }, |
| 2177 | + "serviceName":{ |
| 2178 | + "shape":"String", |
| 2179 | + "documentation":"<p>The name of the service that the node called.</p>" |
| 2180 | + }, |
| 2181 | + "timestamp":{ |
| 2182 | + "shape":"DateTimestamp", |
| 2183 | + "documentation":"<p>The date and time that the operation was called.</p>" |
| 2184 | + } |
| 2185 | + }, |
| 2186 | + "documentation":"<p>Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes. </p>", |
| 2187 | + "sensitive":true |
| 2188 | + }, |
2151 | 2189 | "FlowTraceNodeInputContent":{ |
2152 | 2190 | "type":"structure", |
2153 | 2191 | "members":{ |
|
6501 | 6539 | "members":{ |
6502 | 6540 | "applyGuardrailInterval":{ |
6503 | 6541 | "shape":"StreamingConfigurationsApplyGuardrailIntervalInteger", |
6504 | | - "documentation":"<p> The guardrail interval to apply as response is generated. </p>" |
| 6542 | + "documentation":"<p> The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer <code>ApplyGuardrail</code> calls. The following examples show the response generated for <i>Hello, I am an agent</i> input string.</p> <p> <b>Example response in chunks: Interval set to 3 characters</b> </p> <p> <code>'Hel', 'lo, ','I am', ' an', ' Age', 'nt'</code> </p> <p>Each chunk has at least 3 characters except for the last chunk</p> <p> <b>Example response in chunks: Interval set to 20 or more characters</b> </p> <p> <code>Hello, I am an Agent</code> </p>" |
6505 | 6543 | }, |
6506 | 6544 | "streamFinalResponse":{ |
6507 | 6545 | "shape":"Boolean", |
6508 | 6546 | "documentation":"<p> Specifies whether to enable streaming for the final response. This is set to <code>false</code> by default. </p>" |
6509 | 6547 | } |
6510 | 6548 | }, |
6511 | | - "documentation":"<p> Configurations for streaming.</p>" |
| 6549 | + "documentation":"<p>Configurations for streaming.</p>" |
6512 | 6550 | }, |
6513 | 6551 | "StreamingConfigurationsApplyGuardrailIntervalInteger":{ |
6514 | 6552 | "type":"integer", |
|
0 commit comments