KnowledgeBaseFileActivityRecord Class

Definition

Represents a File retrieval activity record.

public class KnowledgeBaseFileActivityRecord : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseActivityRecord, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseFileActivityRecord>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseFileActivityRecord>
type KnowledgeBaseFileActivityRecord = class
    inherit KnowledgeBaseActivityRecord
    interface IJsonModel<KnowledgeBaseFileActivityRecord>
    interface IPersistableModel<KnowledgeBaseFileActivityRecord>
Public Class KnowledgeBaseFileActivityRecord
Inherits KnowledgeBaseActivityRecord
Implements IJsonModel(Of KnowledgeBaseFileActivityRecord), IPersistableModel(Of KnowledgeBaseFileActivityRecord)
Inheritance
KnowledgeBaseFileActivityRecord
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)
FileArguments

The File arguments for the retrieval activity.

Id

The ID of the activity record.

(Inherited from KnowledgeBaseActivityRecord)
ImageServing

Statistics about image serving for this retrieval activity.

KnowledgeSourceName

The knowledge source for the retrieval activity.

QueryTime

The query time for this retrieval activity.

Warning

A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

(Inherited from KnowledgeBaseActivityRecord)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

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.

(Inherited from KnowledgeBaseActivityRecord)
IJsonModel<KnowledgeBaseActivityRecord>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from KnowledgeBaseActivityRecord)
IJsonModel<KnowledgeBaseFileActivityRecord>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<KnowledgeBaseFileActivityRecord>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from KnowledgeBaseActivityRecord)
IPersistableModel<KnowledgeBaseActivityRecord>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from KnowledgeBaseActivityRecord)
IPersistableModel<KnowledgeBaseActivityRecord>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from KnowledgeBaseActivityRecord)
IPersistableModel<KnowledgeBaseFileActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseFileActivityRecord>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<KnowledgeBaseFileActivityRecord>.Write(ModelReaderWriterOptions)

Applies to