Amazon Q 商業版 - API 參考

Amazon Q 商業版是一款基於人工智慧的聊天助手，可幫助企業提高員工工作效率。它可以回答問題、查詢資訊、撰寫電子郵件、總結文字，甚至集思廣益。

建立 Amazon Q 商業版應用程式

所有 Amazon Q 商業版應用程式環境操作都同時支援控制檯和 API。

您無法在 Amazon Q 商業版的 AWS 管理控制檯中直接建立或管理索引。當您建立檢索器時，控制檯會自動建立一個索引。您在控制檯中唯一可以對索引執行的操作是為其新增標籤。

Amazon Q 商業版支援透過控制檯和 API 建立檢索器。

API 操作	API 描述
CreateRetriever	建立 Amazon Q 商業版或 Amazon Kendra 檢索器
DeleteRetriever	刪除 Amazon Q 商業版或 Amazon Kendra 檢索器
GetRetriever	獲取有關現有 Amazon Q 商業版或 Amazon Kendra 檢索器的資訊
ListRetrievers	列出現有的 Amazon Q 商業版或 Amazon Kendra 檢索器
UpdateRetriever	更新現有的 Amazon Q 商業版或 Amazon Kendra 檢索器

Amazon Q 商業版支援透過控制檯和 API 配置資料來源聯結器。

Amazon Q 商業版支援使用控制檯和 API 將文件直接上傳到 Amazon Q 商業版索引中。

API 操作	API 描述
BatchPutDocument	將一個或多個文件新增到 Amazon Q 商業版索引中
BatchDeleteDocument	非同步刪除使用 BatchPutDocument API 新增到 Amazon Q 商業版索引中的一個或多個文件

如果您使用控制檯建立 Amazon Q 商業版應用程式，則會自動建立一個 Web 體驗並將其連線到您選擇的資料來源。

在 Amazon Q 商業版 Web 體驗預覽和已部署的 Amazon Q 商業版 Web 體驗中聊天使用以下 API 操作。

Amazon Q 商業版提供用於管理使用者和組的 API，這些 API 在設定資料來源聯結器連線時會自動呼叫。在以程式設計方式構建 Amazon Q 商業版應用程式環境時，這些 API 也可用於建立自定義使用者和組管理解決方案。

API 操作	API 描述
CreateUser	建立與應用程式內本地使用者 ID 列表對映的通用唯一識別符號 (UUID)
GetUser	描述與資料來源中本地使用者關聯的通用唯一識別符號 (UUID)
UpdateUser	更新與使用者 ID 關聯的資訊
PutGroup	建立或更新使用者與組的對映
DeleteGroup	刪除組，以便所有屬於該組的使用者和子組都無法再訪問僅供該組訪問的文件
GetGroup	按組名稱描述組
ListGroups	提供對映到使用者的組列表

Amazon Q 商業版支援透過控制檯和 API 建立外掛。

Amazon Q 商業版支援透過控制檯和 API 配置管理員控制和護欄。

API 操作	API 描述
UpdateChatControlsConfiguration	更新為現有 Amazon Q 商業版應用程式配置的一組聊天控制
DeletePlugin	刪除 Amazon Q 商業版外掛
DeleteChatControlsConfiguration	刪除為現有 Amazon Q 商業版應用程式配置的聊天控制
GetChatControlsConfiguration	獲取有關為現有 Amazon Q 商業版應用程式配置的聊天控制的資訊。

Amazon Q 商業版捕獲終端使用者對聊天回覆的反饋，以幫助解決任何技術問題。您無法使用控制檯配置此功能。

API 操作	API 描述
PutFeedback	使您的終端使用者能夠提供其 Amazon Q 商業版生成的聊天回覆的反饋。

列印頁面