AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Bedrock Agent Runtime AgenticRetrieveStream API operation.

Syntax

Invoke-BARAgenticRetrieveStream
-AgenticRetrieveConfiguration_FoundationModelType <FoundationModelType>
-GenerateResponse <Boolean>
-PolicyConfiguration_BedrockGuardrailConfiguration_GuardrailId <String>
-PolicyConfiguration_BedrockGuardrailConfiguration_GuardrailVersion <String>
-AgenticRetrieveConfiguration_MaxAgentIteration <Int32>
-Message <AgenticRetrieveMessage[]>
-AgenticRetrieveConfiguration_FoundationModelConfiguration_BedrockFoundationModelConfiguration_ModelConfiguration_ModelArn <String>
-AgenticRetrieveConfiguration_RerankingConfiguration_BedrockRerankingConfiguration_ModelConfiguration_ModelArn <String>
-AgenticRetrieveConfiguration_RerankingModelType <AgenticRetrieveRerankingModelType>
-Retriever <AgenticRetriever[]>
-AgenticRetrieveConfiguration_FoundationModelConfiguration_Type <FoundationModelConfigurationType>
-AgenticRetrieveConfiguration_RerankingConfiguration_Type <AgenticRetrieveRerankingConfigurationType>
-UserContext_UserId <String>
-NextToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockAgentRuntimeConfig>

Description

Retrieves information from one or more knowledge bases using an agentic approach. Agentic retrieval uses a foundation model to intelligently decompose complex queries into sub-queries and iteratively retrieve relevant information from your knowledge bases. This approach improves retrieval accuracy for complex, multi-step questions that a single retrieval pass might not fully address. The operation returns results through a stream that includes retrieval results, trace events for visibility into the process, and a generated response synthesized from the results by default, which can be turned off.

Parameters

-AgenticRetrieveConfiguration_FoundationModelConfiguration_BedrockFoundationModelConfiguration_ModelConfiguration_ModelArn <String>
The ARN of the Bedrock foundation model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgenticRetrieveConfiguration_FoundationModelConfiguration_Type <FoundationModelConfigurationType>
The type of foundation model configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgenticRetrieveConfiguration_FoundationModelType <FoundationModelType>
The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgenticRetrieveConfiguration_MaxAgentIteration <Int32>
The maximum number of agent iterations for retrieval.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgenticRetrieveConfiguration_RerankingConfiguration_BedrockRerankingConfiguration_ModelConfiguration_ModelArn <String>
The ARN of the Bedrock reranking model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgenticRetrieveConfiguration_RerankingConfiguration_Type <AgenticRetrieveRerankingConfigurationType>
The type of reranking configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AgenticRetrieveConfiguration_RerankingModelType <AgenticRetrieveRerankingModelType>
The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonBedrockAgentRuntimeConfig>
Amazon.PowerShell.Cmdlets.BAR.AmazonBedrockAgentRuntimeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GenerateResponse <Boolean>
Whether to generate a response based on the retrieved results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Message <AgenticRetrieveMessage[]>
The list of messages for the agentic retrieval conversation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessages
-NextToken <String>
Opaque continuation token for paginated results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyConfiguration_BedrockGuardrailConfiguration_GuardrailId <String>
The unique identifier of the guardrail.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyConfiguration_BedrockGuardrailConfiguration_GuardrailVersion <String>
The version of the guardrail to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Retriever <AgenticRetriever[]>
The list of retrievers to use for agentic retrieval. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRetrievers
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Stream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.BedrockAgentRuntime.Model.AgenticRetrieveStreamResponse). Specifying the name of a property of type Amazon.BedrockAgentRuntime.Model.AgenticRetrieveStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserContext_UserId <String>
The identifier of the user making the retrieval request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.BedrockAgentRuntime.Model.AgenticRetrieveStreamResponseOutput or Amazon.BedrockAgentRuntime.Model.AgenticRetrieveStreamResponse
This cmdlet returns an Amazon.BedrockAgentRuntime.Model.AgenticRetrieveStreamResponseOutput object. The service call response (type Amazon.BedrockAgentRuntime.Model.AgenticRetrieveStreamResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z