KnowledgeBaseFileReference interface

Package:
@azure/search-documents

Represents a file document reference.

Extends
BaseKnowledgeBaseReference

Properties

docName

The document name for the reference.
type

The discriminator value.

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

docName

The document name for the reference.

docName?: string

Property Value

string

type

The discriminator value.

type: "file"

Property Value

"file"

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