llama-stack-client 0.2.16 → 0.2.17

package/resources/tools.d.ts

@@ -11,30 +11,75 @@ export declare class Tools extends APIResource {
      */
     get(toolName: string, options?: Core.RequestOptions): Core.APIPromise<Tool>;
 }
+/**
+ * Response containing a list of tools.
+ */
 export interface ListToolsResponse {
+    /**
+     * List of tools
+     */
     data: ToolListResponse;
 }
+/**
+ * A tool that can be invoked by agents.
+ */
 export interface Tool {
+    /**
+     * Human-readable description of what the tool does
+     */
     description: string;
     identifier: string;
+    /**
+     * List of parameters this tool accepts
+     */
     parameters: Array<Tool.Parameter>;
     provider_id: string;
+    /**
+     * ID of the tool group this tool belongs to
+     */
     toolgroup_id: string;
+    /**
+     * Type of resource, always 'tool'
+     */
     type: 'tool';
+    /**
+     * (Optional) Additional metadata about the tool
+     */
     metadata?: {
         [key: string]: boolean | number | string | Array<unknown> | unknown | null;
     };
     provider_resource_id?: string;
 }
 export declare namespace Tool {
+    /**
+     * Parameter definition for a tool.
+     */
     interface Parameter {
+        /**
+         * Human-readable description of what the parameter does
+         */
         description: string;
+        /**
+         * Name of the parameter
+         */
         name: string;
+        /**
+         * Type of the parameter (e.g., string, integer)
+         */
         parameter_type: string;
+        /**
+         * Whether this parameter is required for tool invocation
+         */
         required: boolean;
+        /**
+         * (Optional) Default value for the parameter if not provided
+         */
         default?: boolean | number | string | Array<unknown> | unknown | null;
     }
 }
