使用 Amazon Bedrock API 金鑰 - Amazon Bedrock

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 Amazon Bedrock API 金鑰

您可以透過下列方式使用您的 Amazon Bedrock API 金鑰：

  • 將其設定為環境變數 – Amazon Bedrock 服務可識別環境變數 AWS_BEARER_TOKEN_BEDROCK，您有下列選項可設定金鑰：

    • 開啟終端機進行設定：

      • MacOS/Linux

        export AWS_BEARER_TOKEN_BEDROCK=${api-key}

      • Windows：

        setx AWS_BEARER_TOKEN_BEDROCK "${api-key}"

    • 在提出 API 請求之前，在程式碼中將其設定為環境變數。例如，您可以在提出請求之前新增下列幾行：

      • Python

        import os                      
os.environ['AWS_BEARER_TOKEN_BEDROCK'] = "${api-key}"

  • 在請求中指定 – 您可以使用下列方式，在授權標頭中包含 Amazon Bedrock API 金鑰 (以實際值取代 $AWS_BEARER_TOKEN_BEDROCK)：

    • 在直接 HTTP 請求中 – 包含下列項目做為授權標頭：

      Authorization: Bearer $AWS_BEARER_TOKEN_BEDROCK

    • 作為支援 SDK 中的參數 – 設定用戶端時，在參數中指定值。例如，使用 OpenAI Python SDK 設定用戶端時，您可以在 api_key 欄位中指定它。

注意

Amazon Bedrock API 金鑰僅限於 Amazon Bedrock 和 Amazon Bedrock 執行時期動作。您不能將它們用於以下 API 操作：

若要查看使用 API 金鑰傳送 Converse 請求以產生回應的範例，請選擇您偏好方法的索引標籤，然後遵循以下步驟：

Python

下列範例顯示如何使用 適用於 Python (Boto3) 的 AWS SDK 傳送 API 請求。如果您尚未將 API 金鑰設定為 AWS_BEARER_TOKEN_BEDROCK 環境變數，請在下列程式碼中指定它來取代 ${api-key}：

import os
import boto3
                        
# If you already set the API key as an environment variable, you can comment this line out                        
os.environ['AWS_BEARER_TOKEN_BEDROCK'] = "${api-key}"

# Create an Amazon Bedrock client
client = boto3.client(
    service_name="bedrock-runtime",
    region_name="us-east-1" # If you've configured a default region, you can omit this line
)

# Define the model and message
model_id = "us.anthropic.claude-3-5-haiku-20241022-v1:0"
messages = [{"role": "user", "content": [{"text": "Hello"}]}]

response = client.converse(
    modelId=model_id,
    messages=messages,
)
HTTP Client (requests package in Python)

先決條件：開啟終端機並執行下列命令來安裝 requests 套件：

python3 -m pip install requests

下列範例示範如何使用 HTTP 用戶端直接傳送 API 請求。在標頭中指定 ${api-key}。

import requests

url = "https://bedrock-runtime.us-east-1.amazonaws.com/model/us.anthropic.claude-3-5-haiku-20241022-v1:0/converse"

payload = {
    "messages": [
        {
            "role": "user",
            "content": [{"text": "Hello"}]
        }
    ]
}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer ${api-key}"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)
HTTP request using cURL

下列範例示範如何使用 cURL 直接傳送 API 請求。如果您未將 API 金鑰設定為 AWS_BEARER_TOKEN_BEDROCK 環境變數，則必須將範例中的 $AWS_BEARER_TOKEN_BEDROCK 取代為金鑰的常值。

curl -X POST "https://bedrock-runtime.us-east-1.amazonaws.com/model/us.anthropic.claude-3-5-haiku-20241022-v1:0/converse" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $AWS_BEARER_TOKEN_BEDROCK" \
  -d '{
    "messages": [
        {
            "role": "user",
            "content": [{"text": "Hello"}]
        }
    ]
  }'