ogx-client 0.7.2-rc1

package/src/resources/vector-stores/file-batches.ts

@@ -0,0 +1,386 @@
+// Copyright (c) The OGX Contributors.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as FilesAPI from './files';
+import { VectorStoreFilesOpenAICursorPage } from './files';
+import { type OpenAICursorPageParams } from '../../pagination';
+
+export class FileBatches extends APIResource {
+  /**
+   * Create a vector store file batch (OpenAI-compatible).
+   */
+  create(
+    vectorStoreId: string,
+    body: FileBatchCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFileBatches> {
+    return this._client.post(`/v1/vector_stores/${vectorStoreId}/file_batches`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a vector store file batch (OpenAI-compatible).
+   */
+  retrieve(
+    vectorStoreId: string,
+    batchId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFileBatches> {
+    return this._client.get(`/v1/vector_stores/${vectorStoreId}/file_batches/${batchId}`, options);
+  }
+
+  /**
+   * Cancel a vector store file batch (OpenAI-compatible).
+   */
+  cancel(
+    vectorStoreId: string,
+    batchId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFileBatches> {
+    return this._client.post(`/v1/vector_stores/${vectorStoreId}/file_batches/${batchId}/cancel`, options);
+  }
+
+  /**
+   * List files in a vector store file batch (OpenAI-compatible).
+   */
+  listFiles(
+    vectorStoreId: string,
+    batchId: string,
+    query?: FileBatchListFilesParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VectorStoreFilesOpenAICursorPage, FilesAPI.VectorStoreFile>;
+  listFiles(
+    vectorStoreId: string,
+    batchId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VectorStoreFilesOpenAICursorPage, FilesAPI.VectorStoreFile>;
+  listFiles(
+    vectorStoreId: string,
+    batchId: string,
+    query: FileBatchListFilesParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VectorStoreFilesOpenAICursorPage, FilesAPI.VectorStoreFile> {
+    if (isRequestOptions(query)) {
+      return this.listFiles(vectorStoreId, batchId, {}, query);
+    }
+    return this._client.getAPIList(
+      `/v1/vector_stores/${vectorStoreId}/file_batches/${batchId}/files`,
+      VectorStoreFilesOpenAICursorPage,
+      { query, ...options },
+    );
+  }
+}
+
+/**
+ * Response from listing files in a vector store file batch.
+ */
+export interface ListVectorStoreFilesInBatchResponse {
+  data: Array<FilesAPI.VectorStoreFile>;
+
+  first_id: string;
+
+  has_more: boolean;
+
+  last_id: string;
+
+  object?: 'list';
+}
+
+/**
+ * OpenAI Vector Store File Batch object.
+ */
+export interface VectorStoreFileBatches {
+  id: string;
+
+  created_at: number;
+
+  /**
+   * File processing status counts for a vector store.
+   */
+  file_counts: VectorStoreFileBatches.FileCounts;
+
+  status: 'in_progress' | 'completed' | 'cancelled' | 'failed';
+
+  vector_store_id: string;
+
+  object?: 'vector_store.files_batch';
+}
+
+export namespace VectorStoreFileBatches {
+  /**
+   * File processing status counts for a vector store.
+   */
+  export interface FileCounts {
+    cancelled: number;
+
+    completed: number;
+
+    failed: number;
+
+    in_progress: number;
+
+    total: number;
+  }
+}
+
+export interface FileBatchCreateParams {
+  /**
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard. Keys are strings with a maximum
+   * length of 64 characters. Values are strings with a maximum length of 512
+   * characters, booleans, or numbers.
+   */
+  attributes?: { [key: string]: string | number | boolean } | null;
+
+  /**
+   * Automatic chunking strategy for vector store files.
+   */
+  chunking_strategy?:
+    | FileBatchCreateParams.VectorStoreChunkingStrategyAuto
+    | FileBatchCreateParams.VectorStoreChunkingStrategyStatic
+    | FileBatchCreateParams.VectorStoreChunkingStrategyContextual
+    | null;
+
+  file_ids?: Array<string>;
+
+  files?: Array<FileBatchCreateParams.File> | null;
+
+  [k: string]: unknown;
+}
+
+export namespace FileBatchCreateParams {
+  /**
+   * Automatic chunking strategy for vector store files.
+   */
+  export interface VectorStoreChunkingStrategyAuto {
+    type?: 'auto';
+  }
+
+  /**
+   * Static chunking strategy with configurable parameters.
+   */
+  export interface VectorStoreChunkingStrategyStatic {
+    /**
+     * Configuration for static chunking strategy.
+     */
+    static: VectorStoreChunkingStrategyStatic.Static;
+
+    type?: 'static';
+  }
+
+  export namespace VectorStoreChunkingStrategyStatic {
+    /**
+     * Configuration for static chunking strategy.
+     */
+    export interface Static {
+      chunk_overlap_tokens?: number;
+
+      max_chunk_size_tokens?: number;
+    }
+  }
+
+  /**
+   * Contextual chunking strategy that uses an LLM to situate chunks within the
+   * document.
+   */
+  export interface VectorStoreChunkingStrategyContextual {
+    /**
+     * Configuration for contextual chunking.
+     */
+    contextual: VectorStoreChunkingStrategyContextual.Contextual;
+
+    /**
+     * Strategy type identifier.
+     */
+    type?: 'contextual';
+  }
+
+  export namespace VectorStoreChunkingStrategyContextual {
+    /**
+     * Configuration for contextual chunking.
+     */
+    export interface Contextual {
+      /**
+       * Tokens to overlap between adjacent chunks. Must be less than
+       * max_chunk_size_tokens.
+       */
+      chunk_overlap_tokens?: number;
+
+      /**
+       * Prompt template for contextual retrieval. Uses WHOLE_DOCUMENT and CHUNK_CONTENT
+       * placeholders wrapped in double curly braces.
+       */
+      context_prompt?: string;
+
+      /**
+       * Maximum tokens per chunk. Suggested ~700 to allow room for prepended context.
+       */
+      max_chunk_size_tokens?: number;
+
+      /**
+       * Maximum concurrent LLM calls. Falls back to config default if not provided.
+       */
+      max_concurrency?: number | null;
+
+      /**
+       * LLM model for generating context. Falls back to
+       * VectorStoresConfig.contextual_retrieval_params.model if not provided.
+       */
+      model_id?: string | null;
+
+      /**
+       * Timeout per LLM call in seconds. Falls back to config default if not provided.
+       */
+      timeout_seconds?: number | null;
+    }
+  }
+
+  /**
+   * A file entry for creating a vector store file batch with per-file options.
+   */
+  export interface File {
+    file_id: string;
+
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful
+     * for storing additional information about the object in a structured format, and
+     * querying for objects via API or the dashboard. Keys are strings with a maximum
+     * length of 64 characters. Values are strings with a maximum length of 512
+     * characters, booleans, or numbers.
+     */
+    attributes?: { [key: string]: string | number | boolean } | null;
+
+    /**
+     * Automatic chunking strategy for vector store files.
+     */
+    chunking_strategy?:
+      | File.VectorStoreChunkingStrategyAuto
+      | File.VectorStoreChunkingStrategyStatic
+      | File.VectorStoreChunkingStrategyContextual
+      | null;
+  }
+
+  export namespace File {
+    /**
+     * Automatic chunking strategy for vector store files.
+     */
+    export interface VectorStoreChunkingStrategyAuto {
+      type?: 'auto';
+    }
+
+    /**
+     * Static chunking strategy with configurable parameters.
+     */
+    export interface VectorStoreChunkingStrategyStatic {
+      /**
+       * Configuration for static chunking strategy.
+       */
+      static: VectorStoreChunkingStrategyStatic.Static;
+
+      type?: 'static';
+    }
+
+    export namespace VectorStoreChunkingStrategyStatic {
+      /**
+       * Configuration for static chunking strategy.
+       */
+      export interface Static {
+        chunk_overlap_tokens?: number;
+
+        max_chunk_size_tokens?: number;
+      }
+    }
+
+    /**
+     * Contextual chunking strategy that uses an LLM to situate chunks within the
+     * document.
+     */
+    export interface VectorStoreChunkingStrategyContextual {
+      /**
+       * Configuration for contextual chunking.
+       */
+      contextual: VectorStoreChunkingStrategyContextual.Contextual;
+
+      /**
+       * Strategy type identifier.
+       */
+      type?: 'contextual';
+    }
+
+    export namespace VectorStoreChunkingStrategyContextual {
+      /**
+       * Configuration for contextual chunking.
+       */
+      export interface Contextual {
+        /**
+         * Tokens to overlap between adjacent chunks. Must be less than
+         * max_chunk_size_tokens.
+         */
+        chunk_overlap_tokens?: number;
+
+        /**
+         * Prompt template for contextual retrieval. Uses WHOLE_DOCUMENT and CHUNK_CONTENT
+         * placeholders wrapped in double curly braces.
+         */
+        context_prompt?: string;
+
+        /**
+         * Maximum tokens per chunk. Suggested ~700 to allow room for prepended context.
+         */
+        max_chunk_size_tokens?: number;
+
+        /**
+         * Maximum concurrent LLM calls. Falls back to config default if not provided.
+         */
+        max_concurrency?: number | null;
+
+        /**
+         * LLM model for generating context. Falls back to
+         * VectorStoresConfig.contextual_retrieval_params.model if not provided.
+         */
+        model_id?: string | null;
+
+        /**
+         * Timeout per LLM call in seconds. Falls back to config default if not provided.
+         */
+        timeout_seconds?: number | null;
+      }
+    }
+  }
+}
+
+export interface FileBatchListFilesParams extends OpenAICursorPageParams {
+  /**
+   * Pagination cursor (before).
+   */
+  before?: string | null;
+
+  /**
+   * Filter by file status.
+   */
+  filter?: string | null;
+
+  /**
+   * Sort order by created_at: asc or desc.
+   */
+  order?: string | null;
+}
+
+export declare namespace FileBatches {
+  export {
+    type ListVectorStoreFilesInBatchResponse as ListVectorStoreFilesInBatchResponse,
+    type VectorStoreFileBatches as VectorStoreFileBatches,
+    type FileBatchCreateParams as FileBatchCreateParams,
+    type FileBatchListFilesParams as FileBatchListFilesParams,
+  };
+}
+
+export { VectorStoreFilesOpenAICursorPage };