Lingua

SearchModelFactory.KnowledgeSourceFile Method

Definition

Metadata for a file uploaded to a File knowledge source.

public static Azure.Search.Documents.Indexes.Models.KnowledgeSourceFile KnowledgeSourceFile(string fileId = default, string fileName = default, long? fileSizeBytes = default, DateTimeOffset? createdOn = default, DateTimeOffset? lastUpdatedOn = default, string errorMessage = default, string prefix = default, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default, Azure.Search.Documents.Indexes.Models.BlobIndexerParsingMode? parsingMode = default, Azure.Search.Documents.Indexes.Models.FileKnowledgeSourceExtractionMode? extractionMode = default);
static member KnowledgeSourceFile : string * string * Nullable<int64> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * string * string * System.Collections.Generic.IReadOnlyDictionary<string, string> * Nullable<Azure.Search.Documents.Indexes.Models.BlobIndexerParsingMode> * Nullable<Azure.Search.Documents.Indexes.Models.FileKnowledgeSourceExtractionMode> -> Azure.Search.Documents.Indexes.Models.KnowledgeSourceFile
Public Shared Function KnowledgeSourceFile (Optional fileId As String = Nothing, Optional fileName As String = Nothing, Optional fileSizeBytes As Nullable(Of Long) = Nothing, Optional createdOn As Nullable(Of DateTimeOffset) = Nothing, Optional lastUpdatedOn As Nullable(Of DateTimeOffset) = Nothing, Optional errorMessage As String = Nothing, Optional prefix As String = Nothing, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing, Optional parsingMode As Nullable(Of BlobIndexerParsingMode) = Nothing, Optional extractionMode As Nullable(Of FileKnowledgeSourceExtractionMode) = Nothing) As KnowledgeSourceFile

Parameters

fileId
String

The unique identifier for the file.

fileName
String

The original file name.

fileSizeBytes
Nullable<Int64>

The file size in bytes.

createdOn
Nullable<DateTimeOffset>

The timestamp when the file was created.

lastUpdatedOn
Nullable<DateTimeOffset>

The timestamp when the file was last updated.

errorMessage
String

The error message if file processing failed, null otherwise.

prefix
String

The prefix (directory-like path) derived from the full file name.

metadata
IReadOnlyDictionary<String,String>

Custom key/value metadata stored with the file. Returned but not searchable or filterable.

parsingMode
Nullable<BlobIndexerParsingMode>

The parsing mode applied to the file (auto-detected from the file).

extractionMode
Nullable<FileKnowledgeSourceExtractionMode>

The extraction mode applied to the file.

Returns

A new KnowledgeSourceFile instance for mocking.

Applies to