AWS SDK Version 3 for .NET
API 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.

Container for the parameters to the Retrieve operation. Queries a knowledge base and retrieves information from it.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.BedrockAgentRuntime.AmazonBedrockAgentRuntimeRequest
      Amazon.BedrockAgentRuntime.Model.RetrieveRequest

Namespace: Amazon.BedrockAgentRuntime.Model
Assembly: AWSSDK.BedrockAgentRuntime.dll
Version: 3.x.y.z

Syntax

C#
public class RetrieveRequest : AmazonBedrockAgentRuntimeRequest
         IAmazonWebServiceRequest

The RetrieveRequest type exposes the following members

Constructors

NameDescription
Public Method RetrieveRequest()

Properties

NameTypeDescription
Public Property KnowledgeBaseId System.String

Gets and sets the property KnowledgeBaseId.

The unique identifier of the knowledge base to query.

Public Property NextToken System.String

Gets and sets the property NextToken.

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Public Property RetrievalConfiguration Amazon.BedrockAgentRuntime.Model.KnowledgeBaseRetrievalConfiguration

Gets and sets the property RetrievalConfiguration.

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Public Property RetrievalQuery Amazon.BedrockAgentRuntime.Model.KnowledgeBaseQuery

Gets and sets the property RetrievalQuery.

Contains the query to send the knowledge base.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5