import {z} from 'zod' export type GetApiApiV1IndexIndexIdArgs = {apikey: string, index_id: number}; export type GetApiApiV1IndexIndexIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const lexicalSimilarity = z.enum(["Bm25f", "Bm25fProximity"]); export const tokenizerType = z.enum(["AsciiAlphabetic", "UnicodeAlphanumeric", "UnicodeAlphanumericFolded", "Whitespace", "WhitespaceLowercase", "UnicodeAlphanumericZH"]); export const stemmerType = z.enum(["None", "Arabic", "Armenian", "Basque", "Catalan", "Czech", "Danish", "Dutch", "DutchPorter", "English", "Esperanto", "Estonian", "Finnish", "French", "German", "Greek", "Hindi", "Hungarian", "Indonesian", "Irish", "Italian", "Lithuanian", "Lovins", "Nepali", "Norwegian", "Persian", "Polish", "Porter", "Portuguese", "Romanian", "Russian", "Serbian", "Sesotho", "Spanish", "Swedish", "Tamil", "Turkish", "Ukrainian", "Yiddish"]); export const stopwordType = z.union([z.literal("None"), z.literal("English"), z.literal("German"), z.literal("French"), z.literal("Spanish"), z.object({Custom: z.object({terms: z.array(z.string())})})]); export const frequentwordType = z.union([z.literal("None"), z.literal("English"), z.literal("German"), z.literal("French"), z.literal("Spanish"), z.object({Custom: z.object({terms: z.array(z.string())})})]); export const documentCompression = z.enum(["None", "Lz4", "Snappy", "Zstd"]); export const accessType = z.enum(["Ram", "Mmap"]); export const spellingCorrection = z.object({max_dictionary_edit_distance: z.number().int().gte(0), term_length_threshold: z.array(z.number().int().gte(0)).nullable().optional(), count_threshold: z.number().int().gte(0), max_dictionary_entries: z.number().int().gte(0)}); export const queryCompletion = z.object({max_completion_entries: z.number().int().gte(0)}); export const clustering = z.union([z.literal("None"), z.literal("Auto"), z.object({Fixed: z.number().int().gte(0)})]); export const model = z.enum(["PotionCode16MV2", "PotionBase32M", "PotionMultilingual128M", "PotionRetrieval32M", "PotionBase8M", "PotionBase4M", "PotionBase2M"]); export const quantization = z.enum(["ScalarQuantizationI8", "TurboQuantI8", "None"]); export const precision = z.enum(["None", "F32", "I8"]); export const vectorSimilarity = z.enum(["Cosine", "Dot", "Euclidean"]); export const inference = z.union([z.object({Model2Vec: z.object({model: model, chunk_size: z.number().int().gte(0), quantization: quantization})}), z.object({Model2VecCustom: z.object({path: z.string(), chunk_size: z.number().int().gte(0), quantization: quantization})}), z.object({External: z.object({dimensions: z.number().int().gte(0), precision: precision, quantization: quantization, similarity: vectorSimilarity})}), z.literal("None")]); export const indexConfig = z.object({name: z.string().optional(), lexical_similarity: lexicalSimilarity.optional(), tokenizer: tokenizerType.optional(), stemmer: stemmerType.optional(), stop_words: stopwordType.optional(), frequent_words: frequentwordType.optional(), ngram_indexing: z.number().int().gte(0).optional(), document_compression: documentCompression.optional(), access_type: accessType.optional(), spelling_correction: spellingCorrection.nullable().optional(), query_completion: queryCompletion.nullable().optional(), clustering: clustering.optional(), inference: inference.optional()}); export const fieldType = z.enum(["U8", "U16", "U32", "U64", "I8", "I16", "I32", "I64", "Timestamp", "F32", "F64", "Bool", "String16", "String32", "StringSet16", "StringSet32", "Point", "Text", "Json", "Binary"]); export const schemaField = z.object({field: z.string(), store: z.boolean().optional(), index_lexical: z.boolean().optional(), index_vector: z.boolean().optional(), field_type: fieldType.optional(), facet: z.boolean().optional(), longest: z.boolean().optional(), boost: z.number().optional(), dictionary_source: z.boolean().optional(), completion_source: z.boolean().optional()}); export const minMaxFieldJson = z.object({min: z.unknown(), max: z.unknown()}); export const indexResponseObject = z.object({id: z.number().int().gte(0), name: z.string(), index_config: indexConfig.optional(), schema: z.record(z.string(), schemaField), indexed_doc_count: z.number().int().gte(0), committed_doc_count: z.number().int().gte(0), operations_count: z.number().int().gte(0), query_count: z.number().int().gte(0), version: z.string(), facets_minmax: z.record(z.string(), minMaxFieldJson)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get Index Info * * GET /api/v1/index/{index_id} */ export const getApiApiV1IndexIndexId = async (args: GetApiApiV1IndexIndexIdArgs, options?: GetApiApiV1IndexIndexIdOptions) => { const {baseUrl = "http://127.0.0.1", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.apikey != null) headers.set("apikey", String(args.apikey)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/index/${encodeURIComponent(String(args.index_id))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(indexResponseObject, await res.json()) };