Adobe Acrobat 知識庫(預覽版)

Adobe Acrobat Studio 的知識庫讓使用者能以對話方式存取大型精選文件收藏中的知識,涵蓋多回合問答、摘要、擷取與搜尋。 將知識庫功能引入你工作的應用程式與工作流程中,連結儲存在 SharePoint 及其他支援倉庫中的知識,並驅動核准、通知、內容創建及業務流程。

此連接器適用於以下產品和區域:

服務 Class Regions
Copilot Studio 進階 除下列區域外的所有 Power Automate 區域 :
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 (DoD)
Power Apps 進階 除下列區域外的所有 Power Apps 區域 :
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
Power Automate(自動化服務) 進階 除下列區域外的所有 Power Automate 區域 :
     - 美國政府 (GCC)
     - 美國政府(海灣合作委員會高中)
     - 由 21Vianet 營運的中國雲
     - 美國國防部 (DoD)
聯絡方式
Name Adobe
URL https://www.adobe.com
連接器中繼資料
Publisher ADOBE 公司
網站 https://business.adobe.com/products/acrobat-business/knowledge-base.html
隱私權原則 https://www.adobe.com/go/privacy_policy
類別 Productivity

Acrobat 中的知識庫

Adobe Acrobat Studio 的知識庫讓使用者能以對話方式存取大型精選文件收藏中的知識,涵蓋多回合問答、摘要、擷取與搜尋。 將知識庫功能引入你工作的應用程式與工作流程中,連結儲存在 SharePoint 及其他支援倉庫中的知識,並驅動核准、通知、內容創建及業務流程。

發行商:Adobe, Inc.

Prerequisites

必須有 Adobe 帳號並能存取 Acrobat 的知識庫。

如何取得認證

建立連線時請用你的 Adobe ID 登入。 此連接器可透過 Adobe 身份管理系統(IMS)使用 OAuth 2.0 進行認證;連線建立前,您會被導至Adobe登入頁面並被要求同意所請求的權限。

開始使用連接器

N/A

已知問題和限制

N/A

常見錯誤和補救措施

N/A

FAQ

N/A

動作

上傳文件

將一份或多份文件上傳到收藏中以便索引。

上傳附件

上傳一個或多個附件。

列出文件

列出收藏中的文件。

列出附件

列出附件。

列表集合

列出使用者可存取的收藏。

刪除文件

透過 UUID 從收藏中刪除一份或多份文件。

刪除附件

刪除單一附件,透過 UUID。

刪除集合

刪除一個收藏及其所有文件。

取得文件檔案

透過 UUID 取得單一文件的元資料和內容。

取得文件狀態

透過單一文件的 UUID 來取得其索引狀態。

取得附件檔案

依照附件的 UUID 下載檔案內容。

取得集合

依據 UUID 取得單一收藏。

建立集合

建立一個集合(一個用來分組文件並控制存取的命名空間)。

提出問題

針對一個集合提出自然語言問題,並附上引用。

搜尋文件(分頁)

在收藏中搜尋有分頁排名結果的文件。

摘要文件

產生一個或多個文件的摘要。

更新集合

更新所有現有收藏的屬性。

獲取依戀

用 UUID 取得單一附件。

上傳文件

將一份或多份文件上傳到收藏中以便索引。

參數

名稱 機碼 必要 類型 Description
集合識別碼
collection_id True uuid4

收藏的唯一識別碼

重複處理
option string

重複處理策略。

價值 行為
FILE_NAME 將任何現有文件替換成相同的檔名
FILE_CHECKSUM 只有當檔名相符但內容雜湊(MD5)不同時,才應該替換檔案。
SKIP_DUPLICATES 靜默跳過已存在的檔案(校驗碼)
REJECT_REQUEST_ON_DUPLICATE 若偵測到重複,請回傳 400 錯誤
(省略) 允許重複上傳
OCR 模式
ocr string

PDF 與影像文件的 OCR 處理模式。 圖片上傳總是需要 OCR。

價值 行為
AUTO 必要時使用OCR;圖片上傳總是會被處理 (預設)
FORCE 每頁都要點陣並用 OCR 處理
NONE 非影像文件可跳過 OCR;圖片上傳仍會被處理
REJECT_BAD 自動套用OCR,並拒絕未通過品質檢查的頁面
隱藏片萃取
hidden_sheets string

