V1 with working cmdline interface for easy of using GIT

2025-08-08 16:27:43 +05:30
commit 71a398820a
2845 changed files with 396687 additions and 0 deletions
@@ -0,0 +1,379 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { sleep, Uploadable, isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as VectorStoresAPI from './vector-stores';
+import { CursorPage, type CursorPageParams, Page } from '../../pagination';
+
+export class Files extends APIResource {
+  /**
+   * Create a vector store file by attaching a
+   * [File](https://platform.openai.com/docs/api-reference/files) to a
+   * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object).
+   */
+  create(
+    vectorStoreId: string,
+    body: FileCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFile> {
+    return this._client.post(`/vector_stores/${vectorStoreId}/files`, {
+      body,
+      ...options,
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
+    });
+  }
+
+  /**
+   * Retrieves a vector store file.
+   */
+  retrieve(
+    vectorStoreId: string,
+    fileId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFile> {
+    return this._client.get(`/vector_stores/${vectorStoreId}/files/${fileId}`, {
+      ...options,
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
+    });
+  }
+
+  /**
+   * Update attributes on a vector store file.
+   */
+  update(
+    vectorStoreId: string,
+    fileId: string,
+    body: FileUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFile> {
+    return this._client.post(`/vector_stores/${vectorStoreId}/files/${fileId}`, {
+      body,
+      ...options,
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
+    });
+  }
+
+  /**
+   * Returns a list of vector store files.
+   */
+  list(
+    vectorStoreId: string,
+    query?: FileListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VectorStoreFilesPage, VectorStoreFile>;
+  list(
+    vectorStoreId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VectorStoreFilesPage, VectorStoreFile>;
+  list(
+    vectorStoreId: string,
+    query: FileListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VectorStoreFilesPage, VectorStoreFile> {
+    if (isRequestOptions(query)) {
+      return this.list(vectorStoreId, {}, query);
+    }
+    return this._client.getAPIList(`/vector_stores/${vectorStoreId}/files`, VectorStoreFilesPage, {
+      query,
+      ...options,
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
+    });
+  }
+
+  /**
+   * Delete a vector store file. This will remove the file from the vector store but
+   * the file itself will not be deleted. To delete the file, use the
+   * [delete file](https://platform.openai.com/docs/api-reference/files/delete)
+   * endpoint.
+   */
+  del(
+    vectorStoreId: string,
+    fileId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFileDeleted> {
+    return this._client.delete(`/vector_stores/${vectorStoreId}/files/${fileId}`, {
+      ...options,
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
+    });
+  }
+
+  /**
+   * Attach a file to the given vector store and wait for it to be processed.
+   */
+  async createAndPoll(
+    vectorStoreId: string,
+    body: FileCreateParams,
+    options?: Core.RequestOptions & { pollIntervalMs?: number },
+  ): Promise<VectorStoreFile> {
+    const file = await this.create(vectorStoreId, body, options);
+    return await this.poll(vectorStoreId, file.id, options);
+  }
+
+  /**
+   * Wait for the vector store file to finish processing.
+   *
+   * Note: this will return even if the file failed to process, you need to check
+   * file.last_error and file.status to handle these cases
+   */
+  async poll(
+    vectorStoreId: string,
+    fileId: string,
+    options?: Core.RequestOptions & { pollIntervalMs?: number },
+  ): Promise<VectorStoreFile> {
+    const headers: { [key: string]: string } = { ...options?.headers, 'X-Stainless-Poll-Helper': 'true' };
+    if (options?.pollIntervalMs) {
+      headers['X-Stainless-Custom-Poll-Interval'] = options.pollIntervalMs.toString();
+    }
+    while (true) {
+      const fileResponse = await this.retrieve(vectorStoreId, fileId, {
+        ...options,
+        headers,
+      }).withResponse();
+
+      const file = fileResponse.data;
+
+      switch (file.status) {
+        case 'in_progress':
+          let sleepInterval = 5000;
+
+          if (options?.pollIntervalMs) {
+            sleepInterval = options.pollIntervalMs;
+          } else {
+            const headerInterval = fileResponse.response.headers.get('openai-poll-after-ms');
+            if (headerInterval) {
+              const headerIntervalMs = parseInt(headerInterval);
+              if (!isNaN(headerIntervalMs)) {
+                sleepInterval = headerIntervalMs;
+              }
+            }
+          }
+          await sleep(sleepInterval);
+          break;
+        case 'failed':
+        case 'completed':
+          return file;
+      }
+    }
+  }
+
+  /**
+   * Upload a file to the `files` API and then attach it to the given vector store.
+   *
+   * Note the file will be asynchronously processed (you can use the alternative
+   * polling helper method to wait for processing to complete).
+   */
+  async upload(
+    vectorStoreId: string,
+    file: Uploadable,
+    options?: Core.RequestOptions,
+  ): Promise<VectorStoreFile> {
+    const fileInfo = await this._client.files.create({ file: file, purpose: 'assistants' }, options);
+    return this.create(vectorStoreId, { file_id: fileInfo.id }, options);
+  }
+
+  /**
+   * Add a file to a vector store and poll until processing is complete.
+   */
+  async uploadAndPoll(
+    vectorStoreId: string,
+    file: Uploadable,
+    options?: Core.RequestOptions & { pollIntervalMs?: number },
+  ): Promise<VectorStoreFile> {
+    const fileInfo = await this.upload(vectorStoreId, file, options);
+    return await this.poll(vectorStoreId, fileInfo.id, options);
+  }
+
+  /**
+   * Retrieve the parsed contents of a vector store file.
+   */
+  content(
+    vectorStoreId: string,
+    fileId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FileContentResponsesPage, FileContentResponse> {
+    return this._client.getAPIList(
+      `/vector_stores/${vectorStoreId}/files/${fileId}/content`,
+      FileContentResponsesPage,
+      { ...options, headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers } },
+    );
+  }
+}
+
+export class VectorStoreFilesPage extends CursorPage<VectorStoreFile> {}
+
+/**
+ * Note: no pagination actually occurs yet, this is for forwards-compatibility.
+ */
+export class FileContentResponsesPage extends Page<FileContentResponse> {}
+
+/**
+ * A list of files attached to a vector store.
+ */
+export interface VectorStoreFile {
+  /**
+   * The identifier, which can be referenced in API endpoints.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when the vector store file was created.
+   */
+  created_at: number;
+
+  /**
+   * The last error associated with this vector store file. Will be `null` if there
+   * are no errors.
+   */
+  last_error: VectorStoreFile.LastError | null;
+
+  /**
+   * The object type, which is always `vector_store.file`.
+   */
+  object: 'vector_store.file';
+
+  /**
+   * The status of the vector store file, which can be either `in_progress`,
+   * `completed`, `cancelled`, or `failed`. The status `completed` indicates that the
+   * vector store file is ready for use.
+   */
+  status: 'in_progress' | 'completed' | 'cancelled' | 'failed';
+
+  /**
+   * The total vector store usage in bytes. Note that this may be different from the
+   * original file size.
+   */
+  usage_bytes: number;
+
+  /**
+   * The ID of the
+   * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+   * that the [File](https://platform.openai.com/docs/api-reference/files) is
+   * attached to.
+   */
+  vector_store_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?: Record<string, string | number | boolean> | null;
+
+  /**
+   * The strategy used to chunk the file.
+   */
+  chunking_strategy?: VectorStoresAPI.FileChunkingStrategy;
+}
+
+export namespace VectorStoreFile {
+  /**
+   * The last error associated with this vector store file. Will be `null` if there
+   * are no errors.
+   */
+  export interface LastError {
+    /**
+     * One of `server_error` or `rate_limit_exceeded`.
+     */
+    code: 'server_error' | 'unsupported_file' | 'invalid_file';
+
+    /**
+     * A human-readable description of the error.
+     */
+    message: string;
+  }
+}
+
+export interface VectorStoreFileDeleted {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'vector_store.file.deleted';
+}
+
+export interface FileContentResponse {
+  /**
+   * The text content
+   */
+  text?: string;
+
+  /**
+   * The content type (currently only `"text"`)
+   */
+  type?: string;
+}
+
+export interface FileCreateParams {
+  /**
+   * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
+   * vector store should use. Useful for tools like `file_search` that can access
+   * files.
+   */
+  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?: Record<string, string | number | boolean> | null;
+
+  /**
+   * 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.
+   */
+  chunking_strategy?: VectorStoresAPI.FileChunkingStrategyParam;
+}
+
+export interface FileUpdateParams {
+  /**
+   * 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: Record<string, string | number | boolean> | null;
+}
+
+export interface FileListParams extends CursorPageParams {
+  /**
+   * A cursor for use in pagination. `before` is an object ID that defines your place
+   * in the list. For instance, if you make a list request and receive 100 objects,
+   * starting with obj_foo, your subsequent call can include before=obj_foo in order
+   * to fetch the previous page of the list.
+   */
+  before?: string;
+
+  /**
+   * Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
+   */
+  filter?: 'in_progress' | 'completed' | 'failed' | 'cancelled';
+
+  /**
+   * Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+   * order and `desc` for descending order.
+   */
+  order?: 'asc' | 'desc';
+}
+
+Files.VectorStoreFilesPage = VectorStoreFilesPage;
+Files.FileContentResponsesPage = FileContentResponsesPage;
+
+export declare namespace Files {
+  export {
+    type VectorStoreFile as VectorStoreFile,
+    type VectorStoreFileDeleted as VectorStoreFileDeleted,
+    type FileContentResponse as FileContentResponse,
+    VectorStoreFilesPage as VectorStoreFilesPage,
+    FileContentResponsesPage as FileContentResponsesPage,
+    type FileCreateParams as FileCreateParams,
+    type FileUpdateParams as FileUpdateParams,
+    type FileListParams as FileListParams,
+  };
+}