+/**
+ * List of tools
+ */
 export type ToolListResponse = Array<Tool>;
 export interface ToolListParams {
     /**

package/resources/tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../src/resources/tools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAC9F,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAatE;;OAEG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAG5E;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,IAAI;IACnB,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAElC,WAAW,EAAE,MAAM,CAAC;IAEpB,YAAY,EAAE,MAAM,CAAC;IAErB,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE1F,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,yBAAiB,IAAI,CAAC;IACpB,UAAiB,SAAS;QACxB,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,MAAM,CAAC;QAEb,cAAc,EAAE,MAAM,CAAC;QAEvB,QAAQ,EAAE,OAAO,CAAC;QAElB,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;KACvE;CACF;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;AAE3C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../src/resources/tools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAC9F,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAatE;;OAEG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAG5E;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAElC,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE1F,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;KACvE;CACF;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;AAE3C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/vector-dbs.d.ts

@@ -18,35 +18,80 @@ export declare class VectorDBs extends APIResource {
      */
     unregister(vectorDBId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
 }
+/**
+ * Response from listing vector databases.
+ */
 export interface ListVectorDBsResponse {
+    /**
+     * List of vector databases
+     */
     data: VectorDBListResponse;
 }
+/**
+ * Vector database resource for storing and querying vector embeddings.
+ */
 export interface VectorDBRetrieveResponse {
+    /**
+     * Dimension of the embedding vectors
+     */
     embedding_dimension: number;
+    /**
+     * Name of the embedding model to use for vector generation
+     */
     embedding_model: string;
     identifier: string;
     provider_id: string;
+    /**
+     * Type of resource, always 'vector_db' for vector databases
+     */
     type: 'vector_db';
     provider_resource_id?: string;
     vector_db_name?: string;
 }
+/**
+ * List of vector databases
+ */
 export type VectorDBListResponse = Array<VectorDBListResponse.VectorDBListResponseItem>;
 export declare namespace VectorDBListResponse {
+    /**
+     * Vector database resource for storing and querying vector embeddings.
+     */
     interface VectorDBListResponseItem {
+        /**
+         * Dimension of the embedding vectors
+         */
         embedding_dimension: number;
+        /**
+         * Name of the embedding model to use for vector generation
+         */
         embedding_model: string;
         identifier: string;
         provider_id: string;
+        /**
+         * Type of resource, always 'vector_db' for vector databases
+         */
         type: 'vector_db';
         provider_resource_id?: string;
         vector_db_name?: string;
     }
 }
+/**
+ * Vector database resource for storing and querying vector embeddings.
+ */
 export interface VectorDBRegisterResponse {
+    /**
+     * Dimension of the embedding vectors
+     */
     embedding_dimension: number;
+    /**
+     * Name of the embedding model to use for vector generation
+     */
     embedding_model: string;
     identifier: string;
     provider_id: string;
+    /**
+     * Type of resource, always 'vector_db' for vector databases
+     */
     type: 'vector_db';
     provider_resource_id?: string;
     vector_db_name?: string;

package/resources/vector-dbs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vector-dbs.d.ts","sourceRoot":"","sources":["../src/resources/vector-dbs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAItG;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAM1E;;OAEG;IACH,QAAQ,CACN,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;OAEG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAMrF;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,WAAW,CAAC;IAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAExF,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,wBAAwB;QACvC,mBAAmB,EAAE,MAAM,CAAC;QAE5B,eAAe,EAAE,MAAM,CAAC;QAExB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,WAAW,CAAC;QAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC,mBAAmB,EAAE,MAAM,CAAC;IAE5B,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,WAAW,CAAC;IAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
+{"version":3,"file":"vector-dbs.d.ts","sourceRoot":"","sources":["../src/resources/vector-dbs.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAItG;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAM1E;;OAEG;IACH,QAAQ,CACN,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;OAEG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAMrF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAExF,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,wBAAwB;QACvC;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB,UAAU,EAAE,MAAM,CAAC;QAEnB,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,IAAI,EAAE,WAAW,CAAC;QAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/vector-io.d.ts

@@ -11,8 +11,17 @@ export declare class VectorIo extends APIResource {
      */
     query(body: VectorIoQueryParams, options?: Core.RequestOptions): Core.APIPromise<QueryChunksResponse>;
 }
+/**
+ * Response from querying chunks in a vector database.
+ */
 export interface QueryChunksResponse {
+    /**
+     * List of content chunks returned from the query
+     */
     chunks: Array<QueryChunksResponse.Chunk>;
+    /**
+     * Relevance scores corresponding to each returned chunk
+     */
     scores: Array<number>;
 }
 export declare namespace QueryChunksResponse {

package/resources/vector-io.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vector-io.d.ts","sourceRoot":"","sources":["../src/resources/vector-io.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAQxF;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGtG;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAEzC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC;QAEnC;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;SAAE,CAAC;QAEzF;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAErC;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,KAAK,CAAC;QACrB;;;WAGG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;YAEnC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAE/B;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;SAC5B;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC;QAEnC;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;SAAE,CAAC;QAEzF;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAErC;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,KAAK,CAAC;QACrB;;;WAGG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;YAEnC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAE/B;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;SAC5B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,kBAAkB,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;CACzF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"vector-io.d.ts","sourceRoot":"","sources":["../src/resources/vector-io.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAQxF;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGtG;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAEzC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC;QAEnC;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;SAAE,CAAC;QAEzF;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAErC;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,KAAK,CAAC;QACrB;;;WAGG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;YAEnC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAE/B;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;SAC5B;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE1C;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,kBAAkB,CAAC;QAEnC;;;WAGG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;SAAE,CAAC;QAEzF;;;WAGG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAErC;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE1B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,KAAK,CAAC;QACrB;;;WAGG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;YAEnC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;YAE/B;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;SAC5B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,kBAAkB,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;CACzF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

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

@@ -31,69 +31,174 @@ export declare class Files extends APIResource {
  * 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
+     */
     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;
+    /**
+     * ID of the vector store containing this file
+     */
     vector_store_id: string;
+    /**
+     * (Optional) Error information if file processing failed
+     */
     last_error?: VectorStoreFile.LastError;
 }
 export declare namespace VectorStoreFile {
+    /**
+     * Automatic chunking strategy for vector store files.
+     */
     interface VectorStoreChunkingStrategyAuto {
+        /**
+         * Strategy type, always "auto" for automatic chunking
+         */
         type: 'auto';
     }
+    /**
+     * Static chunking strategy with configurable parameters.
+     */
     interface VectorStoreChunkingStrategyStatic {
+        /**
+         * Configuration parameters for the static chunking strategy
+         */
         static: VectorStoreChunkingStrategyStatic.Static;
+        /**
+         * Strategy type, always "static" for static chunking
+         */
         type: 'static';
     }
     namespace VectorStoreChunkingStrategyStatic {
+        /**
+         * Configuration parameters for the static chunking strategy
+         */
         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;
         }
     }
+    /**
+     * (Optional) Error information if file processing failed
+     */
     interface LastError {
+        /**
+         * Error code indicating the type of failure
+         */
         code: 'server_error' | 'rate_limit_exceeded';
+        /**
+         * Human-readable error message describing the failure
+         */
         message: string;
     }
 }
 /**
- * Response from listing vector stores.
+ * Response from listing files in a vector store.
  */
 export interface FileListResponse {
+    /**
+     * List of vector store file objects
+     */
     data: Array<VectorStoreFile>;
+    /**
+     * Whether there are more files available beyond this page
+     */
     has_more: boolean;
+    /**
+     * Object type identifier, always "list"
+     */
     object: string;
+    /**
+     * (Optional) ID of the first file in the list for pagination
+     */
     first_id?: string;
+    /**
+     * (Optional) ID of the last file in the list for pagination
+     */
     last_id?: string;
 }
 /**
  * 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;
+    /**
+     * Object type identifier for the deletion response
+     */
     object: string;
 }
 /**
  * Response from retrieving the contents 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;
     };
+    /**
+     * List of content items from the file
+     */
     content: Array<FileContentResponse.Content>;
+    /**
+     * Unique identifier for the file
+     */
     file_id: string;
+    /**
+     * Name of the file
+     */
     filename: string;
 }
 export declare namespace FileContentResponse {
+    /**
+     * Content item from a vector store file or search result.
+     */
     interface Content {
+        /**
+         * The actual text content
+         */
         text: string;
+        /**
+         * Content type, currently only "text" is supported
+         */
         type: 'text';
     }
 }
@@ -114,16 +219,40 @@ export interface FileCreateParams {
     chunking_strategy?: FileCreateParams.VectorStoreChunkingStrategyAuto | FileCreateParams.VectorStoreChunkingStrategyStatic;
 }
 export declare namespace FileCreateParams {
+    /**
+     * Automatic chunking strategy for vector store files.
+     */
     interface VectorStoreChunkingStrategyAuto {
+        /**
+         * Strategy type, always "auto" for automatic chunking
+         */
         type: 'auto';
     }
+    /**
+     * Static chunking strategy with configurable parameters.
+     */
     interface VectorStoreChunkingStrategyStatic {
+        /**
+         * Configuration parameters for the static chunking strategy
+         */
         static: VectorStoreChunkingStrategyStatic.Static;
+        /**
+         * Strategy type, always "static" for static chunking
+         */
         type: 'static';
     }
     namespace VectorStoreChunkingStrategyStatic {
+        /**
+         * Configuration parameters for the static chunking strategy
+         */
         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;
         }
     }
@@ -137,10 +266,29 @@ export interface FileUpdateParams {
     };
 }
 export interface FileListParams {
+    /**
+     * (Optional) A cursor for use in pagination. `after` is an object ID that defines
+     * your place in the list.
+     */
     after?: string;
+    /**
+     * (Optional) A cursor for use in pagination. `before` is an object ID that defines
+     * your place in the list.
+     */
     before?: string;
+    /**
+     * (Optional) Filter by file status to only return files with the specified status.
+     */
     filter?: 'completed' | 'in_progress' | 'cancelled' | 'failed';
+    /**
+     * (Optional) A limit on the number of objects to be returned. Limit can range
+     * between 1 and 100, and the default is 20.
+     */
     limit?: number;
+    /**
+     * (Optional) Sort order by the `created_at` timestamp of the objects. `asc` for
+     * ascending order and `desc` for descending order.
+     */
     order?: string;
 }
 export declare namespace Files {

package/resources/vector-stores/files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/resources/vector-stores/files.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAInC;;OAEG;IACH,QAAQ,CACN,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAInC;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAOnC;;OAEG;IACH,IAAI,CACF,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IACpC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAY7F;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAItC;;OAEG;IACH,OAAO,CACL,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE3F,iBAAiB,EACb,eAAe,CAAC,+BAA+B,GAC/C,eAAe,CAAC,iCAAiC,CAAC;IAEtD,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE7D,WAAW,EAAE,MAAM,CAAC;IAEpB,eAAe,EAAE,MAAM,CAAC;IAExB,UAAU,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC;CACxC;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,+BAA+B;QAC9C,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,iCAAiC;QAChD,MAAM,EAAE,iCAAiC,CAAC,MAAM,CAAC;QAEjD,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,iCAAiC,CAAC;QACjD,UAAiB,MAAM;YACrB,oBAAoB,EAAE,MAAM,CAAC;YAE7B,qBAAqB,EAAE,MAAM,CAAC;SAC/B;KACF;IAED,UAAiB,SAAS;QACxB,IAAI,EAAE,cAAc,GAAG,qBAAqB,CAAC;QAE7C,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B,QAAQ,EAAE,OAAO,CAAC;IAElB,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,OAAO,CAAC;IAEjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE3F,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE5C,OAAO,EAAE,MAAM,CAAC;IAEhB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,OAAO;QACtB,IAAI,EAAE,MAAM,CAAC;QAEb,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE5F;;OAEG;IACH,iBAAiB,CAAC,EACd,gBAAgB,CAAC,+BAA+B,GAChD,gBAAgB,CAAC,iCAAiC,CAAC;CACxD;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,+BAA+B;QAC9C,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,iCAAiC;QAChD,MAAM,EAAE,iCAAiC,CAAC,MAAM,CAAC;QAEjD,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,iCAAiC,CAAC;QACjD,UAAiB,MAAM;YACrB,oBAAoB,EAAE,MAAM,CAAC;YAE7B,qBAAqB,EAAE,MAAM,CAAC;SAC/B;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;CAC5F;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE9D,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/resources/vector-stores/files.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAInC;;OAEG;IACH,QAAQ,CACN,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAInC;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAOnC;;OAEG;IACH,IAAI,CACF,aAAa,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IACpC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;IAY7F;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAItC;;OAEG;IACH,OAAO,CACL,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE3F;;OAEG;IACH,iBAAiB,EACb,eAAe,CAAC,+BAA+B,GAC/C,eAAe,CAAC,iCAAiC,CAAC;IAEtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE7D;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC;CACxC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,+BAA+B;QAC9C;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;WAEG;QACH,MAAM,EAAE,iCAAiC,CAAC,MAAM,CAAC;QAEjD;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,iCAAiC,CAAC;QACjD;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,oBAAoB,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,qBAAqB,EAAE,MAAM,CAAC;SAC/B;KACF;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,EAAE,cAAc,GAAG,qBAAqB,CAAC;QAE7C;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE3F;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;IAE5F;;OAEG;IACH,iBAAiB,CAAC,EACd,gBAAgB,CAAC,+BAA+B,GAChD,gBAAgB,CAAC,iCAAiC,CAAC;CACxD;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,+BAA+B;QAC9C;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;WAEG;QACH,MAAM,EAAE,iCAAiC,CAAC,MAAM,CAAC;QAEjD;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,iCAAiC,CAAC;QACjD;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,oBAAoB,EAAE,MAAM,CAAC;YAE7B;;eAEG;YACH,qBAAqB,EAAE,MAAM,CAAC;SAC/B;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA;KAAE,CAAC;CAC5F;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE9D;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/vector-stores/vector-stores.d.ts

@@ -35,38 +35,104 @@ export declare class VectorStores extends APIResource {
  * Response from listing vector stores.
  */
 export interface ListVectorStoresResponse {
+    /**
+     * List of vector store objects
+     */
     data: Array<VectorStore>;
+    /**
+     * Whether there are more vector stores available beyond this page
+     */
     has_more: boolean;
+    /**
+     * Object type identifier, always "list"
+     */
     object: string;
+    /**
+     * (Optional) ID of the first vector store in the list for pagination
+     */
     first_id?: string;
+    /**
+     * (Optional) ID of the last vector store in the list for pagination
+     */
     last_id?: string;
 }
 /**
  * OpenAI Vector Store object.
  */
 export interface VectorStore {
+    /**
+     * Unique identifier for the vector store
+     */
     id: string;
+    /**
+     * Timestamp when the vector store was created
+     */
     created_at: number;
+    /**
+     * File processing status counts for the vector store
+     */
     file_counts: VectorStore.FileCounts;
+    /**
+     * Set of key-value pairs that can be attached to the vector store
+     */
     metadata: {
         [key: string]: boolean | number | string | Array<unknown> | unknown | null;
     };
+    /**
+     * Object type identifier, always "vector_store"
+     */
     object: string;
+    /**
+     * Current status of the vector store
+     */
     status: string;
+    /**
+     * Storage space used by the vector store in bytes
+     */
     usage_bytes: number;
+    /**
+     * (Optional) Expiration policy for the vector store
+     */
     expires_after?: {
         [key: string]: boolean | number | string | Array<unknown> | unknown | null;
     };
+    /**
+     * (Optional) Timestamp when the vector store will expire
+     */
     expires_at?: number;
+    /**
+     * (Optional) Timestamp of last activity on the vector store
+     */
     last_active_at?: number;
+    /**
+     * (Optional) Name of the vector store
+     */
     name?: string;
 }
 export declare namespace VectorStore {
+    /**
+     * File processing status counts for the vector store
+     */
     interface FileCounts {
+        /**
+         * Number of files that had their processing cancelled
+         */
         cancelled: number;
+        /**
+         * Number of files that have been successfully processed
+         */
         completed: number;
+        /**
+         * Number of files that failed to process
+         */
         failed: number;
+        /**
+         * Number of files currently being processed
+         */
         in_progress: number;
+        /**
+         * Total number of files in the vector store
+         */
         total: number;
     }
 }
@@ -74,18 +140,42 @@ export declare namespace VectorStore {
  * Response from deleting a vector store.
  */
 export interface VectorStoreDeleteResponse {
+    /**
+     * Unique identifier of the deleted vector store
+     */
     id: string;
+    /**
+     * Whether the deletion operation was successful
+     */
     deleted: boolean;
+    /**
+     * Object type identifier for the deletion response
+     */
     object: string;
 }
 /**
- * Response from searching a vector store.
+ * Paginated response from searching a vector store.
  */
 export interface VectorStoreSearchResponse {
+    /**
+     * List of search result objects
+     */
     data: Array<VectorStoreSearchResponse.Data>;
+    /**
+     * Whether there are more results available beyond this page
+     */
     has_more: boolean;
+    /**
+     * Object type identifier for the search results page
+     */
     object: string;
+    /**
+     * The original search query that was executed
+     */
     search_query: string;
+    /**
+     * (Optional) Token for retrieving the next page of results
+     */
     next_page?: string;
 }
 export declare namespace VectorStoreSearchResponse {
@@ -93,17 +183,41 @@ export declare namespace VectorStoreSearchResponse {
      * Response from searching a vector store.
      */
     interface Data {
+        /**
+         * List of content items matching the search query
+         */
         content: Array<Data.Content>;
+        /**
+         * Unique identifier of the file containing the result
+         */
         file_id: string;
+        /**
+         * Name of the file containing the result
+         */
         filename: string;
+        /**
+         * Relevance score for this search result
+         */
         score: number;
+        /**
+         * (Optional) Key-value attributes associated with the file
+         */
         attributes?: {
             [key: string]: string | number | boolean;
         };
     }
     namespace Data {
+        /**
+         * Content item from a vector store file or search result.
+         */
         interface Content {
+            /**
+             * The actual text content
+             */
             text: string;
+            /**
+             * Content type, currently only "text" is supported
+             */
             type: 'text';
         }
     }
@@ -223,7 +337,13 @@ export declare namespace VectorStoreSearchParams {
      * Ranking options for fine-tuning the search results.
      */
     interface RankingOptions {
+        /**
+         * (Optional) Name of the ranking algorithm to use
+         */
         ranker?: string;
+        /**
+         * (Optional) Minimum relevance score threshold for results
+         */
         score_threshold?: number;
     }
 }