bedrockagentruntime/aws.sdk.kotlin.services.bedrockagentruntime.model/RetrieveRequest

RetrieveRequest

class RetrieveRequest

Types

Builder

class Builder

Companion

object Companion

Properties

guardrailConfiguration

val guardrailConfiguration: GuardrailConfiguration?

Guardrail settings.

knowledgeBaseId

val knowledgeBaseId: String?

The unique identifier of the knowledge base to query.

nextToken

val nextToken: String?

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.

retrievalConfiguration

val retrievalConfiguration: KnowledgeBaseRetrievalConfiguration?

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

retrievalQuery

val retrievalQuery: KnowledgeBaseQuery?

Contains the query to send the knowledge base.

userContext

val userContext: UserContext?

Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.

Functions

copy

inline fun copy(block: RetrieveRequest.Builder.() -> Unit = {}): RetrieveRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String