Update usage guide for deepseek-r1
This commit is contained in:
Aiden Dai
@@ -9,6 +9,13 @@ export OPENAI_API_KEY=<API key>
|
||||
export OPENAI_BASE_URL=<API base url>
|
||||
```
|
||||
|
||||
**API Example:**
|
||||
- [Models API](#models-api)
|
||||
- [Embedding API](#embedding-api)
|
||||
- [Multimodal API](#multimodal-api)
|
||||
- [Tool Call](#tool-call)
|
||||
- [Reasoning](#reasoning)
|
||||
|
||||
## Models API
|
||||
|
||||
You can use this API to get a list of supported model IDs.
|
||||
@@ -125,10 +132,6 @@ print(doc_result[0][:5])
|
||||
|
||||
## Multimodal API
|
||||
|
||||
**Important Notice**: Please carefully review the following points before using this proxy API for Multimodal.
|
||||
|
||||
1. This API is only supported by Claude 3 model.
|
||||
|
||||
**Example Request**
|
||||
|
||||
```bash
|
||||
@@ -219,7 +222,6 @@ curl $OPENAI_BASE_URL/chat/completions \
|
||||
**Important Notice**: Please carefully review the following points before using this Tool Call for Chat completion API.
|
||||
|
||||
1. Function Call is now deprecated in favor of Tool Call by OpenAI, hence it's not supported here, you should use Tool Call instead.
|
||||
2. This API is only supported by Claude 3 model.
|
||||
|
||||
**Example Request**
|
||||
|
||||
@@ -322,10 +324,10 @@ You can try it with different questions, such as:
|
||||
## Reasoning
|
||||
|
||||
**Important Notice**: Please carefully review the following points before using reasoning mode for Chat completion API.
|
||||
- The only model supports Reasoning is Claude 3.7 Sonnet (extended thinking) so far. Please make sure the model supports reasoning.
|
||||
- The reasoning mode (or thinking mode) is not enabled by default, you must pass additional `reasoning_effort` parameter in your request.
|
||||
- Only Claude 3.7 Sonnet (extended thinking) and DeepSeek R1 support Reasoning so far. Please make sure the model supports reasoning before use.
|
||||
- For Claude 3.7 Sonnet, the reasoning mode (or thinking mode) is not enabled by default, you must pass additional `reasoning_effort` parameter in your request. Please also provide the right max_tokens (or max_completion_tokens) in your request. The budget_tokens is based on reasoning_effort (low: 30%, medium: 60%, high: 100% of max tokens), ensuring minimum budget_tokens of 1,024 with Anthropic recommending at least 4,000 tokens for comprehensive reasoning. Check [Bedrock Document](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-anthropic-claude-37.html) for more details.
|
||||
- For DeepSeek R1, you don't need additional reasoning_effort parameter, otherwise, you may get an error.
|
||||
- The reasoning response (CoT, thoughts) is added in an additional tag 'reasoning_content' which is not officially supported by OpenAI. This is to follow [Deepseek Reasoning Model](https://api-docs.deepseek.com/guides/reasoning_model#api-example). This may be changed in the future.
|
||||
- Please provide the right max_tokens (or max_completion_tokens) in your request. The budget_tokens is based on reasoning_effort (low: 30%, medium: 60%, high: 100% of max tokens), ensuring minimum budget_tokens of 1,024 with Anthropic recommending at least 4,000 tokens for comprehensive reasoning. Check [Bedrock Document](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-anthropic-claude-37.html) for more details.
|
||||
|
||||
**Example Request**
|
||||
|
||||
@@ -417,6 +419,6 @@ content = ""
|
||||
for chunk in response:
|
||||
if hasattr(chunk.choices[0].delta, 'reasoning_content') and chunk.choices[0].delta.reasoning_content:
|
||||
reasoning_content += chunk.choices[0].delta.reasoning_content
|
||||
elif hasattr(chunk.choices[0].delta, 'content') and chunk.choices[0].delta.content:
|
||||
elif chunk.choices[0].delta.content:
|
||||
content += chunk.choices[0].delta.content
|
||||
```
|
||||
@@ -9,6 +9,13 @@ export OPENAI_API_KEY=<API key>
|
||||
export OPENAI_BASE_URL=<API base url>
|
||||
```
|
||||
|
||||
**API 示例:**
|
||||
- [Models API](#models-api)
|
||||
- [Embedding API](#embedding-api)
|
||||
- [Multimodal API](#multimodal-api)
|
||||
- [Tool Call](#tool-call)
|
||||
- [Reasoning](#reasoning)
|
||||
|
||||
## Models API
|
||||
|
||||
你可以通过这个API 获取支持的models 列表。 另外，如果Amazon Bedrock有新模型加入后，你也可以用它来更新刷新模型列表。
|
||||
@@ -122,10 +129,6 @@ print(doc_result[0][:5])
|
||||
|
||||
## Multimodal API
|
||||
|
||||
**重要**:在使用此代理API进行多模态处理之前,请仔细阅读以下几点:
|
||||
|
||||
1. 此API 仅支持Claude 3模型。
|
||||
|
||||
**Request 示例**
|
||||
|
||||
```bash
|
||||
@@ -216,7 +219,6 @@ curl $OPENAI_BASE_URL/chat/completions \
|
||||
**重要**:在使用此代理API进行Tool Call之前,请仔细阅读以下几点:
|
||||
|
||||
1. OpenAI 已经废弃使用Function Call,而推荐使用Tool Call,因此Function Call在此处不受支持,您应该改为Tool Call。
|
||||
1. 此API 仅支持Claude 3模型。
|
||||
|
||||
**Request 示例**
|
||||
|
||||
@@ -320,10 +322,10 @@ You can try it with different questions, such as:
|
||||
|
||||
**重要**: 使用此 reasoning 推理模式前，请仔细阅读以下要点。
|
||||
|
||||
- 目前仅 Claude 3.7 Sonnet 模型支持推理功能。使用前请确保所用模型支持推理。
|
||||
- 推理模式（或思考模式）默认未启用，您必须在请求中传递额外的 reasoning_effort 参数，参数值可选:low，medium, high
|
||||
- 目前仅 Claude 3.7 Sonnet / Deepseek R1 模型支持推理功能。使用前请确保所用模型支持推理。
|
||||
- Claude 3.7 Sonnet 推理模式（或思考模式）默认未启用，您必须在请求中传递额外的 reasoning_effort 参数，参数值可选:low，medium, high。另外，请在请求中提供正确的 max_tokens（或 max_completion_tokens）参数。budget_tokens 基于 reasoning_effort 设置（低：30%，中：60%，高：100% 的max tokens），确保最小 budget_tokens 为 1,024，Anthropic 建议至少使用 4,000 个令牌以获得全面的推理。详情请参阅 [Bedrock Document](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-anthropic-claude-37.html)。
|
||||
- Deepseek R1 会自动使用推理模式，不需要在中传递额外的 reasoning_effort 参数（否则会报错）
|
||||
- 推理结果（思维链结果、思考过程）被添加到名为 'reasoning_content' 的额外标签中，这不是 OpenAI 官方支持的格式。此设计遵循 [Deepseek Reasoning Model](https://api-docs.deepseek.com/guides/reasoning_model#api-example) 的规范。未来可能会有所变动。
|
||||
- 请在请求中提供正确的 max_tokens（或 max_completion_tokens）参数。budget_tokens 基于 reasoning_effort 设置（低：30%，中：60%，高：100% 的max tokens），确保最小 budget_tokens 为 1,024，Anthropic 建议至少使用 4,000 个令牌以获得全面的推理。详情请参阅 [Bedrock Document](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters-anthropic-claude-37.html)。
|
||||
|
||||
**Request 示例**
|
||||
|
||||
@@ -416,6 +418,6 @@ content = ""
|
||||
for chunk in response:
|
||||
if hasattr(chunk.choices[0].delta, 'reasoning_content') and chunk.choices[0].delta.reasoning_content:
|
||||
reasoning_content += chunk.choices[0].delta.reasoning_content
|
||||
elif hasattr(chunk.choices[0].delta, 'content') and chunk.choices[0].delta.content:
|
||||
elif chunk.choices[0].delta.content:
|
||||
content += chunk.choices[0].delta.content
|
||||
```
|
||||
Reference in New Issue
Block a user