BaseKnowledgeBaseRetrievalActivityRecord interface
Represents a retrieval activity record.
- Extends
Properties
| count | The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. |
| knowledge |
The knowledge source for the retrieval activity. |
| query |
The query time for this retrieval activity. |
| type | Polymorphic discriminator, which specifies the different types this object can be |
Inherited Properties
| elapsed |
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. |
Property Details
count
The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
count?: numberProperty Value
number
knowledgeSourceName
The knowledge source for the retrieval activity.
knowledgeSourceName?: stringProperty Value
string
queryTime
The query time for this retrieval activity.
queryTime?: DateProperty Value
Date
type
Polymorphic discriminator, which specifies the different types this object can be
type: "azureBlob" | "KnowledgeBaseRetrievalActivityRecord" | "searchIndex" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint"Property Value
"azureBlob" | "KnowledgeBaseRetrievalActivityRecord" | "searchIndex" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint"
Inherited Property Details
elapsedMs
The elapsed time in milliseconds for the retrieval activity.
elapsedMs?: numberProperty Value
number
Inherited From KnowledgeBaseActivityRecord.elapsedMs
error
The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
error?: KnowledgeBaseErrorDetailProperty Value
Inherited From KnowledgeBaseActivityRecord.error
id
The ID of the activity record.
id: numberProperty Value
number
Inherited From KnowledgeBaseActivityRecord.id