控制 Excel 文件的隱藏表格擷取模式。

價值 行為
ALL 擷取所有工作表,包括隱藏和非常隱藏 的工作表(預設)
NONE 僅擷取可見的片表
HIDDEN 擷取可見與隱藏的片
VERY_HIDDEN 擷取可見且非常隱藏的片狀圖
要上傳的檔案
documents True file

一個或多個檔案要上傳。 支援格式:PDF、DOC/DOCX、DOT/DOTX、TXT、RTF、XLS/XLSM/XLSX、PPT/PPTX、ODP、ODT、CSV、EML、JSON、MD、HTML、JPEG、PNG、TIFF、GIF、WebP 及 BMP。

文件標籤
document_tags string

JSON 的鍵值標籤陣列,可附加於所有上傳的文件。 每個標籤必須包含一個 key (1-127個字元,包含小寫字母數字及連字號)和一個 value (1-256個字元)。

HTML 原始連結
html_links string

JSON 物件將 HTML 檔案名稱映射到原始來源 URL。 只適用於已上傳的 HTML 檔案。 鍵是上傳時 HTML 檔案的檔名,而值則是原始儲存的網址。

傳回

回應上傳文件
array of UploadDocumentResponse

上傳附件

上傳一個或多個附件。

參數

名稱 機碼 必要 類型 Description
要上傳的檔案
documents True file

1至10張圖片或檔案。 圖片:image/jpeg、image/png、image/jpg、image/webp、image/gif - 每個≤10 MB。 檔案:應用程式/PDF - 每個 ≤8 MB

傳回

API 回應 v2 附件批次上傳。

附件上傳回應
AttachmentUploadsResponse

列出文件

列出收藏中的文件。

參數

名稱 機碼 必要 類型 Description
集合識別碼
collection_id True string

收藏的唯一識別碼

頁面
page integer

頁碼(以1為基礎)

頁面大小
page_size integer

每頁項目數量(1-100)

訂購方式
order_by string

要排序結果的欄位。

價值 排序
document_name 文件檔名 (預設)
updated_at 最後修改時間戳記
upload_status 處理狀態
uploaded_at 上傳時間戳記
uploaded_by 上傳者
遞增
asc boolean

如果 true,則按升序排序,若 false則由高至低排序。

名稱包含
infix string

搜尋文件名稱(大小寫不區分部分匹配)。

來源類型
source_type string

結果僅限於具有此來源的文件。 設定此篩選時,沒有來源元資料的文件會被排除。

傳回

InfoPageApiResponse
InfoPageApiResponse

列出附件

列出附件。

傳回

回應清單附件
array of AttachmentResponse

列表集合

列出使用者可存取的收藏。

參數

名稱 機碼 必要 類型 Description
頁面
page integer

頁碼(以1為基礎)

頁面大小
page_size integer

每頁項目數量(1-100)

訂購方式
order_by string

要排序結果的欄位。

價值 排序
name 集合顯示名稱 (預設)
created_at 建立時間戳
modified_at 最後修改時間戳記
遞增
asc boolean

如果 true,則按升序排序,若 false則由高至低排序。

名稱包含
infix string

搜尋館藏名稱(大小寫不區分部分匹配)。

篩選
filter_constraint string

依所有權或範圍篩選收藏。

價值 Returns
created_by:me 你建立的收藏
shared_by:me 你與他人分享的收藏
shared_by:others 其他人分享給你的收藏
scope:org 你組織內的所有收藏(僅限組織管理員)
scope:system 所有組織的集合(僅限系統管理員)

傳回

收藏頁面
CollectionPage

刪除文件

透過 UUID 從收藏中刪除一份或多份文件。

參數

名稱 機碼 必要 類型 Description
文件標識碼
document_ids array of uuid4

文件 UUID 清單。

集合識別碼
collection_id string

包含文件的收藏UUID。

傳回

刪除文件回應
DeleteDocumentResponse

刪除附件

刪除單一附件,透過 UUID。

參數

名稱 機碼 必要 類型 Description
附件 ID
attachment_id True uuid

附件的UUID

刪除集合

刪除一個收藏及其所有文件。

參數

名稱 機碼 必要 類型 Description
集合識別碼
collection_id True uuid4

收藏的唯一識別碼

傳回

完整的收藏細節,包括元資料、權限及狀態。

NamespaceResponse(命名空間回應)
NamespaceResponse

