Package version:

Interface WebKnowledgeSourceParams

Specifies runtime parameters for a web knowledge source

interface WebKnowledgeSourceParams {
    alwaysQuerySource?: boolean;
    count?: number;
    freshness?: string;
    includeReferences?: boolean;
    includeReferenceSourceData?: boolean;
    kind: "web";
    knowledgeSourceName: string;
    language?: string;
    market?: string;
    rerankerThreshold?: number;
}

Hierarchy (view full)

Properties

alwaysQuerySource? count? freshness? includeReferences? includeReferenceSourceData? kind knowledgeSourceName language? market? rerankerThreshold?

Properties

OptionalalwaysQuerySource

alwaysQuerySource?: boolean

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

Optionalcount

count?: number

The number of web results to return.

Optionalfreshness

freshness?: string

The freshness of web results.

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

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

knowledgeSourceName

knowledgeSourceName: string

The name of the index the params apply to.

Optionallanguage

language?: string

The language of the web results.

Optionalmarket

market?: string

The market of the web results.

OptionalrerankerThreshold

rerankerThreshold?: number

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

Settings

Member Visibility