Class FileSearchStore
- Namespace
- GenerativeAI.Types
- Assembly
- GenerativeAI.dll
A File Search store: a managed collection of FileSearchDocuments that the FileSearch tool can retrieve from (managed retrieval-augmented generation).
public class FileSearchStore
- Inheritance
-
FileSearchStore
- Inherited Members
- Extension Methods
Remarks
File Search stores are available on the Gemini Developer API only (not Vertex AI).
Properties
ActiveDocumentsCount
Output only. The number of documents in the store that are active and ready for retrieval.
[JsonPropertyName("activeDocumentsCount")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long? ActiveDocumentsCount { get; set; }
Property Value
- long?
CreateTime
Output only. The timestamp of when the store was created.
[JsonPropertyName("createTime")]
public Timestamp? CreateTime { get; set; }
Property Value
DisplayName
Optional. The human-readable display name for the store (at most 512 characters).
[JsonPropertyName("displayName")]
public string? DisplayName { get; set; }
Property Value
EmbeddingModel
The embedding model used by the store, in the form models/{model}.
When creating a store, leave unset to use the default embedding model.
[JsonPropertyName("embeddingModel")]
public string? EmbeddingModel { get; set; }
Property Value
FailedDocumentsCount
Output only. The number of documents in the store that have failed processing.
[JsonPropertyName("failedDocumentsCount")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long? FailedDocumentsCount { get; set; }
Property Value
- long?
Name
Output only. Immutable. Identifier. The FileSearchStore resource name, for example
fileSearchStores/my-awesome-file-search-store-123a456b789c. The ID is derived from
DisplayName plus a 12 character random suffix, or randomly generated when no display name is given.
[JsonPropertyName("name")]
public string? Name { get; set; }
Property Value
PendingDocumentsCount
Output only. The number of documents in the store that are being processed.
[JsonPropertyName("pendingDocumentsCount")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long? PendingDocumentsCount { get; set; }
Property Value
- long?
SizeBytes
Output only. The size of raw bytes ingested into the store (total size of all its documents).
[JsonPropertyName("sizeBytes")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long? SizeBytes { get; set; }
Property Value
- long?
UpdateTime
Output only. The timestamp of when the store was last updated.
[JsonPropertyName("updateTime")]
public Timestamp? UpdateTime { get; set; }