Class FileSearchDocument
- Namespace
- GenerativeAI.Types
- Assembly
- GenerativeAI.dll
A document inside a FileSearchStore: a file that has been chunked and embedded for retrieval.
public class FileSearchDocument
- Inheritance
-
FileSearchDocument
- Inherited Members
- Extension Methods
Properties
CreateTime
Output only. The timestamp of when the document was created.
[JsonPropertyName("createTime")]
public Timestamp? CreateTime { get; set; }
Property Value
CustomMetadata
Optional. User provided custom metadata stored as key-value pairs, usable in MetadataFilter. A document can have at most 20 entries.
[JsonPropertyName("customMetadata")]
public List<CustomMetadata>? CustomMetadata { get; set; }
Property Value
DisplayName
Optional. The human-readable display name for the document (at most 512 characters).
[JsonPropertyName("displayName")]
public string? DisplayName { get; set; }
Property Value
MimeType
Output only. The MIME type of the document.
[JsonPropertyName("mimeType")]
public string? MimeType { get; set; }
Property Value
Name
Immutable. Identifier. The document resource name, for example
fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c.
[JsonPropertyName("name")]
public string? Name { get; set; }
Property Value
SizeBytes
Output only. The size of raw bytes ingested into the document.
[JsonPropertyName("sizeBytes")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long? SizeBytes { get; set; }
Property Value
- long?
State
Output only. Current processing state of the document.
[JsonPropertyName("state")]
public FileSearchDocumentState? State { get; set; }
Property Value
UpdateTime
Output only. The timestamp of when the document was last updated.
[JsonPropertyName("updateTime")]
public Timestamp? UpdateTime { get; set; }