Skip to content

QueryAssistantRequest

Source code in docs_src/capo_qconnect/types/query_assistant_request.py
class QueryAssistantRequest(TypedDict, closed=True):
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    query_text: NotRequired["capo_qconnect.types.query_text.QueryText"]
    """<p>The text to search for.</p>"""
    next_token: NotRequired["capo_qconnect.types.next_token.NextToken"]
    """<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"""
    max_results: NotRequired["capo_qconnect.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per page.</p>"""
    session_id: NotRequired["capo_qconnect.types.uuid_or_arn.UuidOrArn"]
    """<p>The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    query_condition: NotRequired[
        "capo_qconnect.types.query_condition_expression.QueryConditionExpression"
    ]
    """<p>Information about how to query content.</p>"""
    query_input_data: NotRequired["capo_qconnect.types.query_input_data.QueryInputData"]
    """<p>Information about the query.</p>"""
    override_knowledge_base_search_type: NotRequired[
        "capo_qconnect.types.knowledge_base_search_type.KnowledgeBaseSearchType"
    ]
    """<p>The search type to be used against the Knowledge Base for this request. The values can be <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector embeddings and raw text.</p>"""

assistant_id instance-attribute

assistant_id: UuidOrArn

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return per page.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

override_knowledge_base_search_type instance-attribute

override_knowledge_base_search_type: NotRequired[KnowledgeBaseSearchType]

The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.

query_condition instance-attribute

query_condition: NotRequired[QueryConditionExpression]

Information about how to query content.

query_input_data instance-attribute

query_input_data: NotRequired[QueryInputData]

Information about the query.

query_text instance-attribute

query_text: NotRequired[QueryText]

The text to search for.

session_id instance-attribute

session_id: NotRequired[UuidOrArn]

The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.