Package version:

Interface SearchIndexKnowledgeSourceParams

Specifies runtime parameters for a search index knowledge source

interface SearchIndexKnowledgeSourceParams {
    alwaysQuerySource?: boolean;
    filterAddOn?: string;
    includeReferences?: boolean;
    includeReferenceSourceData?: boolean;
    kind: "searchIndex";
    knowledgeSourceName: string;
    rerankerThreshold?: number;
}

Properties

alwaysQuerySource?: boolean

Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.

filterAddOn?: string

A filter condition applied to the index (e.g., 'State eq VA').

includeReferences?: boolean

Indicates whether references should be included for data retrieved from this source.

includeReferenceSourceData?: boolean

Indicates whether references should include the structured data obtained during retrieval in their payload.

Polymorphic discriminator, which specifies the different types this object can be

knowledgeSourceName: string

The name of the index the params apply to.

rerankerThreshold?: number

The reranker threshold all retrieved documents must meet to be included in the response.