Class: Aws::QBusiness::Types::Document
- Inherits:
-
Struct
- Object
- Struct
- Aws::QBusiness::Types::Document
- Defined in:
- gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb
Overview
A document in an Amazon Q Business application.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_configuration ⇒ Types::AccessConfiguration
Configuration information for access permission to a document.
-
#attributes ⇒ Array<Types::DocumentAttribute>
Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
-
#content ⇒ Types::DocumentContent
The contents of the document.
-
#content_type ⇒ String
The file type of the document in the Blob field.
-
#document_enrichment_configuration ⇒ Types::DocumentEnrichmentConfiguration
The configuration information for altering document metadata and content during the document ingestion process.
-
#id ⇒ String
The identifier of the document.
-
#media_extraction_configuration ⇒ Types::MediaExtractionConfiguration
The configuration for extracting information from media in the document.
-
#title ⇒ String
The title of the document.
Instance Attribute Details
#access_configuration ⇒ Types::AccessConfiguration
Configuration information for access permission to a document.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 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.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 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.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 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.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 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.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 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.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 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.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 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.
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3602 class Document < Struct.new( :id, :attributes, :content, :content_type, :title, :access_configuration, :document_enrichment_configuration, :media_extraction_configuration) SENSITIVE = [] include Aws::Structure end |