Package version:

Interface BaseKnowledgeSourceParams

interface BaseKnowledgeSourceParams {
    alwaysQuerySource?: boolean;
    includeReferences?: boolean;
    includeReferenceSourceData?: boolean;
    kind:
        | "azureBlob"
        | "searchIndex"
        | "indexedSharePoint"
        | "indexedOneLake"
        | "web"
        | "remoteSharePoint";
    knowledgeSourceName: string;
    rerankerThreshold?: number;
}

Hierarchy (view full)

Properties

alwaysQuerySource? includeReferences? includeReferenceSourceData? kind knowledgeSourceName rerankerThreshold?

Properties

OptionalalwaysQuerySource

alwaysQuerySource?: boolean

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

OptionalincludeReferences

includeReferences?: boolean

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

OptionalincludeReferenceSourceData

includeReferenceSourceData?: boolean

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

kind

kind:
    | "azureBlob"
    | "searchIndex"
    | "indexedSharePoint"
    | "indexedOneLake"
    | "web"
    | "remoteSharePoint"

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

knowledgeSourceName

knowledgeSourceName: string

The name of the index the params apply to.

OptionalrerankerThreshold

rerankerThreshold?: number

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

Settings

Member Visibility