取得文件檔案

透過 UUID 取得單一文件的元資料和內容。

參數

名稱 機碼 必要 類型 Description
文件識別碼
document_id True uuid

文件的UUID

工件檔案名稱
filename string

特定儲存的文物可供取回。 若遺漏,則會回傳當前文件的版本。

傳回

response
binary

取得文件狀態

透過單一文件的 UUID 來取得其索引狀態。

參數

名稱 機碼 必要 類型 Description
文件識別碼
document_id True uuid

文件的UUID

傳回

取得附件檔案

依照附件的 UUID 下載檔案內容。

參數

名稱 機碼 必要 類型 Description
附件 ID
attachment_id True uuid

附件的UUID

取得集合

依據 UUID 取得單一收藏。

參數

名稱 機碼 必要 類型 Description
集合識別碼
collection_id True string

收藏的唯一識別碼

傳回

完整的收藏細節,包括元資料、權限及狀態。

NamespaceResponse(命名空間回應)
NamespaceResponse

建立集合

建立一個集合(一個用來分組文件並控制存取的命名空間)。

參數

名稱 機碼 必要 類型 Description
Name
name True string

收藏的顯示名稱。 所需裝備,最大長度為100個角色

Description
description string

收藏品的可選描述。 預設為空字串,最大長度為 500 字元

是公開的
is_public boolean

該收藏是否對外開放。

冰封
is_frozen boolean

該收藏是否被凍結且無法修改。

閱讀使用者
read_users array of string

擁有可讀取該集合的使用者 ID 清單。

寫入使用者
write_users array of string

擁有寫入權限的使用者 ID 清單。

閱讀群組
read_groups array of string

擁有讀取權限的群組 ID(UUID)列表。

寫作群組
write_groups array of string

擁有寫入權限的群組 ID(UUID)列表。

Metadata
metadata object

與本收藏相關的可選元資料。 最大長度 1000 個角色

傳回

完整的收藏細節,包括元資料、權限及狀態。

NamespaceResponse(命名空間回應)
NamespaceResponse

提出問題

針對一個集合提出自然語言問題,並附上引用。

參數

名稱 機碼 必要 類型 Description
要求標識碼
request_id string

此請求的唯一識別碼,用於聊天記錄追蹤。

文件標識碼
document_ids array of string

限制搜尋範圍的特定文件UUID。 當文件為空時,會搜尋指定集合中的所有文件。

Collections
collections array of string

集合命名空間可搜尋。 至少需要一個 COLLECTION 來源。

Inputs
inputs string

問題或提示。 支援自然語言查詢。

Format
format string
冗長
style string
音調
tone string
Reasoning
reasoning string
自訂說明
custom_instructions string

提供自由文字指示,進一步客製化 AI 回應行為。

來源選項
Source Options string
推論模式
inference_mode string

AI 模型的使用層級。 選項: STANDARD (速度與品質平衡)、 FAST_REASONING (以推理優化速度)、 ADVANCED (最高品質)、 LITE (快速、低成本 — 僅限非收藏)、 NANO (最快、最低成本、僅限非收藏)。 因為 inference_type=AGENTIC 這是撰寫答案的代理人的層級;它委派的工作可能會在服務選擇的更快層級上執行。

執行策略
inference_type string

問答推論的執行策略。

與推論模式(模型層級)正交:AGENTIC 選擇多重迭代代理迴圈,DEFAULT 選擇經典單推論 RAG 路徑。 沒有 遺漏 的強制——未知數值必須驗證失敗。

Key
key True string

標籤識別碼。 僅包含字母數字和連字符。

價值
value True string

標記值。 僅包含字母數字和連字符。

附件識別碼
attachment_ids array of uuid4

先前上傳的檔案附件識別碼,作為視覺上下文。 每次請求最多15人。 可接受的輸入類型:圖片(JPEG、PNG、GIF、WEBP)及 PDF。 其他檔案類型會在上傳時被拒絕。 在多回合對話中,最新的 5 個 LLM 產生檔案會自動重播作為上下文;由於大型語言模型服務基礎設施的限制,僅重播圖片與 PDF。

檔案產生模式
file_generation string
連線識別碼
connection_id string

Office 365 連線的 ID 可供使用。 只OFFICE365來源需要。 若省略,則使用第一個匹配的連接。

時區
time_zone string

