Class: Aws::QBusiness::Types::GetDocumentContentRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.

Returns:

  • (String) 


4842
4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4842

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

#data_source_id ⇒ String

The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".

Returns:

  • (String) 


4842
4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4842

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

#document_id ⇒ String

The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.

Returns:

  • (String) 


4842
4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4842

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

#index_id ⇒ String

The identifier of the index where documents are indexed.

Returns:

  • (String) 


4842
4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4842

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

#output_format ⇒ String

Raw document outputFormat.

Returns:

  • (String) 


4842
4843
4844
4845
4846
4847
4848
4849
4850
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4842

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