Amazon Q 企業版 - 支援的操作

Amazon Q 企業版 API 參考提供了各種可用於與 Amazon Q 企業版互動的操作。這些操作包括建立應用程式、刪除應用程式、建立外掛、建立檢索器、上傳文件等。

Q 企業版支援的操作

Q 企業版支援以下操作：

• BatchDeleteDocument：用於刪除之前使用 BatchPutDocument API 新增到 Amazon Q 企業版索引中的一個或多個文件，而不會中斷其他任務。
• BatchPutDocument：用於將儲存在 Amazon S3 儲存桶中的結構化和非結構化文件以及文件匯入到 Amazon Q 企業版索引中，還可以新增自定義屬性併為文件附加訪問控制列表。
• Chat：用於啟動或繼續流式 Amazon Q 企業版對話。
• ChatSync：用於啟動或繼續非流式 Amazon Q 企業版對話。
• CreateApplication：用於建立一個 Amazon Q 企業版應用程式。
• CreateDataSource：用於為 Amazon Q 企業版應用程式建立一個數據源聯結器。
• CreateIndex：用於建立一個 Amazon Q 企業版索引。
• CreatePlugin：用於建立一個 Amazon Q 企業版外掛。
• CreateRetriever：用於向您的 Amazon Q 企業版應用程式新增檢索器。
• CreateUser：用於建立一個與應用程式內本地使用者 ID 列表對映的通用唯一識別符號 (UUID)。
• CreateWebExperience：用於建立一個 Amazon Q 企業版 Web 體驗。
• DeleteApplication：用於刪除一個 Amazon Q 企業版應用程式。
• DeleteChatControlsConfiguration：用於刪除為現有 Amazon Q 企業版應用程式配置的聊天控制元件。
• DeleteConversation：用於刪除一個 Amazon Q 企業版 Web 體驗對話。
• DeleteDataSource：用於刪除一個 Amazon Q 企業版資料來源聯結器。
• DeleteGroup：用於刪除組，不再允許它們訪問資源。
• DeleteIndex：用於刪除一個 Amazon Q 企業版索引。
• DeletePlugin：用於刪除一個 Amazon Q 企業版外掛。
• DeleteRetriever：用於刪除 Amazon Q 企業版應用程式使用的檢索器。
• DeleteUser：用於透過電子郵件 ID 刪除使用者。
• DeleteWebExperience：用於刪除一個 Amazon Q 企業版 Web 體驗。
• GetApplication：用於獲取有關現有 Amazon Q 企業版應用程式的資訊。
• GetChatControlsConfiguration：用於獲取有關為現有 Amazon Q 企業版應用程式配置的聊天控制元件的資訊。
• GetDataSource：用於獲取有關現有 Amazon Q 企業版資料來源聯結器的資訊。
• GetGroup：用於按組名描述組。
• GetIndex：用於獲取有關現有 Amazon Q 企業版索引的資訊。
• GetPlugin：用於獲取有關現有 Amazon Q 企業版外掛的資訊。
• GetRetriever：用於獲取有關 Amazon Q 企業版應用程式使用的現有檢索器的資訊。
• GetUser：用於描述與資料來源中本地使用者關聯的通用唯一識別符號 (UUID)。
• GetWebExperience：用於獲取有關現有 Amazon Q 企業版 Web 體驗的資訊。
• ListApplications：用於列出 Amazon Q 企業版應用程式。
• ListConversations：用於列出一個或多個 Amazon Q 企業版對話。
• ListDataSources：用於列出您建立的 Amazon Q 企業版資料來源聯結器。
• ListDataSourceSyncJobs：用於獲取有關 Amazon Q 企業版資料來源聯結器同步的資訊。
• ListDocuments：是附加到索引的文件列表。
• ListGroups：是對映到使用者的組列表。
• ListIndices：是您建立的 Amazon Q 企業版索引列表。
• ListMessages：用於獲取與 Amazon Q 企業版 Web 體驗關聯的訊息列表。
• ListPlugins：是已配置的 Amazon Q 企業版外掛列表。
• ListRetrievers：是 Amazon Q 企業版應用程式使用的檢索器列表。
• ListTagsForResource：用於獲取與指定資源關聯的標籤列表。
• ListWebExperiences：用於列出一個或多個 Amazon Q 企業版 Web 體驗。
• PutFeedback：使您的終端使用者能夠對他們生成的 Amazon Q 企業版聊天回覆提供反饋。
• PutGroup：用於建立、更新和對映有權訪問文件的使用者到組。
• StartDataSourceSyncJob：用於啟動資料來源聯結器同步作業。
• StopDataSourceSyncJob：用於停止正在進行的 Amazon Q 企業版資料來源聯結器同步作業。
• TagResource：用於向指定的 Amazon Q 企業版應用程式或資料來源資源新增指定的標籤。如果標籤已存在，則現有值將被新值替換。
• UntagResource：用於從 Amazon Q 企業版應用程式或資料來源中刪除標籤。
• UpdateApplication：用於更新現有的 Amazon Q 企業版應用程式。
• UpdateChatControlsConfiguration：用於更新為現有 Amazon Q 企業版應用程式配置的一組聊天控制元件。
• UpdateDataSource：用於更新現有的 Amazon Q 企業版資料來源聯結器。
• UpdateIndex：用於更新 Amazon Q 企業版索引。
• UpdatePlugin：用於更新 Amazon Q 企業版外掛。
• UpdateRetriever：用於更新您的 Amazon Q 企業版應用程式使用的檢索器。
• UpdateUser：用於更新與使用者 ID 關聯的資訊。
• UpdateWebExperience：用於更新 Amazon Q 企業版 Web 體驗。

