AVB/bedrock-access-gateway
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Aiden Dai
2024-04-08 13:30:46 +08:00
parent 008848968d
commit 1888fa1c98
2 changed files with 26 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -17,9 +17,11 @@ If you find this GitHub repository useful, please consider giving it a free star
- [x] Support streaming response via server-sent events (SSE) - [x] Support streaming response via server-sent events (SSE)
- [x] Support Model APIs - [x] Support Model APIs
- [x] Support Chat Completion APIs - [x] Support Chat Completion APIs
- [x] Support Function Call/Tool Call (**beta**) - [x] Support Tool Call (**new**)
- [x] Support Embedding APIs (**beta**) - [x] Support Embedding API (**new**)
- [x] Support Multimodal API (**beta**) - [x] Support Multimodal API (**new**)
Please check [Usage Guide](./docs/Usage.md) for more details about how to use the new APIs.
> **Note:** The legacy [text completion](https://platform.openai.com/docs/api-reference/completions) API is not supported, you should change to use chat completion API. > **Note:** The legacy [text completion](https://platform.openai.com/docs/api-reference/completions) API is not supported, you should change to use chat completion API.
@@ -146,6 +148,8 @@ completion = client.chat.completions.create(
print(completion.choices[0].message.content) print(completion.choices[0].message.content)
``` ```
Please check [Usage Guide](./docs/Usage.md) for more details about how to use embedding API, multimodal API and tool call.
## Other Examples ## Other Examples
### AutoGen ### AutoGen
@@ -200,11 +204,12 @@ Short answer is that API Gateway does not support server-sent events (SSE) for s
This solution only supports the regions where Amazon Bedrock is available: This solution only supports the regions where Amazon Bedrock is available:
- US East (N. Virginia) - US East (N. Virginia): us-east-1
- US West (Oregon) - US West (Oregon): us-west-2
- Asia Pacific (Singapore) - Asia Pacific (Singapore): ap-southeast-1
- Asia Pacific (Tokyo) - Asia Pacific (Tokyo): ap-northeast-1
- Europe (Frankfurt) - Europe (Frankfurt): eu-central-1
- Europe (Paris): eu-west-3
Note that not all models are available in those regions. Note that not all models are available in those regions.

21
README_CN.md
View File

@@ -19,9 +19,11 @@ OpenAI 的 API 或 SDK 无缝集成并试用 Amazon Bedrock 的模型,而无需
- [x] 支持 server-sent events (SSE)的流式响应 - [x] 支持 server-sent events (SSE)的流式响应
- [x] 支持 Model APIs - [x] 支持 Model APIs
- [x] 支持 Chat Completion APIs - [x] 支持 Chat Completion APIs
- [x] 支持 Function Call/Tool Call (**beta**) - [x] 支持 Tool Call (**new**)
- [x] 支持 Embedding APIs (**beta**) - [x] 支持 Embedding API (**new**)
- [x] 支持 Multimodal APIs (**beta**) - [x] 支持 Multimodal API (**new**)
请查看[使用指南](./docs/Usage_CN.md)以获取有关如何使用新API的更多详细信息。
> 注意： 不支持旧的 [text completion](https://platform.openai.com/docs/api-reference/completions) API，请更改为使用Chat Completion API。 > 注意： 不支持旧的 [text completion](https://platform.openai.com/docs/api-reference/completions) API，请更改为使用Chat Completion API。
@@ -151,6 +153,8 @@ completion = client.chat.completions.create(
print(completion.choices[0].message.content) print(completion.choices[0].message.content)
``` ```
请查看[使用指南](./docs/Usage_CN.md)以获取有关如何使用Embedding API、多模态API和Tool Call的更多详细信息。
## 其他例子 ## 其他例子
### AutoGen ### AutoGen
@@ -205,11 +209,12 @@ print(response)
只支持Amazon Bedrock可用的区域,即: 只支持Amazon Bedrock可用的区域,即:
- 美国东部(弗吉尼亚北部) - 美国东部(弗吉尼亚北部)：us-east-1
- 美国西部(俄勒冈州) - 美国西部(俄勒冈州)：us-west-2
- 亚太地区(新加坡) - 亚太地区(新加坡)：ap-southeast-1
- 亚太地区(东京) - 亚太地区(东京)：ap-northeast-1
- 欧洲(法兰克福) - 欧洲(法兰克福)：eu-central-1
- 欧洲(巴黎)：eu-west-3
注意，并非所有模型都在上面区可用。 注意，并非所有模型都在上面区可用。