Class: Aws::BedrockAgentRuntime::Types::RetrieveResponse

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::RetrieveResponse

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagentruntime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:retrieval_results]

Instance Attribute Summary

• #guardrail_action ⇒ String

  Specifies if there is a guardrail intervention in the response.

• #next_token ⇒ String

  If there are more results than can fit in the response, the response returns a ‘nextToken`.

• #retrieval_results ⇒ Array<Types::KnowledgeBaseRetrievalResult>

  A list of results from querying the knowledge base.

Instance Attribute Details

#guardrail_action ⇒ String

Specifies if there is a guardrail intervention in the response.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8060

class RetrieveResponse < Struct.new(
  :guardrail_action,
  :next_token,
  :retrieval_results)
  SENSITIVE = [:retrieval_results]
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8060

class RetrieveResponse < Struct.new(
  :guardrail_action,
  :next_token,
  :retrieval_results)
  SENSITIVE = [:retrieval_results]
  include Aws::Structure
end

#retrieval_results ⇒ Array<Types::KnowledgeBaseRetrievalResult>

A list of results from querying the knowledge base.

Returns:

• (Array<Types::KnowledgeBaseRetrievalResult>)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 8060

class RetrieveResponse < Struct.new(
  :guardrail_action,
  :next_token,
  :retrieval_results)
  SENSITIVE = [:retrieval_results]
  include Aws::Structure
end