Skip to content

RetrieveResult

Source code in docs_src/capo_qconnect/types/retrieve_result.py 
15
16
17
18
19
20
21
22
23
class RetrieveResult(TypedDict, closed=True):
    association_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the assistant association for the retrieved result.</p>"""
    source_id: "capo_qconnect.types.sensitive_string.SensitiveString"
    """<p>The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.</p>"""
    reference_type: "capo_qconnect.types.reference_type.ReferenceType"
    """<p>A type to define the KB origin of a retrieved content.</p>"""
    content_text: "capo_qconnect.types.sensitive_string.SensitiveString"
    """<p>The text content of the retrieved result.</p>"""

association_id instance-attribute 

association_id: Uuid

The identifier of the assistant association for the retrieved result.

content_text instance-attribute 

content_text: SensitiveString

The text content of the retrieved result.

reference_type instance-attribute 

reference_type: ReferenceType

A type to define the KB origin of a retrieved content.

source_id instance-attribute 

source_id: SensitiveString

The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.