import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import { FileCounts, FileCounts$Outbound } from "./filecounts.js"; /** * Retrieval mode, frozen at creation. 'vector': standard vector similarity search. 'graph': GraphRAG — entities and relations are extracted at ingest and queries traverse the knowledge graph. 'hybrid' is reserved. */ export declare const VectorStoreRetrievalMode: { readonly Vector: "vector"; readonly Hybrid: "hybrid"; readonly Graph: "graph"; }; /** * Retrieval mode, frozen at creation. 'vector': standard vector similarity search. 'graph': GraphRAG — entities and relations are extracted at ingest and queries traverse the knowledge graph. 'hybrid' is reserved. */ export type VectorStoreRetrievalMode = ClosedEnum; /** * The status of the vector store. 'expired' means the store has expired, 'in_progress' means files are still being processed, 'completed' indicates that the vector store is ready for use. */ export declare const VectorStoreStatus: { readonly Expired: "expired"; readonly InProgress: "in_progress"; readonly Completed: "completed"; }; /** * The status of the vector store. 'expired' means the store has expired, 'in_progress' means files are still being processed, 'completed' indicates that the vector store is ready for use. */ export type VectorStoreStatus = ClosedEnum; /** * The expiration policy for a vector store. */ export type VectorStoreExpiresAfter = { /** * Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at. */ anchor: "last_active_at"; /** * The number of days after the anchor time that the vector store will expire. */ days: number; }; export type VectorStoreMetadata = string | boolean | number; /** * A vector store is a collection of processed files that can be used by the file_search tool. */ export type VectorStore = { /** * The identifier, which can be referenced in API endpoints. */ id: string; /** * The object type, which is always 'vector_store'. */ object: "vector_store"; /** * The Unix timestamp (in seconds) for when the vector store was created. */ createdAt: number; /** * The name of the vector store. */ name: string | null; /** * The total number of bytes used by the files in the vector store. */ usageBytes: number; /** * The embedding model used for this vector store. Resolved at creation time from the requested or auto model. Null for legacy vector stores. */ embeddingModel: string | null; /** * The number of dimensions for the embedding vectors in this vector store. Null for legacy vector stores. */ embeddingDimensions: number | null; /** * Retrieval mode, frozen at creation. 'vector': standard vector similarity search. 'graph': GraphRAG — entities and relations are extracted at ingest and queries traverse the knowledge graph. 'hybrid' is reserved. */ retrievalMode: VectorStoreRetrievalMode; /** * The model used for entity/relation extraction on graph stores. Null for non-graph stores. */ extractionModel?: string | null | undefined; /** * Graph expansion depth for graph-mode queries. Null for non-graph stores. */ maxHops?: number | null | undefined; /** * File processing status counts. */ fileCounts: FileCounts; /** * The status of the vector store. 'expired' means the store has expired, 'in_progress' means files are still being processed, 'completed' indicates that the vector store is ready for use. */ status: VectorStoreStatus; /** * The expiration policy for a vector store. */ expiresAfter?: VectorStoreExpiresAfter | undefined; /** * The Unix timestamp (in seconds) for when the vector store will expire. */ expiresAt?: number | null | undefined; /** * The Unix timestamp (in seconds) for when the vector store was last active. */ lastActiveAt: number | null; /** * Set of 16 key-value pairs that can be attached to an object. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers. */ metadata: { [k: string]: string | boolean | number; }; /** * A description for the vector store. Can be used to describe the vector store's purpose. */ description?: string | null | undefined; /** * The Unix timestamp (in seconds) for when the vector store was last used. */ lastUsedAt: number | null; }; /** @internal */ export declare const VectorStoreRetrievalMode$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const VectorStoreRetrievalMode$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const VectorStoreStatus$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const VectorStoreStatus$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const VectorStoreExpiresAfter$inboundSchema: z.ZodType; /** @internal */ export type VectorStoreExpiresAfter$Outbound = { anchor: "last_active_at"; days: number; }; /** @internal */ export declare const VectorStoreExpiresAfter$outboundSchema: z.ZodType; export declare function vectorStoreExpiresAfterToJSON(vectorStoreExpiresAfter: VectorStoreExpiresAfter): string; export declare function vectorStoreExpiresAfterFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const VectorStoreMetadata$inboundSchema: z.ZodType; /** @internal */ export type VectorStoreMetadata$Outbound = string | boolean | number; /** @internal */ export declare const VectorStoreMetadata$outboundSchema: z.ZodType; export declare function vectorStoreMetadataToJSON(vectorStoreMetadata: VectorStoreMetadata): string; export declare function vectorStoreMetadataFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const VectorStore$inboundSchema: z.ZodType; /** @internal */ export type VectorStore$Outbound = { id: string; object: "vector_store"; created_at: number; name: string | null; usage_bytes: number; embedding_model: string | null; embedding_dimensions: number | null; retrieval_mode: string; extraction_model?: string | null | undefined; max_hops?: number | null | undefined; file_counts: FileCounts$Outbound; status: string; expires_after?: VectorStoreExpiresAfter$Outbound | undefined; expires_at?: number | null | undefined; last_active_at: number | null; metadata: { [k: string]: string | boolean | number; }; description?: string | null | undefined; last_used_at: number | null; }; /** @internal */ export declare const VectorStore$outboundSchema: z.ZodType; export declare function vectorStoreToJSON(vectorStore: VectorStore): string; export declare function vectorStoreFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=vectorstore.d.ts.map