KnowledgeBaseActivityRecord 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.
Base type for activity records. Tracks execution details, timing, and errors for knowledge base operations. Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseModelWebSummarizationActivityRecord and KnowledgeBaseAgenticReasoningActivityRecord.
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.KnowledgeBases.Models.UnknownKnowledgeBaseActivityRecord))]
public abstract class KnowledgeBaseActivityRecord : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord>
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownKnowledgeBaseActivityRecord))]
public abstract class KnowledgeBaseActivityRecord : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.KnowledgeBases.Models.UnknownKnowledgeBaseActivityRecord))>]
type KnowledgeBaseActivityRecord = class
interface IJsonModel<KnowledgeBaseActivityRecord>
interface IPersistableModel<KnowledgeBaseActivityRecord>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.Search.Documents.Models.UnknownKnowledgeBaseActivityRecord))>]
type KnowledgeBaseActivityRecord = class
interface IJsonModel<KnowledgeBaseActivityRecord>
interface IPersistableModel<KnowledgeBaseActivityRecord>
Public MustInherit Class KnowledgeBaseActivityRecord
Implements IJsonModel(Of KnowledgeBaseActivityRecord), IPersistableModel(Of KnowledgeBaseActivityRecord)
- Inheritance
-
KnowledgeBaseActivityRecord
- Derived
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| KnowledgeBaseActivityRecord(Int32) |
Initializes a new instance of KnowledgeBaseActivityRecord. |
Properties
| Name | Description |
|---|---|
| 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. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<KnowledgeBaseActivityRecord>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<KnowledgeBaseActivityRecord>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<KnowledgeBaseActivityRecord>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<KnowledgeBaseActivityRecord>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<KnowledgeBaseActivityRecord>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |