AWS bedrock documentation change
Summary
Minor grammatical fixes (a->an) and added documentation about headers in OpenAI SDK configuration. Added explicit comment about replacing API key placeholder.
Security assessment
Changes are grammatical improvements and documentation clarifications. No security vulnerabilities addressed. API key handling remains unchanged except for phrasing.
Diff
diff --git a/bedrock/latest/userguide/inference-chat-completions.md b/bedrock/latest/userguide/inference-chat-completions.md index 661e2ab2b..653c596e7 100644 --- a//bedrock/latest/userguide/inference-chat-completions.md +++ b//bedrock/latest/userguide/inference-chat-completions.md @@ -46 +46 @@ OpenAI SDK - * **Authentication** – The OpenAI SDK only supports authentication with a Amazon Bedrock API key. Generate a Amazon Bedrock API key to authenticate your request. To learn about Amazon Bedrock API keys and how to generate them, see [Generate Amazon Bedrock API keys to easily authenticate to the Amazon Bedrock API](./api-keys.html). + * **Authentication** – The OpenAI SDK only supports authentication with an Amazon Bedrock API key. Generate an Amazon Bedrock API key to authenticate your request. To learn about Amazon Bedrock API keys and how to generate them, see [Generate Amazon Bedrock API keys to easily authenticate to the Amazon Bedrock API](./api-keys.html). @@ -60 +60 @@ HTTP request - * **Authentication** – You can authenticate with either your AWS credentials or with a Amazon Bedrock API key. + * **Authentication** – You can authenticate with either your AWS credentials or with an Amazon Bedrock API key. @@ -62 +62 @@ HTTP request -Set up your AWS credentials or generate a Amazon Bedrock API key to authenticate your request. +Set up your AWS credentials or generate an Amazon Bedrock API key to authenticate your request. @@ -103 +103,3 @@ To create a chat completion with the OpenAI SDK, do the following: - * `api_key` – Specify a Amazon Bedrock API key. + * `api_key` – Specify an Amazon Bedrock API key. + + * `default_headers` – If you need to include any headers, you can include them as key-value pairs in this object. You can alternatively specify headers in the `extra_headers` when making a specific API call. @@ -110 +112 @@ To create a chat completion with the OpenAI SDK, do the following: -The following example calls the Create chat completion API in `us-west-2`. Replace `$AWS_BEARER_TOKEN_BEDROCK` with your actual API key: +The following example calls the Create chat completion API in `us-west-2`. Replace `$AWS_BEARER_TOKEN_BEDROCK` with your actual API key. @@ -117 +119 @@ The following example calls the Create chat completion API in `us-west-2`. Repla - api_key="$AWS_BEARER_TOKEN_BEDROCK" + api_key="$AWS_BEARER_TOKEN_BEDROCK" # Replace with actual API key @@ -145 +147 @@ To create a chat completion with a direct HTTTP request, do the following: - 2. Specify your AWS credentials or a Amazon Bedrock API key in the `Authorization` header. + 2. Specify your AWS credentials or an Amazon Bedrock API key in the `Authorization` header. @@ -152 +154 @@ To create a chat completion with a direct HTTTP request, do the following: -The following example calls the Create chat completion API in `us-west-2`. Replace `$AWS_BEARER_TOKEN_BEDROCK` with your actual API key: +The following example uses curl to call the Create chat completion API in `us-west-2`. Replace `$AWS_BEARER_TOKEN_BEDROCK` with your actual API key: