mirror of
https://github.com/xtekky/gpt4free.git
synced 2025-12-06 02:30:41 -08:00
docs(docs/async_client.md): update guide with Anthropic compatibility and improved chat completions example
This commit is contained in:
parent
ae0b4ca969
commit
30f712779b
1 changed files with 26 additions and 1 deletions
|
|
@ -3,13 +3,14 @@ The G4F async client API is a powerful asynchronous interface for interacting wi
|
||||||
|
|
||||||
|
|
||||||
## Compatibility Note
|
## Compatibility Note
|
||||||
The G4F async client API is designed to be compatible with the OpenAI API, making it easy for developers familiar with OpenAI's interface to transition to G4F.
|
The G4F async client API is designed to be compatible with the OpenAI and Anthropic API, making it easy for developers familiar with OpenAI's or Anthropic's interface to transition to G4F.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
- [Introduction](#introduction)
|
- [Introduction](#introduction)
|
||||||
- [Key Features](#key-features)
|
- [Key Features](#key-features)
|
||||||
- [Getting Started](#getting-started)
|
- [Getting Started](#getting-started)
|
||||||
- [Initializing the Client](#initializing-the-client)
|
- [Initializing the Client](#initializing-the-client)
|
||||||
|
- [Creating Chat Completions](#creating-chat-completions)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Usage Examples](#usage-examples)
|
- [Usage Examples](#usage-examples)
|
||||||
- [Text Completions](#text-completions)
|
- [Text Completions](#text-completions)
|
||||||
|
|
@ -51,6 +52,30 @@ client = Client(
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Creating Chat Completions
|
||||||
|
**Here’s an improved example of creating chat completions:**
|
||||||
|
```python
|
||||||
|
response = await async_client.chat.completions.create(
|
||||||
|
system="You are a helpful assistant.",
|
||||||
|
model="gpt-3.5-turbo",
|
||||||
|
messages=[
|
||||||
|
{
|
||||||
|
"role": "user",
|
||||||
|
"content": "Say this is a test"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
# Add other parameters as needed
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
**This example:**
|
||||||
|
- Sets a system message to define the assistant's role
|
||||||
|
- Asks a specific question `Say this is a test`
|
||||||
|
- Configures various parameters like temperature and max_tokens for more control over the output
|
||||||
|
- Disables streaming for a complete response
|
||||||
|
|
||||||
|
You can adjust these parameters based on your specific needs.
|
||||||
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue