@epilot/sdk 2.7.2 → 2.7.4

package/docs/file.md

@@ -34,6 +34,7 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`downloadFiles`](#downloadfiles)
 - [`createZipJob`](#createzipjob)
 - [`getZipJob`](#getzipjob)
+- [`generateFileSummary`](#generatefilesummary)
 - [`verifyCustomDownloadUrl`](#verifycustomdownloadurl)
 - [`uploadFilePublic`](#uploadfilepublic)
 
@@ -68,6 +69,8 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`FileEntityId`](#fileentityid)
 - [`FileAttributes`](#fileattributes)
 - [`FileType`](#filetype)
+- [`FileSummaryStatus`](#filesummarystatus)
+- [`FileSummaryGenerationStatus`](#filesummarygenerationstatus)
 - [`CustomDownloadUrl`](#customdownloadurl)
 - [`FileEntity`](#fileentity)
 - [`CommonSaveFilePayload`](#commonsavefilepayload)
@@ -173,6 +176,9 @@ const { data } = await client.saveFileV2(
     access_control: 'private',
     public_url: 'https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf',
     custom_download_url: 'https://some-api-url.com/download?file_id=123',
+    preview_summary: 'string',
+    short_summary: 'string',
+    summary_status: 'processing',
     s3ref: {}
   },
 )
@@ -198,6 +204,9 @@ const { data } = await client.saveFileV2(
   "access_control": "private",
   "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
   "custom_download_url": "https://some-api-url.com/download?file_id=123",
+  "preview_summary": "string",
+  "short_summary": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -265,6 +274,9 @@ const { data } = await client.getFile({
   "access_control": "private",
   "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
   "custom_download_url": "https://some-api-url.com/download?file_id=123",
+  "preview_summary": "string",
+  "short_summary": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -332,6 +344,9 @@ const { data } = await client.deleteFile({
   "access_control": "private",
   "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
   "custom_download_url": "https://some-api-url.com/download?file_id=123",
+  "preview_summary": "string",
+  "short_summary": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -509,6 +524,20 @@ const { data } = await client.getZipJob({
 
 ---
 
+### `generateFileSummary`
+
+Request AI generation of preview and short summaries for a file entity.
+
+`POST /v1/files/{id}/summary:generate`
+
+```ts
+const { data } = await client.generateFileSummary({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+---
+
 ### `previewFile`
 
 Generate a thumbnail preview for a file entity.
@@ -925,6 +954,9 @@ const { data } = await client.getFilesInCollection({
     "access_control": "private",
     "public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf",
     "custom_download_url": "https://some-api-url.com/download?file_id=123",
+    "preview_summary": "string",
+    "short_summary": "string",
+    "summary_status": "processing",
     "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
     "s3ref": {},
     "versions": [
@@ -1039,6 +1071,9 @@ type FileAttributes = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1048,6 +1083,22 @@ type FileAttributes = {
 type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown"
 ```
 
+### `FileSummaryStatus`
+
+Current AI summary generation state for the file.
+
+```ts
+type FileSummaryStatus = "processing" | "completed" | "failed" | "unsupported"
+```
+
+### `FileSummaryGenerationStatus`
+
+```ts
+type FileSummaryGenerationStatus = {
+  status: "processing" | "completed" | "failed" | "unsupported"
+}
+```
+
 ### `CustomDownloadUrl`
 
 Custom external download url used for the file
@@ -1075,6 +1126,9 @@ type FileEntity = {
   access_control: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string
   s3ref?: object
   versions: Array<{
@@ -1135,6 +1189,9 @@ type SaveS3FilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 }
 ```
@@ -1161,6 +1218,9 @@ type SaveFileFromSourceURLPayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 }
 ```
@@ -1187,6 +1247,9 @@ type SaveCustomFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1212,6 +1275,9 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 } | {
   _id?: object
@@ -1232,6 +1298,9 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 } | {
   _id?: object
@@ -1252,6 +1321,9 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1277,6 +1349,9 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 } | {
   _id?: object
@@ -1297,6 +1372,9 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 } | {
   _id?: object
@@ -1317,6 +1395,9 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary?: string
+  short_summary?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.7.2",
+  "version": "2.7.4",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/chunk-3APTSPY4.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/file-runtime.json
-var require_file_runtime = __commonJS({
-  "src/definitions/file-runtime.json"(exports, module) {
-    module.exports = { s: "https://file.sls.epilot.io", o: [["uploadFileV2", "post", "/v2/files/upload", [["file_entity_id", "q"]], 1], ["saveFileV2", "post", "/v2/files", [["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["StrictQueryParam"], ["AsyncOperationQueryParam"], ["DeleteTempFileQueryParam"], ["VersionOnlyQueryParam"]], 1], ["uploadFile", "post", "/v1/files/upload", [["file_entity_id", "q"]], 1], ["saveFile", "post", "/v1/files", [["ActivityIdQueryParam"], ["AsyncOperationQueryParam"], ["VersionOnlyQueryParam"]], 1], ["getFile", "get", "/v2/files/{id}", [["id", "p", true], ["source_url", "q"], ["StrictQueryParam"], ["AsyncOperationQueryParam"]]], ["deleteFile", "delete", "/v2/files/{id}", [["id", "p", true], ["purge", "q"], ["ActivityIdQueryParam"], ["StrictQueryParam"]]], ["downloadFile", "get", "/v1/files/{id}/download", [["id", "p", true], ["version", "q"], ["attachment", "q"]]], ["downloadS3File", "post", "/v1/files:downloadS3", [["s3_key", "q", true], ["s3_bucket", "q", true], ["attachment", "q"]]], ["downloadFiles", "post", "/v1/files:downloadFiles", null, 1], ["createZipJob", "post", "/v1/files:zipJob", null, 1], ["getZipJob", "get", "/v1/files:zipJob/{job_id}", [["job_id", "p", true]]], ["previewFile", "get", "/v1/files/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"]]], ["previewS3File", "post", "/v1/files:previewS3", [["w", "q"], ["h", "q"]], 1], ["previewS3FileGet", "get", "/v1/files:previewS3", [["key", "q", true], ["bucket", "q", true], ["w", "q"], ["h", "q"]]], ["previewPublicFile", "get", "/v1/files/public/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"], ["org_id", "q"]]], ["getSession", "get", "/v1/files/session"], ["deleteSession", "delete", "/v1/files/session"], ["generatePublicLink", "post", "/v1/files/{id}/public/links", [["id", "p", true]]], ["listPublicLinksForFile", "get", "/v1/files/{id}/public/links", [["id", "p", true]]], ["accessPublicLink", "get", "/v1/files/public/links/{id}/{filename}", [["id", "p", true], ["filename", "p", true], ["hash", "q"]]], ["revokePublicLink", "delete", "/v1/files/public/links/{id}", [["id", "p", true]]], ["verifyCustomDownloadUrl", "post", "/v1/files/download:verify", null, 1], ["uploadFilePublic", "post", "/v1/files/public/upload", null, 1], ["getUserSchemaFileCollections", "get", "/v1/{slug}/collections", [["slug", "p", true]]], ["createUserSchemaFileCollection", "post", "/v1/{slug}/collections", [["slug", "p", true]], 1], ["updateUserSchemaFileCollection", "put", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]], 1], ["deleteUserSchemaFileCollection", "delete", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]]], ["getFilesInCollection", "get", "/v1/entity/{id}/collections/{collectionSlug}/files", [["EntityIdPathParam"], ["collectionSlug", "p", true]]], ["getGlobalFileCollections", "get", "/v1/collections/{schemaSlug}", [["schemaSlug", "p", true]]]], v: "3.0.3", cp: { EntityIdPathParam: ["id", "p", true], StrictQueryParam: ["strict", "q"], ActivityIdQueryParam: ["activity_id", "q"], FillActivityQueryParam: ["fill_activity", "q"], AsyncOperationQueryParam: ["async", "q"], DeleteTempFileQueryParam: ["delete_temp_file", "q"], VersionOnlyQueryParam: ["version_only", "q"] } };
-  }
-});
-
-export {
-  require_file_runtime
-};

package/dist/chunk-OPXGJKZR.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/file-runtime.json
-var require_file_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "src/definitions/file-runtime.json"(exports, module) {
-    module.exports = { s: "https://file.sls.epilot.io", o: [["uploadFileV2", "post", "/v2/files/upload", [["file_entity_id", "q"]], 1], ["saveFileV2", "post", "/v2/files", [["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["StrictQueryParam"], ["AsyncOperationQueryParam"], ["DeleteTempFileQueryParam"], ["VersionOnlyQueryParam"]], 1], ["uploadFile", "post", "/v1/files/upload", [["file_entity_id", "q"]], 1], ["saveFile", "post", "/v1/files", [["ActivityIdQueryParam"], ["AsyncOperationQueryParam"], ["VersionOnlyQueryParam"]], 1], ["getFile", "get", "/v2/files/{id}", [["id", "p", true], ["source_url", "q"], ["StrictQueryParam"], ["AsyncOperationQueryParam"]]], ["deleteFile", "delete", "/v2/files/{id}", [["id", "p", true], ["purge", "q"], ["ActivityIdQueryParam"], ["StrictQueryParam"]]], ["downloadFile", "get", "/v1/files/{id}/download", [["id", "p", true], ["version", "q"], ["attachment", "q"]]], ["downloadS3File", "post", "/v1/files:downloadS3", [["s3_key", "q", true], ["s3_bucket", "q", true], ["attachment", "q"]]], ["downloadFiles", "post", "/v1/files:downloadFiles", null, 1], ["createZipJob", "post", "/v1/files:zipJob", null, 1], ["getZipJob", "get", "/v1/files:zipJob/{job_id}", [["job_id", "p", true]]], ["previewFile", "get", "/v1/files/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"]]], ["previewS3File", "post", "/v1/files:previewS3", [["w", "q"], ["h", "q"]], 1], ["previewS3FileGet", "get", "/v1/files:previewS3", [["key", "q", true], ["bucket", "q", true], ["w", "q"], ["h", "q"]]], ["previewPublicFile", "get", "/v1/files/public/{id}/preview", [["id", "p", true], ["version", "q"], ["w", "q"], ["h", "q"], ["org_id", "q"]]], ["getSession", "get", "/v1/files/session"], ["deleteSession", "delete", "/v1/files/session"], ["generatePublicLink", "post", "/v1/files/{id}/public/links", [["id", "p", true]]], ["listPublicLinksForFile", "get", "/v1/files/{id}/public/links", [["id", "p", true]]], ["accessPublicLink", "get", "/v1/files/public/links/{id}/{filename}", [["id", "p", true], ["filename", "p", true], ["hash", "q"]]], ["revokePublicLink", "delete", "/v1/files/public/links/{id}", [["id", "p", true]]], ["verifyCustomDownloadUrl", "post", "/v1/files/download:verify", null, 1], ["uploadFilePublic", "post", "/v1/files/public/upload", null, 1], ["getUserSchemaFileCollections", "get", "/v1/{slug}/collections", [["slug", "p", true]]], ["createUserSchemaFileCollection", "post", "/v1/{slug}/collections", [["slug", "p", true]], 1], ["updateUserSchemaFileCollection", "put", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]], 1], ["deleteUserSchemaFileCollection", "delete", "/v1/{slug}/collections/{collectionSlug}", [["slug", "p", true], ["collectionSlug", "p", true]]], ["getFilesInCollection", "get", "/v1/entity/{id}/collections/{collectionSlug}/files", [["EntityIdPathParam"], ["collectionSlug", "p", true]]], ["getGlobalFileCollections", "get", "/v1/collections/{schemaSlug}", [["schemaSlug", "p", true]]]], v: "3.0.3", cp: { EntityIdPathParam: ["id", "p", true], StrictQueryParam: ["strict", "q"], ActivityIdQueryParam: ["activity_id", "q"], FillActivityQueryParam: ["fill_activity", "q"], AsyncOperationQueryParam: ["async", "q"], DeleteTempFileQueryParam: ["delete_temp_file", "q"], VersionOnlyQueryParam: ["version_only", "q"] } };
-  }
-});
-
-
-
-exports.require_file_runtime = require_file_runtime;