KnowledgeBaseRetrievalActivityRecord Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a retrieval activity record. Please note KnowledgeBaseRetrievalActivityRecord is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include KnowledgeBaseAzureBlobActivityRecord, KnowledgeBaseIndexedOneLakeActivityRecord, KnowledgeBaseIndexedSharePointActivityRecord, KnowledgeBaseRemoteSharePointActivityRecord, KnowledgeBaseSearchIndexActivityRecord and KnowledgeBaseWebActivityRecord.
public class KnowledgeBaseRetrievalActivityRecord : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalActivityRecord>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalActivityRecord>type KnowledgeBaseRetrievalActivityRecord = class
inherit KnowledgeBaseActivityRecord
interface IJsonModel<KnowledgeBaseRetrievalActivityRecord>
interface IPersistableModel<KnowledgeBaseRetrievalActivityRecord>Public Class KnowledgeBaseRetrievalActivityRecord
Inherits KnowledgeBaseActivityRecord
Implements IJsonModel(Of KnowledgeBaseRetrievalActivityRecord), IPersistableModel(Of KnowledgeBaseRetrievalActivityRecord)- Inheritance
- Derived
- Implements
Properties
| Name | Description |
|---|---|
| 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. (Inherited from KnowledgeBaseActivityRecord) |
| Error |
The error detail explaining why the operation failed. This property is only included when the activity does not succeed. (Inherited from KnowledgeBaseActivityRecord) |
| Id |
The ID of the activity record. (Inherited from KnowledgeBaseActivityRecord) |
| KnowledgeSourceName |
The knowledge source for the retrieval activity. |
| QueryTime |
The query time for this retrieval activity. |
Methods
| Name | Description |
|---|---|
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
