@ingram-cloud/sdk 1.2.0 → 1.5.0

package/ts/zod/vector-stores.ts

@@ -7,13 +7,16 @@
  * filter grammar, and the `search_results.page` envelope are OpenAI's, wart for
  * wart (modify is `POST`, the batch object is `vector_store.files_batch`, the
  * search page uses a `next_page` token while CRUD lists use `first_id`/
- * `last_id`). `smith_id` is the one documented IC extension: it scopes a store
- * to a single smith ("" = tenant-wide), the same isolation boundary every other
- * smith-owned resource has. Expiration policies (`expires_after`), query
+ * `last_id`). Two documented IC extensions: `smith_id` scopes a store to a
+ * single smith ("" = tenant-wide), the same isolation boundary every other
+ * smith-owned resource has; `embedding_model` names the store's embedder,
+ * frozen at create (OpenAI pins one platform-wide, Gemini's File Search exposes
+ * it the same way). Expiration policies (`expires_after`), query
  * rewriting, and rankers are not implemented — the fields don't exist here
  * rather than being accepted and ignored.
  */
 import { z } from "zod";
+import { oaiListOut } from "./_page.js";
 
 // ── Chunking ─────────────────────────────────────────────────────────────────
 
@@ -51,7 +54,9 @@ export const ChunkingStrategyOut = z
 /** File attributes: ≤16 keys, key ≤64 chars, value string(≤512)|number|bool. */
 export const VectorStoreAttributes = z
 	.record(z.string().max(64), z.union([z.string().max(512), z.number(), z.boolean()]))
-	.refine((v) => Object.keys(v).length <= 16, { message: "at most 16 attribute keys" });
+	.refine((v) => Object.keys(v).length <= 16, {
+		message: "at most 16 attribute keys",
+	});
 
 /** A filter node: a comparison (`type` eq/ne/gt/gte/lt/lte/in/nin over `key`/
  *  `value`) or a compound (`type` and/or over nested `filters`). The grammar is
@@ -95,6 +100,11 @@ export const VectorStoreIn = z
 		metadata: z.record(z.string(), z.unknown()).optional(),
 		/** IC extension: own the store to one smith ("" / omitted = tenant-wide). */
 		smith_id: z.string().optional(),
+		/** IC extension: the embedder to index and query this store with, frozen at
+		 *  create (omitted = the platform default). Any model your OpenAI-provider
+		 *  key can reach — including an EU-hosted OpenAI-compatible endpoint set as
+		 *  that key's `base_url` — of at most 1536 dimensions. */
+		embedding_model: z.string().optional(),
 	})
 	.meta({ id: "VectorStoreIn" });
 
@@ -124,19 +134,14 @@ export const VectorStoreOut = z
 		metadata: z.record(z.string(), z.unknown()),
 		/** IC extension: the owning smith ("" = tenant-wide). */
 		smith_id: z.string(),
+		/** IC extension: the embedder this store is indexed and queried with,
+		 *  frozen at create. */
+		embedding_model: z.string(),
 	})
 	.meta({ id: "VectorStoreOut" });
 
 /** Vector stores, in OpenAI's `list` envelope. */
-export const VectorStoreListOut = z
-	.object({
-		object: z.literal("list"),
-		data: z.array(VectorStoreOut),
-		first_id: z.string().nullable(),
-		last_id: z.string().nullable(),
-		has_more: z.boolean(),
-	})
-	.meta({ id: "VectorStoreListOut" });
+export const VectorStoreListOut = oaiListOut(VectorStoreOut, "VectorStoreListOut");
 
 /** Modify body (OpenAI uses `POST`, not `PATCH`). */
 export const VectorStorePatch = z
@@ -176,7 +181,12 @@ export const VectorStoreFileOut = z
 		status: z.enum(["in_progress", "completed", "failed", "cancelled"]),
 		last_error: z
 			.object({
-				code: z.enum(["server_error", "unsupported_file", "invalid_file"]),
+				code: z.enum([
+					"server_error",
+					"unsupported_file",
+					"no_text_layer",
+					"invalid_file",
+				]),
 				message: z.string(),
 			})
 			.nullable(),
@@ -185,15 +195,10 @@ export const VectorStoreFileOut = z
 	})
 	.meta({ id: "VectorStoreFileOut" });
 
-export const VectorStoreFileListOut = z
-	.object({
-		object: z.literal("list"),
-		data: z.array(VectorStoreFileOut),
-		first_id: z.string().nullable(),
-		last_id: z.string().nullable(),
-		has_more: z.boolean(),
-	})
-	.meta({ id: "VectorStoreFileListOut" });
+export const VectorStoreFileListOut = oaiListOut(
+	VectorStoreFileOut,
+	"VectorStoreFileListOut",
+);
 
 /** Update body: attributes only (chunking is frozen once indexed). */
 export const VectorStoreFileUpdate = z
@@ -202,6 +207,18 @@ export const VectorStoreFileUpdate = z
 	})
 	.meta({ id: "VectorStoreFileUpdate" });
 
+/** The parsed text a file was indexed as, chunk by chunk, in OpenAI's
+ *  `vector_store.file_content.page` envelope. The whole file is one page — the
+ *  paging fields are the envelope's shape, not a promise of more. */
+export const VectorStoreFileContentOut = z
+	.object({
+		object: z.literal("vector_store.file_content.page"),
+		data: z.array(z.object({ type: z.literal("text"), text: z.string() })),
+		has_more: z.literal(false),
+		next_page: z.null(),
+	})
+	.meta({ id: "VectorStoreFileContentOut" });
+
 export const VectorStoreFileDeleted = z
 	.object({
 		id: z.string(),
@@ -291,6 +308,7 @@ export const VectorStoreSearchOut = z
 
 export type ICVectorStore = z.infer<typeof VectorStoreOut>;
 export type ICVectorStoreFile = z.infer<typeof VectorStoreFileOut>;
+export type ICVectorStoreFileContentPage = z.infer<typeof VectorStoreFileContentOut>;
 export type ICVectorStoreFileBatch = z.infer<typeof VectorStoreFileBatchOut>;
 export type ICVectorStoreSearchPage = z.infer<typeof VectorStoreSearchOut>;
 export type ICVectorStoreAttributes = z.infer<typeof VectorStoreAttributes>;