- Amazon Q 教程
- Amazon Q - 首頁
- Amazon Q - 簡介
- Amazon Q 商業使用者指南
- Amazon Q 商業 - 工作流程
- Amazon Q 商業 - 關鍵概念
- Amazon Q 商業 - 訂閱層級和索引型別
- Amazon Q 商業 - 服務配額
- Amazon Q 商業 - 文件屬性
- Amazon Q 商業 - 設定
- Amazon Q 商業 - Identity Center 目錄
- Amazon Q 商業 - Identity Center 整合應用程式
- Amazon Q 商業 - Identity Federation 應用程式
- Amazon Q 商業 - 資料來源聯結器
- Amazon Q 商業 - 增強應用程式
- Amazon Q 商業 - 功能
- Amazon Q 商業 - 安全性
- Amazon Q 商業 - 監控
- Amazon Q 商業 API 參考
- Amazon Q 商業 - API 概述
- Amazon Q 商業 - API 參考
- Amazon Q 商業 - 支援的操作
- Amazon Q 商業 - 支援的資料型別
- Amazon Q 商業 - 常用引數
- Amazon Q 商業 - 常用錯誤
Amazon Q 開發者 - 自定義
Amazon Q 自定義是一組允許 Amazon Q 根據您公司程式碼庫提供建議的元素。您將資料來源與程式碼庫連線起來,Amazon Q 使用此內容提供針對您組織開發風格的幫助。
先決條件
要使用 Amazon Q 自定義,請按照 Amazon Q Developer Pro 設定流程進行操作,包括將需要訪問自定義的使用者新增到您的配置檔案中。
授權您的管理員
要使用 Amazon Q 自定義,您的 Amazon Q 管理員需要訪問您的程式碼庫,這些程式碼庫儲存在 Amazon S3 上或透過 AWS CodeConnections。但是,在標準 Amazon Q Developer Pro 設定過程中,您的 AWS Organizations 管理員不會授予對這些服務的訪問許可權。
因此,在使用 Amazon Q 自定義之前,您必須將以下許可權新增到 Amazon Q 管理員的角色中
{
"Version": "2012-10-17",
"Statement": [{
"Effect": "Allow",
"Action": [
"sso-directory:DescribeUsers"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"codewhisperer:CreateCustomization",
"codewhisperer:DeleteCustomization",
"codewhisperer:ListCustomizations",
"codewhisperer:UpdateCustomization",
"codewhisperer:GetCustomization",
"codewhisperer:ListCustomizationPermissions",
"codewhisperer:AssociateCustomizationPermission",
"codewhisperer:DisassociateCustomizationPermission"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"codeconnections:ListConnections",
"codeconnections:ListOwners",
"codeconnections:ListRepositories",
"codeconnections:GetConnection"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": "codeconnections:UseConnection",
"Resource": "*",
"Condition": {
"ForAnyValue:StringEquals": {
"codeconnections:ProviderAction": [
"GitPull",
"ListRepositories",
"ListOwners"
]
}
}
},
{
"Effect": "Allow",
"Action": [
"s3:GetObject*",
"s3:GetBucket*",
"s3:ListBucket*"
],
"Resource": [
"*"
]
}
]
}
準備您的資料
以下是在為 Amazon Q 自定義準備資料來源時需要牢記的關鍵概念
- 新增團隊鼓勵的模式程式碼。
- 避免包含錯誤、安全漏洞、效能問題等的程式碼。
- 確保資料來源包含至少 2 MB 至多 20 GB 的原始碼檔案。
- 大於 10 MB 的檔案將被忽略。
- 對於您希望自定義支援的每種語言,至少包含 10 個檔案。
- 將原始碼放在目錄中,而不是在 Amazon S3 資料來源的根級別。
Amazon Q 自定義支援以下語言和副檔名
- Java (.java)
- JavaScript (.js, .jsx)
- Python (.py)
- TypeScript (.ts, .tsx)
在聊天中啟用自定義
要在聊天中啟用自定義,請使用以下步驟。
- 轉到 Amazon Q Developer 控制檯。
- 在導航面板中,選擇“**設定**”。
- 選擇“**檢視設定**”。
- 在“**詳細資訊**”下,選擇“**編輯**”。
- 在“**高階設定**”下,選中“**啟用聊天自定義功能**”旁邊的複選框。
- 選擇“**儲存更改**”。
建立您的自定義
要建立您的自定義,請按照以下步驟操作
- 要設定 Amazon Q Developer Pro,請啟用 IAM Identity Center,授權管理員訪問 Amazon Q Developer 以及啟用 Amazon Q Developer 控制檯。
- 開啟 Amazon Q Developer 控制檯。
- 從左側的導航窗格中,選擇“**自定義**”。
- 將顯示自定義頁面。
- 選擇“**建立自定義**”。
- 輸入自定義名稱和(可選)描述。
連線到您的資料來源
要透過 CodeConnections 連線到您的資料來源,請按照以下步驟操作
- 在“**連線到源提供程式**”下,選擇 CodeConnections。
- 如果您使用的是現有連線,請選擇“**選擇現有連線**”。然後,在“**選擇連線**”下,從下拉列表中選擇您的連線。否則,請選擇“**建立新連線**”。
- 在彈出的視窗中,導航到您的資料來源並按照控制檯中的說明操作。
- 建立資料來源後,返回“**建立自定義**”頁面。
- 在“**選擇連線**”下,從下拉列表中選擇您的連線。
要連線到您透過 Amazon S3 的資料來源,請按照以下步驟操作
- 在“**連線到源提供程式**”下,選擇 Amazon S3。
- 選擇“**瀏覽 Amazon S3**”。
- 導航到包含程式碼庫的儲存桶或資料夾,並記下 URI。
- 將 URL 貼上到標記為“輸入**Amazon S3 URI**”的欄位中。
自定義建立問題
您可以透過以下提到的方式解決以下錯誤
- 您可能會收到錯誤:“提供的儲存庫的總大小超過了自定義允許的最大大小”。在這種情況下,從資料來源中刪除一個儲存庫,然後重試。
- 您可能會收到錯誤:“資料不足以建立自定義。新增更多來自支援語言的檔案並重試”。如果收到此錯誤,請新增更多包含自定義重點程式語言的檔案,然後重試。
刪除您的自定義
要刪除您的自定義,請按照以下步驟操作
- 開啟 Amazon Q Developer 控制檯。
- 從左側的導航窗格中,選擇“**自定義**”。
- 將顯示自定義頁面。
- 如果要刪除的自定義仍在活動狀態,請選擇“**停用**”。
- 選擇“**刪除**”。
評估您的自定義
要評估您的自定義,請按照以下步驟操作
- 在 Amazon Q Developer 控制檯中,從導航面板中,選擇“**自定義**”。
- 選擇要檢查的自定義的名稱。
- 視窗右側的評估分數顯示了 Amazon Q 評估的自定義可能有效性。
最佳化您的自定義
要最佳化您的自定義,請按照以下步驟操作
- 考慮擴充套件資料來源以包含更多程式碼儲存庫。
- 如果您主要包含來自有限語言的資料,請考慮擴充套件到更多程式語言。
- 刪除自動生成的檔案和儲存庫,或從模板生成的那些檔案,因為它們會增加噪音,並且對於訓練自定義沒有價值。
- 如果您的程式碼庫很少使用內部庫,則核心 Amazon Q 模型可能已經表現最佳。
日誌記錄和故障排除
Amazon Q 可以為您提供日誌檔案,幫助您瞭解和解決自定義問題。
設定日誌交付
要設定日誌交付,請在自定義的控制檯頁面上選擇“日誌交付”選項卡。按照介面中的說明配置日誌交付。然後選擇“**建立日誌交付**”。
交付到 Amazon S3 儲存桶的日誌字首將為
AWSLogs/account_id/codeWhispererCustomizationLogs/region/customization_id/year/month/day/hour/
檔案將被壓縮,命名格式為
account_id_codeWhispererCustomizationLogs_customization_id_date_file_id.log.gz
解釋自定義日誌
下表列出了可能有助於您瞭解自定義問題的日誌訊息。
| 日誌訊息 | 日誌級別 |
|---|---|
| 開始從源 source 中提取 number 個儲存庫 | 資訊 |
| 從儲存庫下載資料:儲存庫名稱 | 資訊 |
| 已收到 amount MB 的支援資料。需要 amount MB。新增更多資料並重試。 | 錯誤 |
| 提供的 CodeStar Connection ARN:Arn 無效。 | 錯誤 |
| 嘗試訪問提供的 CodeStar Connection 時拒絕訪問:Arn | 錯誤 |
| 使用 AWS CodeStar Connection 失敗:Arn 可能已被客戶刪除 | 錯誤 |
| 克隆儲存庫時來自 CodeStar Connection 的 ProviderThrottlingException:Arn:repository | 錯誤 |
| 處理來自 S3 的資料:S3 URI | 資訊 |
| 指定的 S3 路徑無效:S3 目錄 | 錯誤 |
| 無法訪問提供的 S3 儲存桶:儲存桶名稱 | 錯誤 |
| 提供的 S3 儲存桶:儲存桶名稱不存在。 | 錯誤 |
| 提供的 S3 金鑰 S3 URI 不存在。 | 錯誤 |
自定義錯誤訊息
下表將幫助您瞭解 Amazon Q 控制檯中的自定義相關訊息。
| 錯誤訊息 | 建議的操作 |
|---|---|
| 您已激活了最大數量的自定義。 | 停用一個活動的自定義並重試。 |
| 您已超過了組許可權限制的最大數量 limit。 | 刪除一個組並重試。 |
| 您已超過了使用者許可權限制的最大數量 limit。 | 刪除一個使用者並重試。 |
| 已達到最大活動作業數。 | 等待同一帳戶中正在進行的作業完成。重試操作。 |
| 處理請求時遇到意外錯誤。 | 重試操作。如果繼續失敗,請聯絡客戶支援。 |
| 使用 AWS CodeStar Connection 失敗:Arn 可能已被客戶刪除 | 嘗試訪問提供的 AWS CodeConnections 連線時拒絕訪問。 |
| 嘗試訪問提供的 AWS CodeConnections 連線時拒絕訪問 | 驗證連線和第三方提供商上的許可權。然後重試操作。 |
| 訪問提供的 AWS CodeConnections 連線時未找到一個或多個儲存庫。 | 驗證第三方提供商的許可權和儲存庫列表。然後重試操作。 |
| 提供的 AWS CodeConnections 連線 ARN 無效。 | 使用更正後的連線 ARN 更新自定義。 |
| 與提供的 AWS CodeConnections 連線關聯的主機不可用。 | 5 分鐘後重試。 |
| 指定的 Amazon S3 路徑無效。 | 使用有效的 Amazon S3 URI 更新自定義。 |
| 無法訪問提供的 Amazon S3 儲存桶。 | 驗證管理員角色的許可權。修復任何許可權問題後重試。 |
啟用您的自定義
要啟用自定義的版本,請按照以下步驟操作
- 開啟 Amazon Q Developer 控制檯。
- 從左側的導航窗格中,選擇“**自定義**”。
- 選擇要為其啟用版本的自定義。
- 從“版本”表中選擇要啟用的版本。
- 選擇“啟用”。
更新您的自定義
要建立自定義的新版本,請按照以下步驟操作
- 開啟 Amazon Q Developer 控制檯。
- 從左側的導航窗格中,選擇“**自定義**”。
- 選擇您想要為其建立新版本的自定義項。
- 從“操作”下拉選單中選擇“建立新版本”。
- 如果適用,請更改資料來源。
- 選擇“建立”。
新增使用者和組
要將使用者和組新增到您的 Amazon Q 自定義項,請按照以下步驟操作
- 在 Amazon Q Developer 控制檯中,從導航面板中,選擇“**自定義**”。
- 選擇您要向其新增使用者或組的自定義項的名稱。
- 在視窗的下半部分,如有必要,選擇“使用者和組”選項卡,然後選擇“使用者”或“組”子選項卡。
- 選擇需要訪問您的自定義項的使用者或組。
- 選擇“新增使用者”或“新增組”。
使用 Amazon Q 自定義項
要將自定義項與 VS Code 配合使用,請按照以下步驟操作
- 使用 IAM Identity Center 認證到 Amazon Q Developer Pro,方法是按照 IDE 中安裝 Amazon Q Developer 擴充套件或外掛下的步驟操作。
- 在“開發人員工具”窗格中,在 Amazon Q 下,選擇“選擇自定義項”。
- 在視窗頂部,從下拉選單中選擇相應的自定義項。
要將自定義項與 JetBrains 配合使用,請按照以下步驟操作
- 使用 IAM Identity Center 認證到 Amazon Q Developer Pro,方法是按照 IDE 中安裝 Amazon Q Developer 擴充套件或外掛下的步驟操作。
- 在“開發人員工具”窗格中,在 Amazon Q 下,選擇“選擇自定義項”。
- 在彈出視窗中,選擇相應的自定義項。
- 選擇“連線”。