@squidcloud/client
    Preparing search index...

    Interface AiKnowledgeBaseSearchContextsWithContextIdRequest

    Request structure for searching AI contexts in the AiKnowledgeBase with an existing context.

    interface AiKnowledgeBaseSearchContextsWithContextIdRequest {
        chatModel?: AiChatModelSelection;
        contextId: string;
        contextMetadataFilter?: AiContextMetadataFilter;
        knowledgeBaseId: string;
        limit?: number;
        rerank?: boolean;
        rerankReasoningEffort?: AiReasoningEffort;
    }

    Hierarchy (View Summary)

    Index
    chatModel? contextId contextMetadataFilter? knowledgeBaseId limit? rerank? rerankReasoningEffort?
    chatModel?: AiChatModelSelection

    Which chat model to use when doing reranking

    contextId: string

    The contextId to search with

    contextMetadataFilter?: AiContextMetadataFilter

    A set of filters that will limit the context the AI can access.

    knowledgeBaseId: string

    The id of the AiKnowledgeBase

    limit?: number

    The maximum number of results to return

    rerank?: boolean

    Whether to rerank the results with AI and provide reasoning - defaults to true

    rerankReasoningEffort?: AiReasoningEffort

    Reasoning effort of the reranking model. A score needs little thought, so 'low' is the usual choice; when unset the model applies its own default.

    Settings
    Member Visibility

    On This Page
    Properties