Class: Aws::QBusiness::Types::Document

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

A document in an Amazon Q Business application.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_configuration ⇒ Types::AccessConfiguration

Configuration information for access permission to a document.

Returns:



2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#attributes ⇒ Array<Types::DocumentAttribute>

Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

Returns:



2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#content ⇒ Types::DocumentContent

The contents of the document.

Returns:



2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#content_type ⇒ String

The file type of the document in the Blob field.

If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the ‘HTML` start and closing tags (`<HTML>content</HTML>`) around the content.

Returns:

  • (String) 


2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_enrichment_configuration ⇒ Types::DocumentEnrichmentConfiguration

The configuration information for altering document metadata and content during the document ingestion process.

Returns:



2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the document.

Returns:

  • (String) 


2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#media_extraction_configuration ⇒ Types::MediaExtractionConfiguration

The configuration for extracting information from media in the document.

Returns:



2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the document.

Returns:

  • (String) 


2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2930

class Document < Struct.new(
  :id,
  :attributes,
  :content,
  :content_type,
  :title,
  :access_configuration,
  :document_enrichment_configuration,
  :media_extraction_configuration)
  SENSITIVE = []
  include Aws::Structure
end