AWS.Tools.BedrockAgentRuntime.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.BedrockAgentRuntime</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet"> <summary> Sends a prompt for the agent to process and respond to. Use return control event type for function calling. <note><para> The CLI doesn't support <c>InvokeAgent</c>. </para></note><ul><li><para> To continue the same conversation with an agent, use the same <c>sessionId</c> value in the request. </para></li><li><para> To activate trace enablement, turn <c>enableTrace</c> to <c>true</c>. 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>. </para></li><li><para> End a conversation by setting <c>endSession</c> to <c>true</c>. </para></li><li><para> In the <c>sessionState</c> object, you can include attributes for the session or prompt or parameters returned from the action group. </para></li><li><para> Use return control event type for function calling. </para></li></ul><para> The response is returned in the <c>bytes</c> field of the <c>chunk</c> object. </para><ul><li><para> The <c>attribution</c> object contains citations for parts of the response. </para></li><li><para> If you set <c>enableTrace</c> to <c>true</c> in the request, you can trace the agent's steps and reasoning process that led it to the response. </para></li><li><para> Errors are also surfaced in the response. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.AgentAliasId"> <summary> <para> <para>The alias of the agent to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.EnableTrace"> <summary> <para> <para>Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.EndSession"> <summary> <para> <para>Specifies whether to end the session with the agent or not.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.InputText"> <summary> <para> <para>The prompt text to send the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.SessionState_InvocationId"> <summary> <para> <para>The identifier of the invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.SessionState_PromptSessionAttribute"> <summary> <para> <para>Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.SessionState_ReturnControlInvocationResult"> <summary> <para> <para>Contains information about the results from the action group invocation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.SessionState_SessionAttribute"> <summary> <para> <para>Contains attributes that persist across a session and the values of those attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session. Use the same value across requests to continue the same conversation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.InvokeAgentResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.InvokeAgentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgentId parameter. The -PassThru parameter is deprecated, use -Select '^AgentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet"> <summary> Queries a knowledge base and retrieves information from it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.Filter_AndAll"> <summary> <para> <para>Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.Equals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.GreaterThan_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.GreaterThanOrEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.In_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.LessThan_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.LessThanOrEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.NotEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.NotIn_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.StartsWith_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.VectorSearchConfiguration_NumberOfResult"> <summary> <para> <para>The number of source chunks to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.Filter_OrAll"> <summary> <para> <para>Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.VectorSearchConfiguration_OverrideSearchType"> <summary> <para> <para>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <c>HYBRID</c> search using both vector embeddings and raw text, or <c>SEMANTIC</c> search using only vector embeddings. For other vector store configurations, only <c>SEMANTIC</c> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.RetrievalQuery_Text"> <summary> <para> <para>The text of the query made to the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.Equals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.GreaterThan_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.GreaterThanOrEquals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.In_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.LessThan_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.LessThanOrEquals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.NotEquals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.NotIn_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.StartsWith_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.NextToken"> <summary> <para> <para>If there are more results than can fit in the response, the response returns a <c>nextToken</c>. Use this token in the <c>nextToken</c> field of another request to retrieve the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.RetrieveResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.RetrieveResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the KnowledgeBaseId parameter. The -PassThru parameter is deprecated, use -Select '^KnowledgeBaseId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet"> <summary> Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources that are relevant to the query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Filter_AndAll"> <summary> <para> <para>Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Equals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.GreaterThan_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.GreaterThanOrEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.In_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.LessThan_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.LessThanOrEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.NotEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.NotIn_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.StartsWith_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.SessionConfiguration_KmsKeyArn"> <summary> <para> <para>The ARN of the KMS key encrypting the session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.KnowledgeBaseConfiguration_KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base that is queried and the foundation model used for generation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ExternalSourcesConfiguration_ModelArn"> <summary> <para> <para>The modelArn used with the external source wrapper object in the retrieveAndGenerate function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.KnowledgeBaseConfiguration_ModelArn"> <summary> <para> <para>The ARN of the foundation model used to generate a response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.VectorSearchConfiguration_NumberOfResult"> <summary> <para> <para>The number of source chunks to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Filter_OrAll"> <summary> <para> <para>Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.VectorSearchConfiguration_OverrideSearchType"> <summary> <para> <para>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <c>HYBRID</c> search using both vector embeddings and raw text, or <c>SEMANTIC</c> search using only vector embeddings. For other vector store configurations, only <c>SEMANTIC</c> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ExternalSourcesConfiguration_Source"> <summary> <para> <para>The document used with the external source wrapper object in the retrieveAndGenerate function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Input_Text"> <summary> <para> <para>The query made to the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ExternalSource_PromptTemplate_TextPromptTemplate"> <summary> <para> <para>The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.</para><para>For more information, see the following resources:</para><ul><li><para><a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a></para></li><li><para><a href="https://docs.anthropic.com/claude/docs/use-xml-tags">Use XML tags with Anthropic Claude models</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.PromptTemplate_TextPromptTemplate"> <summary> <para> <para>The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.</para><para>For more information, see the following resources:</para><ul><li><para><a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a></para></li><li><para><a href="https://docs.anthropic.com/claude/docs/use-xml-tags">Use XML tags with Anthropic Claude models</a></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_Type"> <summary> <para> <para>The type of resource that is queried by the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Equals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.GreaterThan_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.GreaterThanOrEquals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.In_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.LessThan_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.LessThanOrEquals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.NotEquals_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.NotIn_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.StartsWith_Value"> <summary> <para> <para>The value to whcih to compare the value of the metadata attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.RetrieveAndGenerateResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.RetrieveAndGenerateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Input_Text parameter. The -PassThru parameter is deprecated, use -Select '^Input_Text' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |