llama-stack-client 0.3.5 → 0.4.0-rc2

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

@@ -0,0 +1,201 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+// 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.
+   *
+   * Generate an OpenAI-compatible vector store file batch for the given vector
+   * store.
+   */
+  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.
+   */
+  retrieve(
+    vectorStoreId: string,
+    batchId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFileBatches> {
+    return this._client.get(`/v1/vector_stores/${vectorStoreId}/file_batches/${batchId}`, options);
+  }
+
+  /**
+   * Cancels a vector store file batch.
+   */
+  cancel(
+    vectorStoreId: string,
+    batchId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFileBatches> {
+    return this._client.post(`/v1/vector_stores/${vectorStoreId}/file_batches/${batchId}/cancel`, options);
+  }
+
+  /**
+   * Returns a list of vector store files in a batch.
+   */
+  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 | null;
+
+  has_more?: boolean;
+
+  last_id?: string | null;
+
+  object?: string;
+}
+
+/**
+ * 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: 'completed' | 'in_progress' | 'cancelled' | 'failed';
+
+  vector_store_id: string;
+
+  object?: string;
+}
+
+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 {
+  file_ids: Array<string>;
+
+  attributes?: { [key: string]: unknown } | null;
+
+  /**
+   * Automatic chunking strategy for vector store files.
+   */
+  chunking_strategy?:
+    | FileBatchCreateParams.VectorStoreChunkingStrategyAuto
+    | FileBatchCreateParams.VectorStoreChunkingStrategyStatic
+    | 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;
+    }
+  }
+}
+
+export interface FileBatchListFilesParams extends OpenAICursorPageParams {
+  before?: string | null;
+
+  filter?: string | null;
+
+  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 };

package/src/resources/vector-stores/files.ts

@@ -3,7 +3,7 @@
 //
 // 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';
@@ -20,7 +20,7 @@ export class Files extends APIResource {
     body: FileCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<VectorStoreFile> {
-    return this._client.post(`/v1/openai/v1/vector_stores/${vectorStoreId}/files`, { body, ...options });
+    return this._client.post(`/v1/vector_stores/${vectorStoreId}/files`, { body, ...options });
   }
 
   /**
@@ -31,7 +31,7 @@ export class Files extends APIResource {
     fileId: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<VectorStoreFile> {
-    return this._client.get(`/v1/openai/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
+    return this._client.get(`/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
   }
 
   /**
@@ -43,10 +43,7 @@ export class Files extends APIResource {
     body: FileUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<VectorStoreFile> {
-    return this._client.post(`/v1/openai/v1/vector_stores/${vectorStoreId}/files/${fileId}`, {
-      body,
-      ...options,
-    });
+    return this._client.post(`/v1/vector_stores/${vectorStoreId}/files/${fileId}`, { body, ...options });
   }
 
   /**
@@ -70,7 +67,7 @@ export class Files extends APIResource {
       return this.list(vectorStoreId, {}, query);
     }
     return this._client.getAPIList(
-      `/v1/openai/v1/vector_stores/${vectorStoreId}/files`,
+      `/v1/vector_stores/${vectorStoreId}/files`,
       VectorStoreFilesOpenAICursorPage,
       { query, ...options },
     );
@@ -84,7 +81,7 @@ export class Files extends APIResource {
     fileId: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<FileDeleteResponse> {
-    return this._client.delete(`/v1/openai/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
+    return this._client.delete(`/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
   }
 
   /**
@@ -93,9 +90,27 @@ export class Files extends APIResource {
   content(
     vectorStoreId: string,
     fileId: string,
+    query?: FileContentParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<FileContentResponse>;
+  content(
+    vectorStoreId: string,
+    fileId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<FileContentResponse>;
+  content(
+    vectorStoreId: string,
+    fileId: string,
+    query: FileContentParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<FileContentResponse> {
-    return this._client.get(`/v1/openai/v1/vector_stores/${vectorStoreId}/files/${fileId}/content`, options);
+    if (isRequestOptions(query)) {
+      return this.content(vectorStoreId, fileId, {}, query);
+    }
+    return this._client.get(`/v1/vector_stores/${vectorStoreId}/files/${fileId}/content`, {
+      query,
+      ...options,
+    });
   }
 }
 
@@ -105,52 +120,38 @@ export class VectorStoreFilesOpenAICursorPage extends OpenAICursorPage<VectorSto
  * OpenAI Vector Store File object.
  */
 export interface VectorStoreFile {
-  /**
-   * Unique identifier for the file
-   */
   id: string;
 
   /**
-   * Key-value attributes associated with the file
-   */
-  attributes: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
-
-  /**
-   * Strategy used for splitting the file into chunks
+   * Automatic chunking strategy for vector store files.
    */
   chunking_strategy:
     | VectorStoreFile.VectorStoreChunkingStrategyAuto
     | VectorStoreFile.VectorStoreChunkingStrategyStatic;
 
-  /**
-   * Timestamp when the file was added to the vector store
-   */
   created_at: number;
 
-  /**
-   * Object type identifier, always "vector_store.file"
-   */
-  object: string;
-
-  /**
-   * Current processing status of the file
-   */
   status: 'completed' | 'in_progress' | 'cancelled' | 'failed';
 
-  /**
-   * Storage space used by this file in bytes
-   */
-  usage_bytes: number;
+  vector_store_id: string;
 
   /**
-   * ID of the vector store containing this file
+   * 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.
    */
-  vector_store_id: string;
+  attributes?: { [key: string]: string | number | boolean };
 
   /**
-   * (Optional) Error information if file processing failed
+   * Error information for failed vector store file processing.
    */
-  last_error?: VectorStoreFile.LastError;
+  last_error?: VectorStoreFile.LastError | null;
+
+  object?: string;
+
+  usage_bytes?: number;
 }
 
 export namespace VectorStoreFile {
@@ -158,10 +159,7 @@ export namespace VectorStoreFile {
    * Automatic chunking strategy for vector store files.
    */
   export interface VectorStoreChunkingStrategyAuto {
-    /**
-     * Strategy type, always "auto" for automatic chunking
-     */
-    type: 'auto';
+    type?: 'auto';
   }
 
   /**
@@ -169,45 +167,30 @@ export namespace VectorStoreFile {
    */
   export interface VectorStoreChunkingStrategyStatic {
     /**
-     * Configuration parameters for the static chunking strategy
+     * Configuration for static chunking strategy.
      */
     static: VectorStoreChunkingStrategyStatic.Static;
 
-    /**
-     * Strategy type, always "static" for static chunking
-     */
-    type: 'static';
+    type?: 'static';
   }
 
   export namespace VectorStoreChunkingStrategyStatic {
     /**
-     * Configuration parameters for the static chunking strategy
+     * Configuration for static chunking strategy.
      */
     export interface Static {
-      /**
-       * Number of tokens to overlap between adjacent chunks
-       */
-      chunk_overlap_tokens: number;
-
-      /**
-       * Maximum number of tokens per chunk, must be between 100 and 4096
-       */
-      max_chunk_size_tokens: number;
+      chunk_overlap_tokens?: number;
+
+      max_chunk_size_tokens?: number;
     }
   }
 
   /**
-   * (Optional) Error information if file processing failed
+   * Error information for failed vector store file processing.
    */
   export interface LastError {
-    /**
-     * Error code indicating the type of failure
-     */
     code: 'server_error' | 'rate_limit_exceeded';
 
-    /**
-     * Human-readable error message describing the failure
-     */
     message: string;
   }
 }
@@ -216,81 +199,97 @@ export namespace VectorStoreFile {
  * Response from deleting a vector store file.
  */
 export interface FileDeleteResponse {
-  /**
-   * Unique identifier of the deleted file
-   */
   id: string;
 
-  /**
-   * Whether the deletion operation was successful
-   */
-  deleted: boolean;
+  deleted?: boolean;
 
-  /**
-   * Object type identifier for the deletion response
-   */
-  object: string;
+  object?: string;
 }
 
 /**
- * Response from retrieving the contents of a vector store file.
+ * Represents the parsed content of a vector store file.
  */
 export interface FileContentResponse {
-  /**
-   * Key-value attributes associated with the file
-   */
-  attributes: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+  data: Array<FileContentResponse.Data>;
 
-  /**
-   * List of content items from the file
-   */
-  content: Array<FileContentResponse.Content>;
+  has_more?: boolean;
 
-  /**
-   * Unique identifier for the file
-   */
-  file_id: string;
+  next_page?: string | null;
 
-  /**
-   * Name of the file
-   */
-  filename: string;
+  object?: 'vector_store.file_content.page';
 }
 
 export namespace FileContentResponse {
   /**
    * Content item from a vector store file or search result.
    */
-  export interface Content {
+  export interface Data {
+    text: string;
+
+    type: 'text';
+
     /**
-     * The actual text content
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
      */
-    text: string;
+    chunk_metadata?: Data.ChunkMetadata | null;
+
+    embedding?: Array<number> | null;
+
+    metadata?: { [key: string]: unknown } | null;
+  }
 
+  export namespace Data {
     /**
-     * Content type, currently only "text" is supported
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
      */
-    type: 'text';
+    export interface ChunkMetadata {
+      chunk_embedding_dimension?: number | null;
+
+      chunk_embedding_model?: string | null;
+
+      chunk_id?: string | null;
+
+      chunk_tokenizer?: string | null;
+
+      chunk_window?: string | null;
+
+      content_token_count?: number | null;
+
+      created_timestamp?: number | null;
+
+      document_id?: string | null;
+
+      metadata_token_count?: number | null;
+
+      source?: string | null;
+
+      updated_timestamp?: number | null;
+    }
   }
 }
 
 export interface FileCreateParams {
-  /**
-   * The ID of the file to attach to the vector store.
-   */
   file_id: string;
 
-  /**
-   * The key-value attributes stored with the file, which can be used for filtering.
-   */
-  attributes?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+  attributes?: { [key: string]: unknown } | null;
 
   /**
-   * The chunking strategy to use for the file.
+   * Automatic chunking strategy for vector store files.
    */
   chunking_strategy?:
     | FileCreateParams.VectorStoreChunkingStrategyAuto
-    | FileCreateParams.VectorStoreChunkingStrategyStatic;
+    | FileCreateParams.VectorStoreChunkingStrategyStatic
+    | null;
 }
 
 export namespace FileCreateParams {
@@ -298,10 +297,7 @@ export namespace FileCreateParams {
    * Automatic chunking strategy for vector store files.
    */
   export interface VectorStoreChunkingStrategyAuto {
-    /**
-     * Strategy type, always "auto" for automatic chunking
-     */
-    type: 'auto';
+    type?: 'auto';
   }
 
   /**
@@ -309,58 +305,41 @@ export namespace FileCreateParams {
    */
   export interface VectorStoreChunkingStrategyStatic {
     /**
-     * Configuration parameters for the static chunking strategy
+     * Configuration for static chunking strategy.
      */
     static: VectorStoreChunkingStrategyStatic.Static;
 
-    /**
-     * Strategy type, always "static" for static chunking
-     */
-    type: 'static';
+    type?: 'static';
   }
 
   export namespace VectorStoreChunkingStrategyStatic {
     /**
-     * Configuration parameters for the static chunking strategy
+     * Configuration for static chunking strategy.
      */
     export interface Static {
-      /**
-       * Number of tokens to overlap between adjacent chunks
-       */
-      chunk_overlap_tokens: number;
-
-      /**
-       * Maximum number of tokens per chunk, must be between 100 and 4096
-       */
-      max_chunk_size_tokens: number;
+      chunk_overlap_tokens?: number;
+
+      max_chunk_size_tokens?: number;
     }
   }
 }
 
 export interface FileUpdateParams {
-  /**
-   * The updated key-value attributes to store with the file.
-   */
-  attributes: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+  attributes: { [key: string]: unknown };
 }
 
 export interface FileListParams extends OpenAICursorPageParams {
-  /**
-   * (Optional) A cursor for use in pagination. `before` is an object ID that defines
-   * your place in the list.
-   */
-  before?: string;
+  before?: string | null;
 
-  /**
-   * (Optional) Filter by file status to only return files with the specified status.
-   */
-  filter?: 'completed' | 'in_progress' | 'cancelled' | 'failed';
+  filter?: 'completed' | 'in_progress' | 'cancelled' | 'failed' | null;
 
-  /**
-   * (Optional) Sort order by the `created_at` timestamp of the objects. `asc` for
-   * ascending order and `desc` for descending order.
-   */
-  order?: string;
+  order?: string | null;
+}
+
+export interface FileContentParams {
+  include_embeddings?: boolean | null;
+
+  include_metadata?: boolean | null;
 }
 
 Files.VectorStoreFilesOpenAICursorPage = VectorStoreFilesOpenAICursorPage;
@@ -374,5 +353,6 @@ export declare namespace Files {
     type FileCreateParams as FileCreateParams,
     type FileUpdateParams as FileUpdateParams,
     type FileListParams as FileListParams,
+    type FileContentParams as FileContentParams,
   };
 }

package/src/resources/vector-stores/index.ts

@@ -3,9 +3,16 @@
 //
 // 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.
 
+export {
+  FileBatches,
+  type ListVectorStoreFilesInBatchResponse,
+  type VectorStoreFileBatches,
+  type FileBatchCreateParams,
+  type FileBatchListFilesParams,
+} from './file-batches';
 export {
   VectorStoreFilesOpenAICursorPage,
   Files,
@@ -15,6 +22,7 @@ export {
   type FileCreateParams,
   type FileUpdateParams,
   type FileListParams,
+  type FileContentParams,
 } from './files';
 export {
   VectorStoresOpenAICursorPage,