Class: Aws::KendraRanking::Types::Document

Inherits:

Struct

• Object
• Struct
• Aws::KendraRanking::Types::Document

Defined in:

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

Overview

Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  The body text of the search service's document.

• #group_id ⇒ String

  The optional group identifier of the document from the search service.

• #id ⇒ String

  The identifier of the document from the search service.

• #original_score ⇒ Float

  The original document score or rank from the search service.

• #title ⇒ String

  The title of the search service's document.

• #tokenized_body ⇒ Array<String>

  The body text of the search service's document represented as a list of tokens or words.

• #tokenized_title ⇒ Array<String>

  The title of the search service's document represented as a list of tokens or words.

Instance Attribute Details

#body ⇒ String

The body text of the search service's document.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 262

class Document < Struct.new(
  :id,
  :group_id,
  :title,
  :body,
  :tokenized_title,
  :tokenized_body,
  :original_score)
  SENSITIVE = []
  include Aws::Structure
end

#group_id ⇒ String

The optional group identifier of the document from the search service. Documents with the same group identifier are grouped together and processed as one document within the service.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 262

class Document < Struct.new(
  :id,
  :group_id,
  :title,
  :body,
  :tokenized_title,
  :tokenized_body,
  :original_score)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the document from the search service.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 262

class Document < Struct.new(
  :id,
  :group_id,
  :title,
  :body,
  :tokenized_title,
  :tokenized_body,
  :original_score)
  SENSITIVE = []
  include Aws::Structure
end

#original_score ⇒ Float

The original document score or rank from the search service. Amazon Kendra Intelligent Ranking gives the document a new score or rank based on its intelligent search algorithms.

Returns:

• (Float)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 262

class Document < Struct.new(
  :id,
  :group_id,
  :title,
  :body,
  :tokenized_title,
  :tokenized_body,
  :original_score)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the search service's document.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 262

class Document < Struct.new(
  :id,
  :group_id,
  :title,
  :body,
  :tokenized_title,
  :tokenized_body,
  :original_score)
  SENSITIVE = []
  include Aws::Structure
end

#tokenized_body ⇒ Array<String>

The body text of the search service's document represented as a list of tokens or words. You must choose to provide Body or TokenizedBody. You cannot provide both.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 262

class Document < Struct.new(
  :id,
  :group_id,
  :title,
  :body,
  :tokenized_title,
  :tokenized_body,
  :original_score)
  SENSITIVE = []
  include Aws::Structure
end

#tokenized_title ⇒ Array<String>

The title of the search service's document represented as a list of tokens or words. You must choose to provide Title or TokenizedTitle. You cannot provide both.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 262

class Document < Struct.new(
  :id,
  :group_id,
  :title,
  :body,
  :tokenized_title,
  :tokenized_body,
  :original_score)
  SENSITIVE = []
  include Aws::Structure
end