Class: Aws::BedrockAgentRuntime::Types::GetDocumentContentRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::GetDocumentContentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagentruntime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:user_context]

Instance Attribute Summary

• #data_source_id ⇒ String

  The unique identifier of the data source that contains the document.

• #document_id ⇒ String

  The unique identifier of the document to retrieve content for.

• #knowledge_base_id ⇒ String

  The unique identifier of the knowledge base that contains the document.

• #output_format ⇒ String

  The output format for the document content.

• #user_context ⇒ Types::UserContext

  Contains information about the user making the request.

Instance Attribute Details

#data_source_id ⇒ String

The unique identifier of the data source that contains the document.

Returns:

• (String)

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

class GetDocumentContentRequest < Struct.new(
  :data_source_id,
  :document_id,
  :knowledge_base_id,
  :output_format,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#document_id ⇒ String

The unique identifier of the document to retrieve content for.

Returns:

• (String)

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

class GetDocumentContentRequest < Struct.new(
  :data_source_id,
  :document_id,
  :knowledge_base_id,
  :output_format,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The unique identifier of the knowledge base that contains the document.

Returns:

• (String)

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

class GetDocumentContentRequest < Struct.new(
  :data_source_id,
  :document_id,
  :knowledge_base_id,
  :output_format,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#output_format ⇒ String

The output format for the document content. ‘RAW` returns the original file. `EXTRACTED` returns parsed text as JSON. Defaults to `RAW`.

Returns:

• (String)

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

class GetDocumentContentRequest < Struct.new(
  :data_source_id,
  :document_id,
  :knowledge_base_id,
  :output_format,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#user_context ⇒ Types::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.

Returns:

• (Types::UserContext)

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

class GetDocumentContentRequest < Struct.new(
  :data_source_id,
  :document_id,
  :knowledge_base_id,
  :output_format,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end