AWS.Tools.BedrockAgentRuntime.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.BedrockAgentRuntime</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet"> <summary> Gets the sessions stored in the memory of the agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet.AgentAliasId"> <summary> <para> <para>The unique identifier of an alias of an agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent to which the alias belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet.MemoryId"> <summary> <para> <para>The unique identifier of the memory. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet.MemoryType"> <summary> <para> <para>The type of memory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet.MaxItem"> <summary> <para> <para>The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <c>nextToken</c> field when making another request to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet.NextToken"> <summary> <para> <para>If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the <c>nextToken</c> field in the response in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBARAgentMemoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MemoryContents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.GetAgentMemoryResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.GetAgentMemoryResponse 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="T:Amazon.PowerShell.Cmdlets.BAR.GetBAROptimizePromptCmdlet"> <summary> Optimizes a prompt for the task that you specify. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-optimize.html">Optimize a prompt</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBAROptimizePromptCmdlet.TargetModelId"> <summary> <para> <para>The unique identifier of the model that you want to optimize the prompt for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBAROptimizePromptCmdlet.TextPrompt_Text"> <summary> <para> <para>The text in the text prompt to optimize.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.GetBAROptimizePromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OptimizedPrompt'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.OptimizePromptResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.OptimizePromptResponse 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.GetBAROptimizePromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetModelId parameter. The -PassThru parameter is deprecated, use -Select '^TargetModelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet"> <summary> <note><para> The CLI doesn't support streaming operations in Amazon Bedrock, including <c>InvokeAgent</c>. </para></note><para> Sends a prompt for the agent to process and respond to. Note the following fields for the request: </para><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, if you configured an action group to return control, results from invocation of the action group. </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> If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <c>returnControl</c> field. </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.StreamingConfigurations_ApplyGuardrailInterval"> <summary> <para> <para> The guardrail interval to apply as response is generated. </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.SessionState_File"> <summary> <para> <para>Contains information about the files used by code interpreter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.InputText"> <summary> <para> <para>The prompt text to send the agent.</para><note><para>If you include <c>returnControlInvocationResults</c> in the <c>sessionState</c> field, the <c>inputText</c> field will be ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.SessionState_InvocationId"> <summary> <para> <para>The identifier of the invocation of an action. This value must match the <c>invocationId</c> returned in the <c>InvokeAgent</c> response for the action whose results are provided in the <c>returnControlInvocationResults</c> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.SessionState_KnowledgeBaseConfiguration"> <summary> <para> <para>An array of configurations, each of which applies to a knowledge base attached to the agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.MemoryId"> <summary> <para> <para>The unique identifier of the agent memory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.ConversationHistory_Message"> <summary> <para> <para>The conversation's messages.</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. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</para><note><para>If you include this field, the <c>inputText</c> field will be ignored.</para></note> </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.SourceArn"> <summary> <para> <para>The ARN of the resource making the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARAgentCmdlet.StreamingConfigurations_StreamFinalResponse"> <summary> <para> <para> Specifies whether to enable streaming for the final response. This is set to <c>false</c> by default. </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.InvokeBARFlowCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>. <note><para> The CLI doesn't support streaming operations in Amazon Bedrock, including <c>InvokeFlow</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARFlowCmdlet.EnableTrace"> <summary> <para> <para>Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes 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>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARFlowCmdlet.FlowAliasIdentifier"> <summary> <para> <para>The unique identifier of the flow alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARFlowCmdlet.FlowIdentifier"> <summary> <para> <para>The unique identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARFlowCmdlet.Input"> <summary> <para> <para>A list of objects, each containing information about an input into the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResponseStream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.InvokeFlowResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.InvokeFlowResponse 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.InvokeBARFlowCmdlet.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.InvokeBARInlineAgentCmdlet"> <summary> Invokes an inline Amazon Bedrock agent using the configurations you provide with the request. <ul><li><para> Specify the following fields for security purposes. </para><ul><li><para> (Optional) <c>customerEncryptionKeyArn</c> – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. </para></li><li><para> (Optional) <c>idleSessionTTLinSeconds</c> – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent <c>InvokeInlineAgent</c> request begins a new session. </para></li></ul></li><li><para> To override the default prompt behavior for agent orchestration and to use advanced prompts, include a <c>promptOverrideConfiguration</c> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>. </para></li><li><para> The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled. </para></li></ul><note><para> The CLI doesn't support streaming operations in Amazon Bedrock, including <c>InvokeInlineAgent</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.ActionGroup"> <summary> <para> <para> A list of action groups with each action group defining the action the inline agent needs to carry out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.CustomerEncryptionKeyArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.EnableTrace"> <summary> <para> Amazon.BedrockAgentRuntime.Model.InvokeInlineAgentRequest.EnableTrace </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.EndSession"> <summary> <para> <para> Specifies whether to end the session with the inline agent or not. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.InlineSessionState_File"> <summary> <para> <para> Contains information about the files used by code interpreter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.FoundationModel"> <summary> <para> <para> The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">model identifier (ID)</a> of the model to use for orchestration by the inline agent. For example, <c>meta.llama3-1-70b-instruct-v1:0</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.GuardrailConfiguration_GuardrailIdentifier"> <summary> <para> <para> The unique identifier for the guardrail. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para> The version of the guardrail. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.IdleSessionTTLInSecond"> <summary> <para> <para> The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent <c>InvokeInlineAgent</c> request begins a new session. </para><para>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.InputText"> <summary> <para> <para> The prompt text to send to the agent. </para><note><para>If you include <c>returnControlInvocationResults</c> in the <c>sessionState</c> field, the <c>inputText</c> field will be ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.Instruction"> <summary> <para> <para> The instructions that tell the inline agent what it should do and how it should interact with users. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.InlineSessionState_InvocationId"> <summary> <para> <para> The identifier of the invocation of an action. This value must match the <c>invocationId</c> returned in the <c>InvokeInlineAgent</c> response for the action whose results are provided in the <c>returnControlInvocationResults</c> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.KnowledgeBases"> <summary> <para> <para> Contains information of the knowledge bases to associate with. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.PromptOverrideConfiguration_OverrideLambda"> <summary> <para> <para>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the <c>promptConfigurations</c> must contain a <c>parserMode</c> value that is set to <c>OVERRIDDEN</c>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html">Parser Lambda function in Amazon Bedrock Agents</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.PromptOverrideConfiguration_PromptConfiguration"> <summary> <para> <para>Contains configurations to override a prompt template in one part of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.InlineSessionState_PromptSessionAttribute"> <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.InvokeBARInlineAgentCmdlet.InlineSessionState_ReturnControlInvocationResult"> <summary> <para> <para> Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a>. </para><note><para>If you include this field in the <c>sessionState</c> field, the <c>inputText</c> field will be ignored.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.InlineSessionState_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.InvokeBARInlineAgentCmdlet.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.InvokeBARInlineAgentCmdlet.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.InvokeInlineAgentResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.InvokeInlineAgentResponse 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.InvokeBARInlineAgentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARInlineAgentCmdlet.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.InvokeBARRerankCmdlet"> <summary> Reranks the relevance of sources based on queries. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html">Improve the relevance of query responses with a reranker model</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.ModelConfiguration_AdditionalModelRequestField"> <summary> <para> <para>A JSON object whose keys are request fields for the model and whose values are values for those fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.ModelConfiguration_ModelArn"> <summary> <para> <para>The ARN of the reranker model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.BedrockRerankingConfiguration_NumberOfResult"> <summary> <para> <para>The number of results to return after reranking.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.Query"> <summary> <para> <para>An array of objects, each of which contains information about a query to submit to the reranker model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.Source"> <summary> <para> <para>An array of objects, each of which contains information about the sources to rerank.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.RerankingConfiguration_Type"> <summary> <para> <para>The type of reranker that the configurations apply to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.NextToken"> <summary> <para> <para>If the total number of results was greater than could fit in a response, a token is returned in the <c>nextToken</c> field. You can enter that token in this field to return the next batch of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRerankCmdlet.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.RerankResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.RerankResponse 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.InvokeBARRerankCmdlet.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.ModelConfiguration_AdditionalModelRequestField"> <summary> <para> <para>A JSON object whose keys are request fields for the model and whose values are values for those fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.Filter_AndAll"> <summary> <para> <para>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.SelectiveModeConfiguration_FieldsToExclude"> <summary> <para> <para>An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.SelectiveModeConfiguration_FieldsToInclude"> <summary> <para> <para>An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.GuardrailConfiguration_GuardrailId"> <summary> <para> <para>The unique identifier for the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para>The version of the guardrail.</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.ListContains_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.StringContains_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.ImplicitFilterConfiguration_MetadataAttribute"> <summary> <para> <para>Metadata that can be used in a filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.ImplicitFilterConfiguration_ModelArn"> <summary> <para> <para>The model that generates the filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.ModelConfiguration_ModelArn"> <summary> <para> <para>The ARN of the reranker model to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveCmdlet.BedrockRerankingConfiguration_NumberOfRerankedResult"> <summary> <para> <para>The number of results to return after reranking.</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 are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</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.MetadataConfiguration_SelectionMode"> <summary> <para> <para>Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify <c>SELECTIVE</c>, include the <c>selectiveModeConfiguration</c> field.</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.RerankingConfiguration_Type"> <summary> <para> <para>The type of reranker model.</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.ListContains_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.StringContains_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 and using the specified foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>. The response only cites sources that are relevant to the query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_AdditionalModelRequestFields"> <summary> <para> <para> Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.GenerationConfiguration_AdditionalModelRequestField"> <summary> <para> <para> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.OrchestrationConfiguration_AdditionalModelRequestField"> <summary> <para> <para> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ModelConfiguration_AdditionalModelRequestField"> <summary> <para> <para>A JSON object whose keys are request fields for the model and whose values are values for those fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.Filter_AndAll"> <summary> <para> <para>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.SelectiveModeConfiguration_FieldsToExclude"> <summary> <para> <para>An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.SelectiveModeConfiguration_FieldsToInclude"> <summary> <para> <para>An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_GuardrailConfiguration_GuardrailId"> <summary> <para> <para>The unique identifier for the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_GenerationConfiguration_GuardrailConfiguration_GuardrailId"> <summary> <para> <para>The unique identifier for the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para>The version of the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_GenerationConfiguration_GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para>The version of the guardrail.</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.ListContains_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.StringContains_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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_MaxTokens"> <summary> <para> <para>The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.TextInferenceConfig_MaxToken"> <summary> <para> <para>The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_OrchestrationConfiguration_InferenceConfig_TextInferenceConfig_MaxTokens"> <summary> <para> <para>The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ImplicitFilterConfiguration_MetadataAttribute"> <summary> <para> <para>Metadata that can be used in a filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ExternalSourcesConfiguration_ModelArn"> <summary> <para> <para>The model Amazon Resource Name (ARN) for the external source wrapper object in the <c>retrieveAndGenerate</c> function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.KnowledgeBaseConfiguration_ModelArn"> <summary> <para> <para>The ARN of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> used to generate a response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ImplicitFilterConfiguration_ModelArn"> <summary> <para> <para>The model that generates the filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ModelConfiguration_ModelArn"> <summary> <para> <para>The ARN of the reranker model to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.BedrockRerankingConfiguration_NumberOfRerankedResult"> <summary> <para> <para>The number of results to return after reranking.</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 are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</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.MetadataConfiguration_SelectionMode"> <summary> <para> <para>Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify <c>SELECTIVE</c>, include the <c>selectiveModeConfiguration</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session. When you first make a <c>RetrieveAndGenerate</c> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <c>sessionId</c> yourself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.ExternalSourcesConfiguration_Source"> <summary> <para> <para>The document for the external source wrapper object in the <c>retrieveAndGenerate</c> function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_StopSequences"> <summary> <para> <para>A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.TextInferenceConfig_StopSequence"> <summary> <para> <para>A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_OrchestrationConfiguration_InferenceConfig_TextInferenceConfig_StopSequences"> <summary> <para> <para>A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_Temperature"> <summary> <para> <para> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.TextInferenceConfig_Temperature"> <summary> <para> <para> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_OrchestrationConfiguration_InferenceConfig_TextInferenceConfig_Temperature"> <summary> <para> <para> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </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_KnowledgeBaseConfiguration_OrchestrationConfiguration_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_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_TopP"> <summary> <para> <para> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.TextInferenceConfig_TopP"> <summary> <para> <para> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_OrchestrationConfiguration_InferenceConfig_TextInferenceConfig_TopP"> <summary> <para> <para> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.QueryTransformationConfiguration_Type"> <summary> <para> <para>The type of transformation to apply to the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RerankingConfiguration_Type"> <summary> <para> <para>The type of reranker model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateCmdlet.RetrieveAndGenerateConfiguration_Type"> <summary> <para> <para>The type of resource that contains your data for retrieving information and generating responses.</para><para>If you choose ot use <c>EXTERNAL_SOURCES</c>, then currently only Claude 3 Sonnet models for knowledge bases are supported.</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.ListContains_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.StringContains_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> <member name="T:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet"> <summary> Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format. <note><para> The CLI doesn't support streaming operations in Amazon Bedrock, including <c>InvokeModelWithResponseStream</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_AdditionalModelRequestFields"> <summary> <para> <para> Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.GenerationConfiguration_AdditionalModelRequestField"> <summary> <para> <para> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.OrchestrationConfiguration_AdditionalModelRequestField"> <summary> <para> <para> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.ModelConfiguration_AdditionalModelRequestField"> <summary> <para> <para>A JSON object whose keys are request fields for the model and whose values are values for those fields.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.Filter_AndAll"> <summary> <para> <para>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.SelectiveModeConfiguration_FieldsToExclude"> <summary> <para> <para>An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.SelectiveModeConfiguration_FieldsToInclude"> <summary> <para> <para>An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_GuardrailConfiguration_GuardrailId"> <summary> <para> <para>The unique identifier for the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.GuardrailConfiguration_GuardrailId"> <summary> <para> <para>The unique identifier for the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para>The version of the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.GuardrailConfiguration_GuardrailVersion"> <summary> <para> <para>The version of the guardrail.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.Equals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.GreaterThan_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.GreaterThanOrEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.In_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.LessThan_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.LessThanOrEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.ListContains_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.NotEquals_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.NotIn_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.StartsWith_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.StringContains_Key"> <summary> <para> <para>The name that the metadata attribute must match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.KnowledgeBaseConfiguration_KnowledgeBaseId"> <summary> <para> <para>The unique identifier of the knowledge base that is queried.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_MaxTokens"> <summary> <para> <para>The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_MaxTokens"> <summary> <para> <para>The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.TextInferenceConfig_MaxToken"> <summary> <para> <para>The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.ImplicitFilterConfiguration_MetadataAttribute"> <summary> <para> <para>Metadata that can be used in a filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.ExternalSourcesConfiguration_ModelArn"> <summary> <para> <para>The model Amazon Resource Name (ARN) for the external source wrapper object in the <c>retrieveAndGenerate</c> function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.KnowledgeBaseConfiguration_ModelArn"> <summary> <para> <para>The ARN of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> used to generate a response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.ImplicitFilterConfiguration_ModelArn"> <summary> <para> <para>The model that generates the filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.ModelConfiguration_ModelArn"> <summary> <para> <para>The ARN of the reranker model to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.BedrockRerankingConfiguration_NumberOfRerankedResult"> <summary> <para> <para>The number of results to return after reranking.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.VectorSearchConfiguration_NumberOfResult"> <summary> <para> <para>The number of source chunks to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.Filter_OrAll"> <summary> <para> <para>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.MetadataConfiguration_SelectionMode"> <summary> <para> <para>Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify <c>SELECTIVE</c>, include the <c>selectiveModeConfiguration</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.SessionId"> <summary> <para> <para>The unique identifier of the session. When you first make a <c>RetrieveAndGenerate</c> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <c>sessionId</c> yourself.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.ExternalSourcesConfiguration_Source"> <summary> <para> <para>The document for the external source wrapper object in the <c>retrieveAndGenerate</c> function.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_StopSequences"> <summary> <para> <para>A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_StopSequences"> <summary> <para> <para>A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.TextInferenceConfig_StopSequence"> <summary> <para> <para>A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_Temperature"> <summary> <para> <para> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_Temperature"> <summary> <para> <para> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.TextInferenceConfig_Temperature"> <summary> <para> <para> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.Input_Text"> <summary> <para> <para>The query made to the knowledge base.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_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.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_GenerationConfiguration_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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_ExternalSourcesConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_TopP"> <summary> <para> <para> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_KnowledgeBaseConfiguration_GenerationConfiguration_InferenceConfig_TextInferenceConfig_TopP"> <summary> <para> <para> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.TextInferenceConfig_TopP"> <summary> <para> <para> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.QueryTransformationConfiguration_Type"> <summary> <para> <para>The type of transformation to apply to the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RerankingConfiguration_Type"> <summary> <para> <para>The type of reranker model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.RetrieveAndGenerateConfiguration_Type"> <summary> <para> <para>The type of resource that contains your data for retrieving information and generating responses.</para><para>If you choose ot use <c>EXTERNAL_SOURCES</c>, then currently only Claude 3 Sonnet models for knowledge bases are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.ListContains_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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.StringContains_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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.RetrieveAndGenerateStreamResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.RetrieveAndGenerateStreamResponse 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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.InvokeBARRetrieveAndGenerateStreamCmdlet.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.RemoveBARAgentMemoryCmdlet"> <summary> Deletes memory from the specified memory identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.RemoveBARAgentMemoryCmdlet.AgentAliasId"> <summary> <para> <para>The unique identifier of an alias of an agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.RemoveBARAgentMemoryCmdlet.AgentId"> <summary> <para> <para>The unique identifier of the agent to which the alias belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.RemoveBARAgentMemoryCmdlet.MemoryId"> <summary> <para> <para>The unique identifier of the memory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.RemoveBARAgentMemoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.DeleteAgentMemoryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BAR.RemoveBARAgentMemoryCmdlet.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> |