用於日期感知查詢的 IANA 時區識別碼(例如 America/Los_Angeles、 UTC)。

啟用人物
enable_figures boolean

若屬實,檢索的文件圖表(圖表、圖片)會作為視覺上下文。 最多可達8位數(每份文件最多4位)。

Microsoft Store
store boolean

若屬實,對話會持續存入聊天紀錄,支援多回合後續追蹤。 對於無狀態、一次性查詢,將 false 設為 false。

歸屬欄位
Include string

DocumentInfo 中可納入來源回應的欄位。

每個值都是根於 DocumentInfo 的點符號路徑。 每條路徑必須解析為一個標註為 attribution_eligible = True。

BoundCoordinateFormat
bound_coordinate_format string
已啟用
enabled boolean

在直播期間啟用進度事件。

回應事件詳細
detail string
答案更新
answer_updates boolean

將代理答案按寫法串流,以帶有 answer_update(附加後完成或失敗)的幀形式呈現,而非最後一個幀。 客戶必須執行這些操作。 非串流或非代理請求則被忽略。

Exchange ID
exchange_id string

客戶在對話中識別的這段對話。 隨交換一同儲存,並回傳到聊天記錄中,讓客戶端能將本地回合與紀錄調和:同一個問題重複會產生兩次交換,只有 ID 能區分兩者。

傳回

QAInference回應
QAInferenceResponse

搜尋文件(分頁)

在收藏中搜尋有分頁排名結果的文件。

參數

名稱 機碼 必要 類型 Description
文件命名空間
document_namespace True string

文件的集合名稱,以便搜尋。

篩選依據
filter_by True string

關鍵字搜尋查詢,用以依內容或元資料篩選文件。

文件標識碼
document_ids array of string

列出可限制搜尋的特定文件識別碼。 最多可有 1000 個文件識別碼。

Key
key True string

標籤識別碼。 僅包含字母數字和連字符。

價值
value True string

標記值。 僅包含字母數字和連字符。

頁面大小
page_size integer

每頁要傳回的結果數目。 非分頁搜尋總是回傳 10000 page_size。

排序方式
order_by string

用來排序結果的欄位。

Asc
asc boolean

排序順序:True 表示升序,False 表示降序。

頁碼順序
pagination_order string

決定是要取得下一頁還是上一頁的結果。

分頁鍵
paginated_key string

用於分頁的鍵。

傳回

分頁搜尋 ApiResponse
PaginatedSearchApiResponse

摘要文件

產生一個或多個文件的摘要。

參數

名稱 機碼 必要 類型 Description
文件標識碼
document_ids True array of string

用特定文件的UUID來摘要。 每次申請最多10份文件。

文件命名空間
document_namespace True string

包含文件的收藏命名空間。

傳回

回應摘要文件
array of SummarizationResponse

更新集合

更新所有現有收藏的屬性。

參數

名稱 機碼 必要 類型 Description
集合識別碼
collection_id True uuid4

收藏的唯一識別碼

Name
name True string

收藏的顯示名稱。 所需裝備,最大長度為100個角色

Description
description string

收藏品的可選描述。 預設為空字串,最大長度為 500 字元

是公開的
is_public boolean

該收藏是否對外開放。

冰封
is_frozen boolean

該收藏是否被凍結且無法修改。

閱讀使用者
read_users array of string

擁有可讀取該集合的使用者 ID 清單。

寫入使用者
write_users array of string

擁有寫入權限的使用者 ID 清單。

閱讀群組
read_groups array of string

擁有讀取權限的群組 ID(UUID)列表。

寫作群組
write_groups array of string

擁有寫入權限的群組 ID(UUID)列表。

Metadata
metadata object

與本收藏相關的可選元資料。 最大長度 1000 個角色

命名空間識別碼
namespace_id string

收藏的 UUID 更新。

傳回

完整的收藏細節,包括元資料、權限及狀態。

NamespaceResponse(命名空間回應)
NamespaceResponse

獲取依戀

用 UUID 取得單一附件。

參數

名稱 機碼 必要 類型 Description
附件 ID
attachment_id True uuid

附件的UUID

傳回

Attachment回應
AttachmentResponse

定義

答案結果

一個答案的結果是:沒有、不完整,或是切割的程式碼不完整。

名稱 路徑 類型 Description
Status
status string

答案是否存在,以及它的世代是否已經結束。

Reason
reason string

中斷碼不完整時,失敗碼不完整;完成後從未設定。

回覆更新

串流客戶端顯示的答案只有一個操作:附加、完成或失敗。

complete 設定時 reason 不完整; fail 帶有失敗代碼,且從未撤回顯示的文字。

名稱 路徑 類型 Description
運算
operation string
Reason
reason string

僅限終端機:完成時顯示中斷碼(例如 response_truncated_deadline),失敗時顯示故障碼(例如 budget_exhausted、save_failed)。

持續性
persistence Persistence

交換是否有記錄; unknown 表示提交可能已經發生。

附件錯誤代碼

上傳附件失敗的錯誤代碼。

上傳附件失敗的錯誤代碼。

附件錯誤代碼
string

Attachment回應

名稱 路徑 類型 Description
附件 ID
attachment_id string
附件名稱
attachment_name string
附件 MIME 類型
attachment_mime_type string

影像 MIME 類型(例如 image/png)

附件校驗和
attachment_checksum string

MD5 影像位元組的校驗和

附件尺寸
attachment_size integer

影像大小(位元組)

附件狀態
attachment_status string

附件上傳錯誤

單一附件上傳的機器可讀故障細節。

名稱 路徑 類型 Description
附件錯誤代碼
code AttachmentErrorCode

上傳附件失敗的錯誤代碼。

Message
message string
Size
size integer
默劇類型
mime_type string

附件上傳項目

統一的每個檔案會產生 v2 附件上傳回應。

名稱 路徑 類型 Description
檔案名稱
filename string
附件上傳項目狀態
status AttachmentUploadItemStatus

v2 附件批次上傳回應的每個檔案狀態。

狀態代碼
status_code integer
Attachment回應
attachment AttachmentResponse
附件上傳錯誤
error AttachmentUploadError

單一附件上傳的機器可讀故障細節。

附件上傳項目狀態

v2 附件批次上傳回應的每個檔案狀態。

v2 附件批次上傳回應的每個檔案狀態。

附件上傳項目狀態
string

附件上傳回應

API 回應 v2 附件批次上傳。

名稱 路徑 類型 Description
上傳
uploads array of AttachmentUploadItem

收藏頁面

名稱 路徑 類型 Description
頁面
page integer

目前頁碼(以1為基礎)。

Size
size integer

每頁的項目數。

Total
total integer

與查詢相符的集合總數。

排序方式
order_by string

欄位以前用來整理結果。

Asc
asc boolean

結果是否依升序排序。

頁數
pages array of Namespace

本頁上的收藏列表。

刪除文件回應

名稱 路徑 類型 Description
詳細資訊
details array of DocumentDeletionStatus

每份文件刪除結果。

文件刪除狀態

名稱 路徑 類型 Description
文件標識碼
document_id string

文件的UUID(統一身份識別碼)。

Status
status Status
Message
message string

描述結果的人類易讀訊息。

DocumentInfoApiResponse

名稱 路徑 類型 Description
文件標識碼
document_id string

文件的UUID(統一身份識別碼)。

文件名稱
document_name string

顯示文件名稱(通常是原始檔名)。

文件路徑
document_path string

文件在系統內的儲存路徑。

文件命名空間
document_namespace string

此文件所屬的集合命名空間。

文件命名空間 ID
document_namespace_id string

該文件所屬收藏的UUID。

文件說明
document_description string

使用者提供的文件說明。

上傳者
uploaded_by string

上傳文件者的電子郵件地址。 當沒有上傳者的電子郵件可用時,則是 Null。

上傳狀態
upload_status string

目前上傳/處理狀態。

價值 Meaning
UPLOADED 檔案已接收,等待處理中
IN_PROGRESS 處理工作已經開始
CONVERTING 轉換為可索引格式
INDEXING 建築搜尋索引
COMPLETE 準備好回答查詢
FAILED 處理失敗
檢查碼
checksum string

文件檔案的 SHA-256 校驗和用於完整性驗證。

默劇類型
mime_type string

原始原始文件的 MIME 類型。

表演默劇類型
rendition_mime_type string

客戶端呈現的 MIME 類型;外部來源使用 text/uri-list。

來源類型
source_type string

本文件的原始來源:SHAREPOINT、、SHAREPOINT_SITEGOOGLE_DRIVE、或UPLOAD。 null 適用於沒有來源元資料的文件。

