KnowledgeBaseWebReference interface

Package:

@azure/search-documents

Represents a web document reference.

Extends

BaseKnowledgeBaseReference

Properties

title	The title of the web document.
type	The discriminator value.
url	The url the reference data originated from.

Inherited Properties

activitySource	The source activity ID for the reference.
id	The ID of the reference.
rerankerScore	The reranker score for the document reference.
sourceData	The source data for the reference.

Property Details

title

The title of the web document.

title?: string

Property Value

string

type

The discriminator value.

type: "web"

Property Value

"web"

url

The url the reference data originated from.

url?: string

Property Value

string

Inherited Property Details

activitySource

The source activity ID for the reference.

activitySource: number

Property Value

number

Inherited From KnowledgeBaseReference.activitySource

id

The ID of the reference.

id: string

Property Value

string

Inherited From KnowledgeBaseReference.id

rerankerScore

The reranker score for the document reference.

rerankerScore?: number

Property Value

number

Inherited From KnowledgeBaseReference.rerankerScore

sourceData

The source data for the reference.

sourceData?: Record<string, unknown>

Property Value

Record<string, unknown>

Inherited From KnowledgeBaseReference.sourceData