weaviate-agents
    Preparing search index...

    Type Alias QueryAgentAskStreamOptions

    Options for QueryAgent.askStream.

    type QueryAgentAskStreamOptions = {
        collections?: (string | QueryAgentCollectionConfig)[];
        includeFinalState?: boolean;
        includeProgress?: boolean;
        resultEvaluation?: ResultEvaluation;
    }
    Index

    Properties

    collections? includeFinalState? includeProgress? resultEvaluation?

    Properties

    collections?: (string | QueryAgentCollectionConfig)[]

    The collections to query. Either a list of strings, or a list of QueryAgentCollectionConfig objects. Will override any collections passed in the constructor.

    includeFinalState?: boolean

    Whether to include the final state in the stream. This is the final AskModeResponse, yielded as the last item in the stream.

    includeProgress?: boolean

    Whether to include progress messages in the stream. These are informational messages about the progress of the agent's search.

    resultEvaluation?: ResultEvaluation

    How the agent should evaluate the final result. See ResultEvaluation. Defaults to "none".

    Settings

    Member Visibility

    On This Page

    Properties