QApps 支援的操作

QApps 支援以下操作：

• AssociateLibraryItemReview：用於將庫專案的評級或評論與提交請求的使用者關聯。
• AssociateQAppWithUser：用於在呼叫操作的使用者身份和特定 Q App 之間建立連結。
• CreateLibraryItem：用於為 Amazon Q App 建立新的庫專案。
• CreateQApp：用於根據提供的定義建立新的 Amazon Q App。
• DeleteLibraryItem：用於刪除 Amazon Q App 的庫專案，將其從庫中刪除，以便其他使用者無法再發現或使用它。
• DeleteQApp：用於刪除使用者擁有的 Amazon Q App。
• DisassociateLibraryItemReview：用於刪除使用者之前為庫專案提交的評級或評論。
• DisassociateQAppFromUser：用於將 Q App 與使用者分離，從而取消使用者執行 Q App 的訪問許可權。
• GetLibraryItem：用於檢索有關 Amazon Q App 庫專案詳細資訊，包括其元資料、類別、評級和使用統計資訊。
• GetQApp：用於檢索 Q App 的完整詳細資訊，包括指定卡片和流程的定義。
• GetQAppSession：用於檢索 Amazon Q App 活動會話的當前狀態和結果。
• ImportDocument：用於上傳檔案以在 Q App 中使用，可以作為預設檔案或在單個執行中使用。
• ListLibraryItems：用於列出已釋出並可供您 AWS 帳戶中的使用者使用的 Amazon Q Apps 庫專案。
• ListQApps：用於列出您擁有或使用過的 Q Apps。
• ListTagsForResource：用於列出與 Amazon Q Apps 資源關聯的標籤。
• PredictQApp：用於根據對話或問題陳述建立 Q App 定義。此定義可用於稍後建立 Q App。
• StartQAppSession：用於為 Amazon Q App 啟動新的會話，允許提供輸入並執行應用程式。
• StopQAppSession：用於停止 Amazon Q App 的活動會話。
• TagResource：用於將標籤與 Amazon Q Apps 資源關聯。
• UntagResource：用於將標籤與 Amazon Q Apps 資源分離。
• UpdateLibraryItem：用於更新 Amazon Q App 的庫專案。
• UpdateLibraryItemMetadata：用於更新 Amazon Q App 庫專案的驗證狀態。
• UpdateQApp：用於更新現有的 Amazon Q App，允許修改其標題、說明和定義。
• UpdateQAppSession：用於更新給定 Q App sessionId 的會話。