Skip to content

Document

Source code in docs_src/capo_kendra_ranking/types/document.py
class Document(TypedDict, closed=True):
    id: "capo_kendra_ranking.types.document_id.DocumentId"
    """<p>The identifier of the document from the search service.</p>"""
    group_id: NotRequired["capo_kendra_ranking.types.group_id.GroupId"]
    """<p>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.</p>"""
    title: NotRequired["capo_kendra_ranking.types.document_title.DocumentTitle"]
    """<p>The title of the search service's document.</p>"""
    body: NotRequired["capo_kendra_ranking.types.document_body.DocumentBody"]
    """<p>The body text of the search service's document.</p>"""
    tokenized_title: NotRequired[
        "capo_kendra_ranking.types.title_tokens_list.TitleTokensList"
    ]
    """<p>The title of the search service's document represented as a list of tokens or words. You must choose to provide <code>Title</code> or <code>TokenizedTitle</code>. You cannot provide both.</p>"""
    tokenized_body: NotRequired[
        "capo_kendra_ranking.types.body_tokens_list.BodyTokensList"
    ]
    """<p>The body text of the search service's document represented as a list of tokens or words. You must choose to provide <code>Body</code> or <code>TokenizedBody</code>. You cannot provide both.</p>"""
    original_score: "capo_kendra_ranking.types.float.Float"
    """<p>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.</p>"""

body instance-attribute

body: NotRequired[DocumentBody]

The body text of the search service's document.

group_id instance-attribute

group_id: NotRequired[GroupId]

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.

id instance-attribute

The identifier of the document from the search service.

original_score instance-attribute

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.

title instance-attribute

title: NotRequired[DocumentTitle]

The title of the search service's document.

tokenized_body instance-attribute

tokenized_body: NotRequired[BodyTokensList]

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.

tokenized_title instance-attribute

tokenized_title: NotRequired[TitleTokensList]

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.