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 { AutoChunkingStrategy, AutoChunkingStrategy$Outbound } from "./autochunkingstrategy.js"; import { StaticChunkingStrategy, StaticChunkingStrategy$Outbound } from "./staticchunkingstrategy.js"; /** * The expiration policy for a vector store. */ export type ExpiresAfter = { /** * 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; }; /** * The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty. */ export type CreateVectorStoreRequestChunkingStrategy = AutoChunkingStrategy | StaticChunkingStrategy; /** * Retrieval mode, frozen at creation (cannot be changed later). 'vector' (default): standard vector similarity search. 'graph': GraphRAG — entities and relations are extracted from every chunk at ingest (metered against your usage) and search traverses the knowledge graph. */ export declare const RetrievalMode: { readonly Vector: "vector"; readonly Graph: "graph"; }; /** * Retrieval mode, frozen at creation (cannot be changed later). 'vector' (default): standard vector similarity search. 'graph': GraphRAG — entities and relations are extracted from every chunk at ingest (metered against your usage) and search traverses the knowledge graph. */ export type RetrievalMode = ClosedEnum; /** * Request body for creating a vector store. */ export type CreateVectorStoreRequest = { /** * The name of the vector store. */ name?: string | undefined; /** * A description for the vector store. Can be used to describe the vector store's purpose. */ description?: string | undefined; /** * A list of File IDs that the vector store should use. Useful for tools like file_search that can access files. At most 500 per request. */ fileIds?: Array | undefined; /** * The expiration policy for a vector store. */ expiresAfter?: ExpiresAfter | undefined; /** * The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty. */ chunkingStrategy?: AutoChunkingStrategy | StaticChunkingStrategy | undefined; /** * 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. */ metadata?: { [k: string]: string; } | undefined; /** * The embedding model to use. Defaults to the auto-configured model if not specified. */ embeddingModel?: string | undefined; /** * The number of dimensions for the embedding vectors. Only supported for models with flexible dimensions. If not specified, uses the model's default dimensions. */ embeddingDimensions?: number | undefined; /** * Retrieval mode, frozen at creation (cannot be changed later). 'vector' (default): standard vector similarity search. 'graph': GraphRAG — entities and relations are extracted from every chunk at ingest (metered against your usage) and search traverses the knowledge graph. */ retrievalMode?: RetrievalMode | undefined; /** * Model used for entity/relation extraction on graph stores (ingest-time triplet extraction and query-entity extraction). Defaults to the auto-configured model, resolved at creation time — same contract as embedding_model. Only valid when retrieval_mode is 'graph'. */ extractionModel?: string | undefined; /** * Graph expansion depth for graph-mode queries (1-4, engine default 2). Only valid for graph stores. */ maxHops?: number | undefined; }; /** @internal */ export declare const ExpiresAfter$inboundSchema: z.ZodType; /** @internal */ export type ExpiresAfter$Outbound = { anchor: "last_active_at"; days: number; }; /** @internal */ export declare const ExpiresAfter$outboundSchema: z.ZodType; export declare function expiresAfterToJSON(expiresAfter: ExpiresAfter): string; export declare function expiresAfterFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const CreateVectorStoreRequestChunkingStrategy$inboundSchema: z.ZodType; /** @internal */ export type CreateVectorStoreRequestChunkingStrategy$Outbound = AutoChunkingStrategy$Outbound | StaticChunkingStrategy$Outbound; /** @internal */ export declare const CreateVectorStoreRequestChunkingStrategy$outboundSchema: z.ZodType; export declare function createVectorStoreRequestChunkingStrategyToJSON(createVectorStoreRequestChunkingStrategy: CreateVectorStoreRequestChunkingStrategy): string; export declare function createVectorStoreRequestChunkingStrategyFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const RetrievalMode$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const RetrievalMode$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const CreateVectorStoreRequest$inboundSchema: z.ZodType; /** @internal */ export type CreateVectorStoreRequest$Outbound = { name?: string | undefined; description?: string | undefined; file_ids?: Array | undefined; expires_after?: ExpiresAfter$Outbound | undefined; chunking_strategy?: AutoChunkingStrategy$Outbound | StaticChunkingStrategy$Outbound | undefined; metadata?: { [k: string]: string; } | undefined; embedding_model?: string | undefined; embedding_dimensions?: number | undefined; retrieval_mode?: string | undefined; extraction_model?: string | undefined; max_hops?: number | undefined; }; /** @internal */ export declare const CreateVectorStoreRequest$outboundSchema: z.ZodType; export declare function createVectorStoreRequestToJSON(createVectorStoreRequest: CreateVectorStoreRequest): string; export declare function createVectorStoreRequestFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=createvectorstorerequest.d.ts.map