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

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::GetDocumentContentRequest

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The unique identifier of the Amazon Q Business application containing the document.

• #data_source_id ⇒ String

  The identifier of the data source from which the document was ingested.

• #document_id ⇒ String

  The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync.

• #index_id ⇒ String

  The identifier of the index where documents are indexed.

• #output_format ⇒ String

  Document outputFormat.

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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4852

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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4852

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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4852

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)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4852

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

#output_format ⇒ String

Document outputFormat. Defaults to RAW if not selected.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4852

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