KnowledgeBaseWebActivityRecord interface

Package:

@azure/search-documents

Represents a web retrieval activity record.

Extends

BaseKnowledgeBaseRetrievalActivityRecord

Properties

type	Polymorphic discriminator, which specifies the different types this object can be
webArguments	The web arguments for the retrieval activity.

Inherited Properties

count	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	The elapsed time in milliseconds for the retrieval activity.
error	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	The ID of the activity record.
knowledgeSourceName	The knowledge source for the retrieval activity.
queryTime	The query time for this retrieval activity.

Property Details

type

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

type: "web"

Property Value

"web"

webArguments

The web arguments for the retrieval activity.

webArguments?: KnowledgeBaseWebActivityArguments

Property Value

KnowledgeBaseWebActivityArguments

Inherited Property Details

count

The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.

count?: number

Property Value

number

Inherited From KnowledgeBaseRetrievalActivityRecord.count

elapsedMs

The elapsed time in milliseconds for the retrieval activity.

elapsedMs?: number

Property Value

number

Inherited From KnowledgeBaseRetrievalActivityRecord.elapsedMs

error

The error detail explaining why the operation failed. This property is only included when the activity does not succeed.

error?: KnowledgeBaseErrorDetail

Property Value

KnowledgeBaseErrorDetail

Inherited From KnowledgeBaseRetrievalActivityRecord.error

id

The ID of the activity record.

id: number

Property Value

number

Inherited From KnowledgeBaseRetrievalActivityRecord.id

knowledgeSourceName

The knowledge source for the retrieval activity.

knowledgeSourceName?: string

Property Value

string

Inherited From KnowledgeBaseRetrievalActivityRecord.knowledgeSourceName

queryTime

The query time for this retrieval activity.

queryTime?: Date

Property Value

Date

Inherited From KnowledgeBaseRetrievalActivityRecord.queryTime