文件狀態
status DocumentStatus
上傳於
uploaded_at date-time

文件上傳時間戳記(ISO 8601格式)。

更新時間
updated_at date-time

如果有的話,請標示文件記錄最後一次更新的時間戳記。

已刪除
is_deleted boolean

文件是否被軟刪除。

文件元資料
document_metadata DocumentMetadata

文件元資料

名稱 路徑 類型 Description
Permissions
permissions
文件標籤
document_tags array of DocumentTag
來源元資料
source_metadata
IngestionMetadata
ingestion_metadata IngestionMetadata

文件狀態

名稱 路徑 類型 Description
Status
status string
錯誤碼
error_code string

DocumentTag

名稱 路徑 類型 Description
Key
key string

標籤識別碼。 僅包含字母數字和連字符。

價值
value string

標記值。 僅包含字母數字和連字符。

InfoPageApiResponse

名稱 路徑 類型 Description
頁面
page integer

目前頁碼(以1為基礎)。

Size
size integer

每頁的項目數。

Total
total integer

與查詢相符的文件總數。

排序方式
order_by string

欄位以前用來整理結果。

Asc
asc boolean

結果是否依升序排序。

頁數
pages array of DocumentInfoApiResponse

本頁文件列表。

IngestionMetadata

名稱 路徑 類型 Description
信賴分數
confidence_score number
奧克羅斯
ocr boolean
壞角色
bad_characters boolean
發現隱藏的床單
found_hidden_sheets boolean
發現了非常隱蔽的床單
found_very_hidden_sheets boolean
發現了受保護的隱藏床單
found_protected_hidden_sheets boolean
啟用隱藏圖表
enabled_hidden_sheets boolean
啟用非常隱藏的床單
enabled_very_hidden_sheets boolean
文件建立日期
document_created_date date-time

命名空間

名稱 路徑 類型 Description
命名空間
namespace string

集合的唯一識別碼。 預設是 UUID。 把它當作外部 ID。

Name
name string

收藏的可選顯示名稱。 若未提供「命名空間」,則為必要。

Description
description string

以人文易讀的收藏描述。

冰封
is_frozen boolean

該收藏是否被凍結且無法修改。

作者
created_by string

收藏創作者的電子郵件或ID。

由使用者 ID 建立
created_by_user_id string

收藏庫創建者的使用者ID。

是公開的
is_public boolean

該收藏是否對外開放。

閱讀使用者
read_users array of string

具有讀取權限的使用者 ID 列表。

寫入使用者
write_users array of string

具備寫入權限的使用者 ID 列表。

閱讀群組
read_groups array of string

具有讀取權限的群組 ID 列表。

寫作群組
write_groups array of string

擁有寫入權限的群組 ID 列表。

Metadata
metadata object

與該收藏相關的額外元資料。

版本
version string

集合的 API 版本。

命名空間識別碼
namespace_id string

集合的唯一識別碼。

創立於
created_at date-time

收藏建立的時間戳記。

修改時間
modified_at date-time

集合最後修改的時間戳記。

已刪除
is_deleted boolean

該收藏是否已被軟刪除。

處於活動狀態
is_active boolean

該收藏目前是否仍在運作。

文件計數
doc_count integer

命名空間的文件計數。 從 metadata.doc_count 中,作為命名空間的頂層屬性 Expose

NamespaceResponse(命名空間回應)

完整的收藏細節,包括元資料、權限及狀態。

名稱 路徑 類型 Description
命名空間識別碼
namespace_id string

集合的唯一識別碼。

命名空間
namespace string

API 呼叫中使用的 URL 安全識別碼。

Name
name string

集錦的顯示名稱。

Description
description string

以人文易讀的收藏描述。

冰封
is_frozen boolean

該收藏是否被凍結且無法修改。

作者
created_by string

收藏庫創建者的使用者ID。

是公開的
is_public boolean

該收藏是否對外開放。

閱讀使用者
read_users array of string

具有讀取權限的使用者 ID 列表。

寫入使用者
write_users array of string

具備寫入權限的使用者 ID 列表。

閱讀群組
read_groups array of string

具有讀取權限的群組 ID 列表。

寫作群組
write_groups array of string

擁有寫入權限的群組 ID 列表。

被拒絕的寫入共享
rejected_write_shares array of string

不自以為是的 寫 分享使用者

Metadata
metadata object

與該收藏相關的額外元資料。

