@nocobase/plugin-ai 2.1.7 → 2.1.8

package/dist/node_modules/openai/src/resources/skills/skills.ts

@@ -27,41 +27,52 @@ export class Skills extends APIResource {
   versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
 
   /**
-   * Create Skill
+   * Create a new skill.
    */
   create(body: SkillCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Skill> {
-    return this._client.post('/skills', maybeMultipartFormRequestOptions({ body, ...options }, this._client));
+    return this._client.post(
+      '/skills',
+      maybeMultipartFormRequestOptions({ body, ...options, __security: { bearerAuth: true } }, this._client),
+    );
   }
 
   /**
-   * Get Skill
+   * Get a skill by its ID.
    */
   retrieve(skillID: string, options?: RequestOptions): APIPromise<Skill> {
-    return this._client.get(path`/skills/${skillID}`, options);
+    return this._client.get(path`/skills/${skillID}`, { ...options, __security: { bearerAuth: true } });
   }
 
   /**
-   * Update Skill Default Version
+   * Update the default version pointer for a skill.
    */
   update(skillID: string, body: SkillUpdateParams, options?: RequestOptions): APIPromise<Skill> {
-    return this._client.post(path`/skills/${skillID}`, { body, ...options });
+    return this._client.post(path`/skills/${skillID}`, {
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
-   * List Skills
+   * List all skills for the current project.
    */
   list(
     query: SkillListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<SkillsPage, Skill> {
-    return this._client.getAPIList('/skills', CursorPage<Skill>, { query, ...options });
+    return this._client.getAPIList('/skills', CursorPage<Skill>, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
-   * Delete Skill
+   * Delete a skill by its ID.
    */
   delete(skillID: string, options?: RequestOptions): APIPromise<DeletedSkill> {
-    return this._client.delete(path`/skills/${skillID}`, options);
+    return this._client.delete(path`/skills/${skillID}`, { ...options, __security: { bearerAuth: true } });
   }
 }
 

package/dist/node_modules/openai/src/resources/skills/versions/content.ts

@@ -8,13 +8,14 @@ import { path } from '../../../internal/utils/path';
 
 export class Content extends APIResource {
   /**
-   * Get Skill Version Content
+   * Download a skill version zip bundle.
    */
   retrieve(version: string, params: ContentRetrieveParams, options?: RequestOptions): APIPromise<Response> {
     const { skill_id } = params;
     return this._client.get(path`/skills/${skill_id}/versions/${version}/content`, {
       ...options,
       headers: buildHeaders([{ Accept: 'application/binary' }, options?.headers]),
+      __security: { bearerAuth: true },
       __binaryResponse: true,
     });
   }

package/dist/node_modules/openai/src/resources/skills/versions/versions.ts

@@ -14,7 +14,7 @@ export class Versions extends APIResource {
   content: ContentAPI.Content = new ContentAPI.Content(this._client);
 
   /**
-   * Create Skill Version
+   * Create a new immutable skill version.
    */
   create(
     skillID: string,
@@ -23,12 +23,12 @@ export class Versions extends APIResource {
   ): APIPromise<SkillVersion> {
     return this._client.post(
       path`/skills/${skillID}/versions`,
-      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
+      maybeMultipartFormRequestOptions({ body, ...options, __security: { bearerAuth: true } }, this._client),
     );
   }
 
   /**
-   * Get Skill Version
+   * Get a specific skill version.
    */
   retrieve(
     version: string,
@@ -36,11 +36,14 @@ export class Versions extends APIResource {
     options?: RequestOptions,
   ): APIPromise<SkillVersion> {
     const { skill_id } = params;
-    return this._client.get(path`/skills/${skill_id}/versions/${version}`, options);
+    return this._client.get(path`/skills/${skill_id}/versions/${version}`, {
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
-   * List Skill Versions
+   * List skill versions for a skill.
    */
   list(
     skillID: string,
@@ -50,11 +53,12 @@ export class Versions extends APIResource {
     return this._client.getAPIList(path`/skills/${skillID}/versions`, CursorPage<SkillVersion>, {
       query,
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 
   /**
-   * Delete Skill Version
+   * Delete a skill version.
    */
   delete(
     version: string,
@@ -62,7 +66,10 @@ export class Versions extends APIResource {
     options?: RequestOptions,
   ): APIPromise<DeletedSkillVersion> {
     const { skill_id } = params;
-    return this._client.delete(path`/skills/${skill_id}/versions/${version}`, options);
+    return this._client.delete(path`/skills/${skill_id}/versions/${version}`, {
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/dist/node_modules/openai/src/resources/uploads/parts.ts

@@ -7,6 +7,9 @@ import { RequestOptions } from '../../internal/request-options';
 import { multipartFormRequestOptions } from '../../internal/uploads';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Use Uploads to upload large files in multiple parts.
+ */
 export class Parts extends APIResource {
   /**
    * Adds a
@@ -24,7 +27,7 @@ export class Parts extends APIResource {
   create(uploadID: string, body: PartCreateParams, options?: RequestOptions): APIPromise<UploadPart> {
     return this._client.post(
       path`/uploads/${uploadID}/parts`,
-      multipartFormRequestOptions({ body, ...options }, this._client),
+      multipartFormRequestOptions({ body, ...options, __security: { bearerAuth: true } }, this._client),
     );
   }
 }

package/dist/node_modules/openai/src/resources/uploads/uploads.ts

@@ -8,6 +8,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Use Uploads to upload large files in multiple parts.
+ */
 export class Uploads extends APIResource {
   parts: PartsAPI.Parts = new PartsAPI.Parts(this._client);
 
@@ -31,16 +34,23 @@ export class Uploads extends APIResource {
    * For guidance on the proper filename extensions for each purpose, please follow
    * the documentation on
    * [creating a File](https://platform.openai.com/docs/api-reference/files/create).
+   *
+   * Returns the Upload object with status `pending`.
    */
   create(body: UploadCreateParams, options?: RequestOptions): APIPromise<Upload> {
-    return this._client.post('/uploads', { body, ...options });
+    return this._client.post('/uploads', { body, ...options, __security: { bearerAuth: true } });
   }
 
   /**
    * Cancels the Upload. No Parts may be added after an Upload is cancelled.
+   *
+   * Returns the Upload object with status `cancelled`.
    */
   cancel(uploadID: string, options?: RequestOptions): APIPromise<Upload> {
-    return this._client.post(path`/uploads/${uploadID}/cancel`, options);
+    return this._client.post(path`/uploads/${uploadID}/cancel`, {
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
@@ -56,10 +66,16 @@ export class Uploads extends APIResource {
    *
    * The number of bytes uploaded upon completion must match the number of bytes
    * initially specified when creating the Upload object. No Parts may be added after
-   * an Upload is completed.
+   * an Upload is completed. Returns the Upload object with status `completed`,
+   * including an additional `file` property containing the created usable File
+   * object.
    */
   complete(uploadID: string, body: UploadCompleteParams, options?: RequestOptions): APIPromise<Upload> {
-    return this._client.post(path`/uploads/${uploadID}/complete`, { body, ...options });
+    return this._client.post(path`/uploads/${uploadID}/complete`, {
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/dist/node_modules/openai/src/resources/vector-stores/file-batches.ts

@@ -26,6 +26,7 @@ export class FileBatches extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -41,6 +42,7 @@ export class FileBatches extends APIResource {
     return this._client.get(path`/vector_stores/${vector_store_id}/file_batches/${batchID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -57,6 +59,7 @@ export class FileBatches extends APIResource {
     return this._client.post(path`/vector_stores/${vector_store_id}/file_batches/${batchID}/cancel`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -84,7 +87,12 @@ export class FileBatches extends APIResource {
     return this._client.getAPIList(
       path`/vector_stores/${vector_store_id}/file_batches/${batchID}/files`,
       CursorPage<FilesAPI.VectorStoreFile>,
-      { query, ...options, headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]) },
+      {
+        query,
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        __security: { bearerAuth: true },
+      },
     );
   }
 
@@ -274,7 +282,9 @@ export interface FileBatchCreateParams {
    * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
    * the vector store should use. Useful for tools like `file_search` that can access
    * files. If `attributes` or `chunking_strategy` are provided, they will be applied
-   * to all files in the batch. Mutually exclusive with `files`.
+   * to all files in the batch. The maximum batch size is 2000 files. This endpoint
+   * is recommended for multi-file ingestion and helps reduce per-vector-store write
+   * request pressure. Mutually exclusive with `files`.
    */
   file_ids?: Array<string>;
 
@@ -282,7 +292,9 @@ export interface FileBatchCreateParams {
    * A list of objects that each include a `file_id` plus optional `attributes` or
    * `chunking_strategy`. Use this when you need to override metadata for specific
    * files. The global `attributes` or `chunking_strategy` will be ignored and must
-   * be specified for each file. Mutually exclusive with `file_ids`.
+   * be specified for each file. The maximum batch size is 2000 files. This endpoint
+   * is recommended for multi-file ingestion and helps reduce per-vector-store write
+   * request pressure. Mutually exclusive with `file_ids`.
    */
   files?: Array<FileBatchCreateParams.File>;
 }
@@ -292,7 +304,9 @@ export namespace FileBatchCreateParams {
     /**
      * 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.
+     * files. For multi-file ingestion, we recommend
+     * [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+     * to minimize per-vector-store write requests.
      */
     file_id: string;
 

package/dist/node_modules/openai/src/resources/vector-stores/files.ts

@@ -25,6 +25,7 @@ export class Files extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -40,6 +41,7 @@ export class Files extends APIResource {
     return this._client.get(path`/vector_stores/${vector_store_id}/files/${fileID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -52,6 +54,7 @@ export class Files extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -67,6 +70,7 @@ export class Files extends APIResource {
       query,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -85,6 +89,7 @@ export class Files extends APIResource {
     return this._client.delete(path`/vector_stores/${vector_store_id}/files/${fileID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -186,7 +191,11 @@ export class Files extends APIResource {
     return this._client.getAPIList(
       path`/vector_stores/${vector_store_id}/files/${fileID}/content`,
       Page<FileContentResponse>,
-      { ...options, headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]) },
+      {
+        ...options,
+        headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        __security: { bearerAuth: true },
+      },
     );
   }
 }
@@ -299,7 +308,9 @@ 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.
+   * files. For multi-file ingestion, we recommend
+   * [`file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+   * to minimize per-vector-store write requests.
    */
   file_id: string;
 

package/dist/node_modules/openai/src/resources/vector-stores/vector-stores.ts

@@ -44,6 +44,7 @@ export class VectorStores extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -54,6 +55,7 @@ export class VectorStores extends APIResource {
     return this._client.get(path`/vector_stores/${vectorStoreID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -69,6 +71,7 @@ export class VectorStores extends APIResource {
       body,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -83,6 +86,7 @@ export class VectorStores extends APIResource {
       query,
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -93,6 +97,7 @@ export class VectorStores extends APIResource {
     return this._client.delete(path`/vector_stores/${vectorStoreID}`, {
       ...options,
       headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      __security: { bearerAuth: true },
     });
   }
 
@@ -113,6 +118,7 @@ export class VectorStores extends APIResource {
         method: 'post',
         ...options,
         headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+        __security: { bearerAuth: true },
       },
     );
   }