Use uma chave de API Amazon Bedrock

Você pode usar sua chave de API Amazon Bedrock das seguintes formas:

• Defina-o como variável de ambiente — O serviço Amazon Bedrock reconhece a variável de ambiente. AWS_BEARER_TOKEN_BEDROCK Você tem as seguintes opções para definir a chave:

  • Abra um terminal para configurá-lo:

    • macOS/Linux

      export AWS_BEARER_TOKEN_BEDROCK=${api-key}

    • Windows

      setx AWS_BEARER_TOKEN_BEDROCK "${api-key}"

  • Defina-a como uma variável de ambiente em seu código antes de fazer a solicitação da API. Por exemplo, você pode incluir as seguintes linhas antes de fazer a solicitação:

    • Python

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

• Especifique em uma solicitação — Você pode incluir a chave da API Amazon Bedrock no cabeçalho de autorização das seguintes formas ($AWS_BEARER_TOKEN_BEDROCKsubstitua pelo valor real):

  • Em uma solicitação HTTP direta — inclua o seguinte como cabeçalho de autorização:

    Authorization: Bearer $AWS_BEARER_TOKEN_BEDROCK

  • Como parâmetro em um SDK compatível — especifique o valor no parâmetro ao configurar o cliente. Por exemplo, você pode especificá-la no api_key campo ao configurar um cliente com o SDK do OpenAIPython.

nota

As chaves de API do Amazon Bedrock estão limitadas às ações do Amazon Bedrock e do Amazon Bedrock Runtime. Você não pode usá-los com as seguintes operações de API:

• InvokeModelWithBidirectionalStream.

• Agentes para o Amazon Bedrock ou Agentes para operações da API Amazon Bedrock Runtime.

• Automação de dados para Amazon Bedrock ou Runtime para operações da API Amazon Bedrock Data Automation.

Para ver um exemplo de uso da chave de API para enviar uma solicitação Converse para gerar uma resposta, escolha a guia do seu método preferido e siga as etapas:

Python

O exemplo a seguir mostra como enviar uma solicitação de API com AWS SDK para Python (Boto3) o. Se você ainda não definiu a chave de API como variável de AWS_BEARER_TOKEN_BEDROCK ambiente, especifique-a no lugar de ${api-key} no código a seguir:

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)

Pré-requisito: instale o requests pacote abrindo um terminal e executando o seguinte comando:

python3 -m pip install requests

O exemplo a seguir mostra como enviar diretamente uma solicitação de API com um cliente HTTP. Especifique o ${api-key} no cabeçalho.

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

O exemplo a seguir mostra como enviar diretamente uma solicitação de API usando cURL. Se você não definiu a chave da API como variável de AWS_BEARER_TOKEN_BEDROCK ambiente, precisará substituí-la $AWS_BEARER_TOKEN_BEDROCK no exemplo pelo valor literal da chave.

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"}]
        }
    ]
  }'