Skip to content

QuerySummary

Source code in docs_src/capo_artifact/types/query_summary.py
class QuerySummary(TypedDict, closed=True):
    query_identifier: "int"
    """<p>Sequential identifier of the query within the inquiry.</p>"""
    query: "capo_artifact.types.long_string_attribute.LongStringAttribute"
    """<p>The actual query text.</p>"""
    response: NotRequired[
        "capo_artifact.types.long_string_attribute.LongStringAttribute"
    ]
    """<p>Generated response to the query.</p>"""
    review_type: NotRequired["capo_artifact.types.review_type.ReviewType"]
    """<p>Type of review for the response.</p>"""
    citations: NotRequired["capo_artifact.types.citation_list.CitationList"]
    """<p>Supporting citations for the response.</p>"""
    status: "capo_artifact.types.query_status.QueryStatus"
    """<p>Current processing status of the query.</p>"""
    status_message: "capo_artifact.types.query_status_message.QueryStatusMessage"
    """<p>Descriptive status message.</p>"""
    created_at: "capo_artifact.types.timestamp_attribute.TimestampAttribute"
    """<p>Timestamp when the query was created.</p>"""
    updated_response_versions: NotRequired[
        "capo_artifact.types.response_version_list.ResponseVersionList"
    ]
    """<p>Ordered list of response version history entries, oldest first.</p>"""

citations instance-attribute

citations: NotRequired[CitationList]

Supporting citations for the response.

created_at instance-attribute

created_at: TimestampAttribute

Timestamp when the query was created.

query instance-attribute

The actual query text.

query_identifier instance-attribute

query_identifier: int

Sequential identifier of the query within the inquiry.

response instance-attribute

response: NotRequired[LongStringAttribute]

Generated response to the query.

review_type instance-attribute

review_type: NotRequired[ReviewType]

Type of review for the response.

status instance-attribute

status: QueryStatus

Current processing status of the query.

status_message instance-attribute

status_message: QueryStatusMessage

Descriptive status message.

updated_response_versions instance-attribute

updated_response_versions: NotRequired[ResponseVersionList]

Ordered list of response version history entries, oldest first.