KnowledgeBaseIndexedSharePointActivityRecord Class

Definition

Namespace:: Azure.Search.Documents.KnowledgeBases.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.8.0-beta.1

Source:: KnowledgeBaseIndexedSharePointActivityRecord.cs

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 indexed SharePoint retrieval activity record.

public class KnowledgeBaseIndexedSharePointActivityRecord : Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseRetrievalActivityRecord, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseIndexedSharePointActivityRecord>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.KnowledgeBases.Models.KnowledgeBaseIndexedSharePointActivityRecord>

type KnowledgeBaseIndexedSharePointActivityRecord = class
    inherit KnowledgeBaseRetrievalActivityRecord
    interface IJsonModel<KnowledgeBaseIndexedSharePointActivityRecord>
    interface IPersistableModel<KnowledgeBaseIndexedSharePointActivityRecord>

Public Class KnowledgeBaseIndexedSharePointActivityRecord
Inherits KnowledgeBaseRetrievalActivityRecord
Implements IJsonModel(Of KnowledgeBaseIndexedSharePointActivityRecord), IPersistableModel(Of KnowledgeBaseIndexedSharePointActivityRecord)

Inheritance: Object

KnowledgeBaseActivityRecord

KnowledgeBaseRetrievalActivityRecord
KnowledgeBaseIndexedSharePointActivityRecord

Implements: IJsonModel<KnowledgeBaseIndexedSharePointActivityRecord> IPersistableModel<KnowledgeBaseIndexedSharePointActivityRecord> IPersistableModel<T>

Properties

Name	Description
Count	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. (Inherited from KnowledgeBaseRetrievalActivityRecord)
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)
IndexedSharePointArguments	The indexed SharePoint arguments for the retrieval activity.
KnowledgeSourceName	The knowledge source for the retrieval activity. (Inherited from KnowledgeBaseRetrievalActivityRecord)
QueryTime	The query time for this retrieval activity. (Inherited from KnowledgeBaseRetrievalActivityRecord)

Methods

Name	Description
JsonModelWriteCore(Utf8JsonWriter, 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<KnowledgeBaseIndexedSharePointActivityRecord>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<KnowledgeBaseIndexedSharePointActivityRecord>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<KnowledgeBaseRetrievalActivityRecord>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from KnowledgeBaseRetrievalActivityRecord)
IJsonModel<KnowledgeBaseRetrievalActivityRecord>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from KnowledgeBaseRetrievalActivityRecord)
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<KnowledgeBaseIndexedSharePointActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<KnowledgeBaseIndexedSharePointActivityRecord>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<KnowledgeBaseIndexedSharePointActivityRecord>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<KnowledgeBaseRetrievalActivityRecord>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from KnowledgeBaseRetrievalActivityRecord)
IPersistableModel<KnowledgeBaseRetrievalActivityRecord>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from KnowledgeBaseRetrievalActivityRecord)
IPersistableModel<KnowledgeBaseRetrievalActivityRecord>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from KnowledgeBaseRetrievalActivityRecord)

Applies to

Feedback

Was this page helpful?