WebKnowledgeSourceParams interface

Package:

@azure/search-documents

Specifies runtime parameters for a web knowledge source

Extends

BaseKnowledgeSourceParams

Properties

count	The number of web results to return.
freshness	The freshness of web results.
kind	The discriminator value.
language	The language of the web results.
market	The market of the web results.

Inherited Properties

includeReferences	Indicates whether references should be included for data retrieved from this source.
includeReferenceSourceData	Indicates whether references should include the structured data obtained during retrieval in their payload.
knowledgeSourceName	The name of the index the params apply to.
rerankerThreshold	The reranker threshold all retrieved documents must meet to be included in the response.

Property Details

count

The number of web results to return.

count?: number

Property Value

number

freshness

The freshness of web results.

freshness?: string

Property Value

string

kind

The discriminator value.

kind: "web"

Property Value

"web"

language

The language of the web results.

language?: string

Property Value

string

market

The market of the web results.

market?: string

Property Value

string

Inherited Property Details

includeReferences

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

includeReferences?: boolean

Property Value

boolean

Inherited From KnowledgeSourceParams.includeReferences

includeReferenceSourceData

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

includeReferenceSourceData?: boolean

Property Value

boolean

Inherited From KnowledgeSourceParams.includeReferenceSourceData

knowledgeSourceName

The name of the index the params apply to.

knowledgeSourceName: string

Property Value

string

Inherited From KnowledgeSourceParams.knowledgeSourceName

rerankerThreshold

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

rerankerThreshold?: number

Property Value

number

Inherited From KnowledgeSourceParams.rerankerThreshold