KnowledgeSourceFile Class

Definition

Namespace:

Azure.Search.Documents.Indexes.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v12.1.0-beta.2

Source:

KnowledgeSourceFile.cs

Metadata for a file uploaded to a File knowledge source.

public class KnowledgeSourceFile : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.KnowledgeSourceFile>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.KnowledgeSourceFile>

type KnowledgeSourceFile = class
    interface IJsonModel<KnowledgeSourceFile>
    interface IPersistableModel<KnowledgeSourceFile>

Public Class KnowledgeSourceFile
Implements IJsonModel(Of KnowledgeSourceFile), IPersistableModel(Of KnowledgeSourceFile)

Inheritance

Object

KnowledgeSourceFile

Implements

IJsonModel<KnowledgeSourceFile> IPersistableModel<KnowledgeSourceFile> IPersistableModel<T>

Properties

Name	Description
CreatedOn	The timestamp when the file was created.
ErrorMessage	The error message if file processing failed, null otherwise.
ExtractionMode	The extraction mode applied to the file.
FileId	The unique identifier for the file.
FileName	The original file name.
FileSizeBytes	The file size in bytes.
LastUpdatedOn	The timestamp when the file was last updated.
Metadata	Custom key/value metadata stored with the file. Returned but not searchable or filterable.
ParsingMode	The parsing mode applied to the file (auto-detected from the file).
Prefix	The prefix (directory-like path) derived from the full file name.

Methods

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

Operators

Name	Description
Explicit(Response to KnowledgeSourceFile)

Explicit Interface Implementations

Name	Description
IJsonModel<KnowledgeSourceFile>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<KnowledgeSourceFile>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<KnowledgeSourceFile>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<KnowledgeSourceFile>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<KnowledgeSourceFile>.Write(ModelReaderWriterOptions)