@epilot/sdk 2.8.0-rc.0 → 2.8.1

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,11 @@ 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_de: 'string',
+    short_summary_de: 'string',
+    preview_summary_en: 'string',
+    short_summary_en: 'string',
+    summary_status: 'processing',
     s3ref: {}
   },
 )
@@ -198,6 +206,11 @@ 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_de": "string",
+  "short_summary_de": "string",
+  "preview_summary_en": "string",
+  "short_summary_en": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -265,6 +278,11 @@ 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_de": "string",
+  "short_summary_de": "string",
+  "preview_summary_en": "string",
+  "short_summary_en": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -332,6 +350,11 @@ 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_de": "string",
+  "short_summary_de": "string",
+  "preview_summary_en": "string",
+  "short_summary_en": "string",
+  "summary_status": "processing",
   "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
   "s3ref": {},
   "versions": [
@@ -509,6 +532,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 +962,11 @@ 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_de": "string",
+    "short_summary_de": "string",
+    "preview_summary_en": "string",
+    "short_summary_en": "string",
+    "summary_status": "processing",
     "source_url": "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf",
     "s3ref": {},
     "versions": [
@@ -1039,6 +1081,11 @@ type FileAttributes = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1048,6 +1095,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 +1138,11 @@ type FileEntity = {
   access_control: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string
   s3ref?: object
   versions: Array<{
@@ -1135,6 +1203,11 @@ type SaveS3FilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 }
 ```
@@ -1161,6 +1234,11 @@ type SaveFileFromSourceURLPayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 }
 ```
@@ -1187,6 +1265,11 @@ type SaveCustomFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1212,6 +1295,11 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 } | {
   _id?: object
@@ -1232,6 +1320,11 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 } | {
   _id?: object
@@ -1252,6 +1345,11 @@ type SaveFilePayload = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```
 
@@ -1277,6 +1375,11 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   s3ref?: unknown
 } | {
   _id?: object
@@ -1297,6 +1400,11 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
   source_url?: string // uri
 } | {
   _id?: object
@@ -1317,6 +1425,11 @@ type SaveFilePayloadV2 = {
   access_control?: "private" | "public-read"
   public_url?: string // url
   custom_download_url?: string // uri
+  preview_summary_de?: string
+  short_summary_de?: string
+  preview_summary_en?: string
+  short_summary_en?: string
+  summary_status?: "processing" | "completed" | "failed" | "unsupported"
 }
 ```