版本
version string

這個回覆的 API 版本。

創立於
created_at date-time

收藏建立的時間戳記。

修改時間
modified_at date-time

集合最後修改的時間戳記。

已刪除
is_deleted boolean

該收藏是否已被軟刪除。

處於活動狀態
is_active boolean

該收藏目前是否仍在運作。

文件計數
doc_count integer

館藏文件數量。

Owner
owner string

收藏擁有者的電子郵件。 目前是建立該集合的使用者。

分頁搜尋 ApiResponse

名稱 路徑 類型 Description
全文件
totalDocuments integer

符合搜尋條件的文件總數。

文件資訊
documentInfo array of DocumentInfoApiResponse

目前結果頁面中的文件列表。

分頁鍵
paginated_key string

不透明頁碼標記。 在後續請求中傳遞此值以取得下一頁或上一頁。

持續性

交換是否有記錄; unknown 表示提交可能已經發生。

交換是否有記錄; unknown 表示提交可能已經發生。

持續性
string

QAInference回應

名稱 路徑 類型 Description
生成的文字
generated_text string

AI 生成的 Markdown 格式答案。

Source
source object

回答中引用的來源文件,以數字引用標記(例如, 1、 2)。 引用會以 、 、 [2]等形式出現在產生的文本[1]中。

串流完整
stream_complete boolean

顯示串流回應是否已結束。 這對非串流回應來說總是如此。

來源選項
source_options array of SourceOptions

用來產生此回應的答案來源類型。

Attachments
attachments array of uuid4

隨答案附帶的 LLM 產生檔案附件(例如 CSV、XLSX、JSON、PDF、圖片)。 支援的輸出類型包括文字格式、試算表、文件及圖片。 在多回合對話中,最新產生的 5 個檔案會自動重播給模型;由於 LLM 服務基礎架構的限制,只有影像和 PDF 會以 LLM 輸入方式重播。

推理摘要
reasoning_summary string

開啟推理模式時,包含 AI 推理過程的摘要。

回應事件
response_event ResponseEvent
回覆更新
answer_update AnswerUpdate

串流客戶端顯示的答案只有一個操作:附加、完成或失敗。

complete 設定時 reason 不完整; fail 帶有失敗代碼,且從未撤回顯示的文字。

答案結果
answer_outcome AnswerOutcome

一個答案的結果是:沒有、不完整,或是切割的程式碼不完整。

回應事件

名稱 路徑 類型 Description
類型
type string

點名空間事件識別碼,遵循模式 response.status.{phase}.{state}。 生命週期事件:response.created, , response.in_progressresponse.error。 狀態事件: context.loading (載入後續問題的對話歷史)、 question.analyzing (理解問題)、 documents.searching (搜尋相關文件集合)、 documents.found (檢索完成,文件識別)、 sources.linking (將答案證據映射至來源文件)、 figures.analyzing (分析文件圖表與圖表)、 context.preparing (組裝模型文件上下文)、 answer.generating (模型正在產生答案)、 answer.streaming (收到第一個答案標記,正在串流中)。

Message
message string

面向使用者的進度文字,描述當前處理步驟。

Meta
meta object

事件的結構化元資料。 常見欄位: collection_names (收藏顯示名稱列表)、 doc_count (找到的文件數量)、 question (分析問題文本)、 document_names (特定請求文件名稱)、 is_follow_up (多回合後續問題為真)。

創立於
created_at string

此事件製作時間的 ISO 8601 UTC 時間戳記。

來源選項

來源選項
string

Status

Status
string

摘要回應

名稱 路徑 類型 Description
Summary
summary string

AI 生成的文件摘要,格式為 Markdown 格式。

Source
source object

用於產生摘要的來源文件,並以數字引用標記標示。

上傳文件回應

每上傳一份文件都會回覆。

名稱 路徑 類型 Description
使用者 ID
user_id string

上傳文件的使用者身分證。

文件標識碼
document_id string

為上傳文件分配的唯一識別碼。

文件名稱
document_name string

上傳文件的原始檔名。

文件命名空間
document_namespace string

文件所屬的命名空間(集合識別碼)。

文件命名空間 ID
document_namespace_id string

該文件所屬收藏的UUID。

Status
status string

上傳文件的處理狀態。

內容類型
content_type string

上傳文件的 MIME 類型。

二進位

這是基本數據類型 『binary』。