|
1696 | 1696 | "nodeName": { |
1697 | 1697 | "target": "com.amazonaws.bedrockagentruntime#NodeName", |
1698 | 1698 | "traits": { |
1699 | | - "smithy.api#documentation": "<p>A name for the input of the flow input node.</p>", |
| 1699 | + "smithy.api#documentation": "<p>The name of the flow input node that begins the prompt flow.</p>", |
1700 | 1700 | "smithy.api#required": {} |
1701 | 1701 | } |
1702 | 1702 | }, |
1703 | 1703 | "nodeOutputName": { |
1704 | 1704 | "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", |
1705 | 1705 | "traits": { |
1706 | | - "smithy.api#documentation": "<p>A name for the output of the flow input node.</p>", |
| 1706 | + "smithy.api#documentation": "<p>The name of the output from the flow input node that begins the prompt flow.</p>", |
1707 | 1707 | "smithy.api#required": {} |
1708 | 1708 | } |
1709 | 1709 | }, |
1710 | 1710 | "content": { |
1711 | 1711 | "target": "com.amazonaws.bedrockagentruntime#FlowInputContent", |
1712 | 1712 | "traits": { |
1713 | | - "smithy.api#documentation": "<p>Contains information about an input into the flow.</p>", |
| 1713 | + "smithy.api#documentation": "<p>Contains information about an input into the prompt flow.</p>", |
1714 | 1714 | "smithy.api#required": {} |
1715 | 1715 | } |
1716 | 1716 | } |
1717 | 1717 | }, |
1718 | 1718 | "traits": { |
1719 | | - "smithy.api#documentation": "<p>Contains information about an input into the flow and what to do with it.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax\">InvokeFlow request</a>\n </p>\n </li>\n </ul>" |
| 1719 | + "smithy.api#documentation": "<p>Contains information about an input into the prompt flow and where to send it.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax\">InvokeFlow request</a>\n </p>\n </li>\n </ul>" |
1720 | 1720 | } |
1721 | 1721 | }, |
1722 | 1722 | "com.amazonaws.bedrockagentruntime#FlowInputContent": { |
|
1725 | 1725 | "document": { |
1726 | 1726 | "target": "smithy.api#Document", |
1727 | 1727 | "traits": { |
1728 | | - "smithy.api#documentation": "<p>The input for the flow input node.</p>" |
| 1728 | + "smithy.api#documentation": "<p>The input to send to the prompt flow input node.</p>" |
1729 | 1729 | } |
1730 | 1730 | } |
1731 | 1731 | }, |
|
1752 | 1752 | "document": { |
1753 | 1753 | "target": "smithy.api#Document", |
1754 | 1754 | "traits": { |
1755 | | - "smithy.api#documentation": "<p>A name for the output of the flow.</p>" |
| 1755 | + "smithy.api#documentation": "<p>The content in the output.</p>" |
1756 | 1756 | } |
1757 | 1757 | } |
1758 | 1758 | }, |
1759 | 1759 | "traits": { |
1760 | | - "smithy.api#documentation": "<p>Contains information about the output node.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax\">InvokeFlow request</a>\n </p>\n </li>\n </ul>" |
| 1760 | + "smithy.api#documentation": "<p>Contains information about the content in an output from prompt flow invocation.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax\">InvokeFlow request</a>\n </p>\n </li>\n </ul>" |
1761 | 1761 | } |
1762 | 1762 | }, |
1763 | 1763 | "com.amazonaws.bedrockagentruntime#FlowOutputEvent": { |
|
1766 | 1766 | "nodeName": { |
1767 | 1767 | "target": "com.amazonaws.bedrockagentruntime#NodeName", |
1768 | 1768 | "traits": { |
1769 | | - "smithy.api#documentation": "<p>The name of the node to which input was provided.</p>", |
| 1769 | + "smithy.api#documentation": "<p>The name of the flow output node that the output is from.</p>", |
1770 | 1770 | "smithy.api#required": {} |
1771 | 1771 | } |
1772 | 1772 | }, |
1773 | 1773 | "nodeType": { |
1774 | 1774 | "target": "com.amazonaws.bedrockagentruntime#NodeType", |
1775 | 1775 | "traits": { |
1776 | | - "smithy.api#documentation": "<p>The type of node to which input was provided.</p>", |
| 1776 | + "smithy.api#documentation": "<p>The type of the node that the output is from.</p>", |
1777 | 1777 | "smithy.api#required": {} |
1778 | 1778 | } |
1779 | 1779 | }, |
1780 | 1780 | "content": { |
1781 | 1781 | "target": "com.amazonaws.bedrockagentruntime#FlowOutputContent", |
1782 | 1782 | "traits": { |
1783 | | - "smithy.api#documentation": "<p>The output of the node.</p>", |
| 1783 | + "smithy.api#documentation": "<p>The content in the output.</p>", |
1784 | 1784 | "smithy.api#required": {} |
1785 | 1785 | } |
1786 | 1786 | } |
1787 | 1787 | }, |
1788 | 1788 | "traits": { |
1789 | | - "smithy.api#documentation": "<p>Contains information about an output from flow invoction.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax\">InvokeFlow response</a>\n </p>\n </li>\n </ul>", |
| 1789 | + "smithy.api#documentation": "<p>Contains information about an output from prompt flow invoction.</p>\n <p>This data type is used in the following API operations:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax\">InvokeFlow response</a>\n </p>\n </li>\n </ul>", |
1790 | 1790 | "smithy.api#sensitive": {} |
1791 | 1791 | } |
1792 | 1792 | }, |
|
2938 | 2938 | "topP": { |
2939 | 2939 | "target": "com.amazonaws.bedrockagentruntime#TopP", |
2940 | 2940 | "traits": { |
2941 | | - "smithy.api#documentation": "<p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>" |
| 2941 | + "smithy.api#documentation": "<p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>" |
2942 | 2942 | } |
2943 | 2943 | }, |
2944 | 2944 | "topK": { |
|
3334 | 3334 | } |
3335 | 3335 | ], |
3336 | 3336 | "traits": { |
3337 | | - "smithy.api#documentation": "<p>Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html\">Test a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>", |
| 3337 | + "smithy.api#documentation": "<p>Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html\">Test a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>\n <note>\n <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeFlow</code>.</p>\n </note>", |
3338 | 3338 | "smithy.api#http": { |
3339 | 3339 | "code": 200, |
3340 | 3340 | "method": "POST", |
|
3750 | 3750 | } |
3751 | 3751 | } |
3752 | 3752 | }, |
| 3753 | + "com.amazonaws.bedrockagentruntime#Metadata": { |
| 3754 | + "type": "structure", |
| 3755 | + "members": { |
| 3756 | + "usage": { |
| 3757 | + "target": "com.amazonaws.bedrockagentruntime#Usage", |
| 3758 | + "traits": { |
| 3759 | + "smithy.api#documentation": "<p>Contains details of the foundation model usage.</p>" |
| 3760 | + } |
| 3761 | + } |
| 3762 | + }, |
| 3763 | + "traits": { |
| 3764 | + "smithy.api#documentation": "<p>Provides details of the foundation model.</p>", |
| 3765 | + "smithy.api#sensitive": {} |
| 3766 | + } |
| 3767 | + }, |
3753 | 3768 | "com.amazonaws.bedrockagentruntime#MimeType": { |
3754 | 3769 | "type": "string" |
3755 | 3770 | }, |
|
3945 | 3960 | "smithy.api#documentation": "<p>Settings for how the model processes the prompt prior to retrieval and generation.</p>" |
3946 | 3961 | } |
3947 | 3962 | }, |
| 3963 | + "com.amazonaws.bedrockagentruntime#OrchestrationModelInvocationOutput": { |
| 3964 | + "type": "structure", |
| 3965 | + "members": { |
| 3966 | + "traceId": { |
| 3967 | + "target": "com.amazonaws.bedrockagentruntime#TraceId", |
| 3968 | + "traits": { |
| 3969 | + "smithy.api#documentation": "<p>The unique identifier of the trace.</p>" |
| 3970 | + } |
| 3971 | + }, |
| 3972 | + "rawResponse": { |
| 3973 | + "target": "com.amazonaws.bedrockagentruntime#RawResponse", |
| 3974 | + "traits": { |
| 3975 | + "smithy.api#documentation": "<p>Contains details of the raw response from the foundation model output.</p>" |
| 3976 | + } |
| 3977 | + }, |
| 3978 | + "metadata": { |
| 3979 | + "target": "com.amazonaws.bedrockagentruntime#Metadata", |
| 3980 | + "traits": { |
| 3981 | + "smithy.api#documentation": "<p>Contains information about the foundation model output.</p>" |
| 3982 | + } |
| 3983 | + } |
| 3984 | + }, |
| 3985 | + "traits": { |
| 3986 | + "smithy.api#documentation": "<p>The foundation model output from the orchestration step.</p>", |
| 3987 | + "smithy.api#sensitive": {} |
| 3988 | + } |
| 3989 | + }, |
3948 | 3990 | "com.amazonaws.bedrockagentruntime#OrchestrationTrace": { |
3949 | 3991 | "type": "union", |
3950 | 3992 | "members": { |
|
3971 | 4013 | "traits": { |
3972 | 4014 | "smithy.api#documentation": "<p>The input for the orchestration step.</p>\n <ul>\n <li>\n <p>The <code>type</code> is <code>ORCHESTRATION</code>.</p>\n </li>\n <li>\n <p>The <code>text</code> contains the prompt.</p>\n </li>\n <li>\n <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set 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.</p>\n </li>\n </ul>" |
3973 | 4015 | } |
| 4016 | + }, |
| 4017 | + "modelInvocationOutput": { |
| 4018 | + "target": "com.amazonaws.bedrockagentruntime#OrchestrationModelInvocationOutput", |
| 4019 | + "traits": { |
| 4020 | + "smithy.api#documentation": "<p>Contains information pertaining to the output from the foundation model that is being invoked.</p>" |
| 4021 | + } |
3974 | 4022 | } |
3975 | 4023 | }, |
3976 | 4024 | "traits": { |
|
4354 | 4402 | "smithy.api#sensitive": {} |
4355 | 4403 | } |
4356 | 4404 | }, |
| 4405 | + "com.amazonaws.bedrockagentruntime#RawResponse": { |
| 4406 | + "type": "structure", |
| 4407 | + "members": { |
| 4408 | + "content": { |
| 4409 | + "target": "smithy.api#String", |
| 4410 | + "traits": { |
| 4411 | + "smithy.api#documentation": "<p>The foundation model's raw output content.</p>" |
| 4412 | + } |
| 4413 | + } |
| 4414 | + }, |
| 4415 | + "traits": { |
| 4416 | + "smithy.api#documentation": "<p>Contains the raw output from the foundation model.</p>", |
| 4417 | + "smithy.api#sensitive": {} |
| 4418 | + } |
| 4419 | + }, |
4357 | 4420 | "com.amazonaws.bedrockagentruntime#RepromptResponse": { |
4358 | 4421 | "type": "structure", |
4359 | 4422 | "members": { |
|
5641 | 5704 | } |
5642 | 5705 | } |
5643 | 5706 | }, |
| 5707 | + "com.amazonaws.bedrockagentruntime#Usage": { |
| 5708 | + "type": "structure", |
| 5709 | + "members": { |
| 5710 | + "inputTokens": { |
| 5711 | + "target": "smithy.api#Integer", |
| 5712 | + "traits": { |
| 5713 | + "smithy.api#documentation": "<p>Contains information about the input tokens from the foundation model usage.</p>" |
| 5714 | + } |
| 5715 | + }, |
| 5716 | + "outputTokens": { |
| 5717 | + "target": "smithy.api#Integer", |
| 5718 | + "traits": { |
| 5719 | + "smithy.api#documentation": "<p>Contains information about the output tokens from the foundation model usage.</p>" |
| 5720 | + } |
| 5721 | + } |
| 5722 | + }, |
| 5723 | + "traits": { |
| 5724 | + "smithy.api#documentation": "<p>Contains information of the usage of the foundation model.</p>", |
| 5725 | + "smithy.api#sensitive": {} |
| 5726 | + } |
| 5727 | + }, |
5644 | 5728 | "com.amazonaws.bedrockagentruntime#ValidationException": { |
5645 | 5729 | "type": "structure", |
5646 | 5730 | "members": { |
|
0 commit comments