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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:user_context]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_id ⇒ String

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

Returns:

  • (String) 


4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4270

class GetDocumentContentRequest < Struct.new(
  :data_source_id,
  :document_id,
  :knowledge_base_id,
  :media_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) 


4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4270

class GetDocumentContentRequest < Struct.new(
  :data_source_id,
  :document_id,
  :knowledge_base_id,
  :media_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) 


4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4270

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

#media_id ⇒ String

The unique identifier (in UUID format) of an image embedded in the specified document. Set this parameter to the _media_id value in the metadata of the corresponding Retrieve result. If you specify this parameter, the response contains a pre-signed URL for the image instead of the document, and you must omit outputFormat or set it to RAW.

Returns:

  • (String) 


4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4270

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

#output_format ⇒ String

The output format for the content. You can specify one of the following values:

RAW

Returns the original document, or the selected image if you specify mediaId.

EXTRACTED

Returns parsed document text as JSON.

If you omit this parameter, the default is RAW. You can't use EXTRACTED with mediaId.

Returns:

  • (String) 


4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4270

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

#user_context ⇒ Types::UserContext

Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.

Returns:



4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 4270

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