2.0 KiB
G4F Client API Documentation (Beta Version)
Introduction
The G4F Client API introduces a new way to integrate advanced AI functionalities into your Python applications. This guide will help you transition from using the OpenAI client to the new G4F Client, offering compatibility with the existing OpenAI API alongside additional features.
Getting Started
Switching to G4F Client:
Replace the OpenAI client import statement in your Python code as follows:
Old Import:
from openai import OpenAI
New Import:
from g4f.client import Client
The G4F Client maintains the same API interface as OpenAI, ensuring a seamless transition.
Initializing the Client
To use the G4F Client, create an instance with customized providers:
from g4f.client import Client
from g4f.providers import BingCreateImages, OpenaiChat, Gemini
client = Client(
text_provider=OpenaiChat,
image_provider=Gemini,
proxies=None
)
Usage Examples
Text Completions:
You can use the ChatCompletions endpoint to generate text completions as follows:
stream = client.chat.completions.create(
model="gpt-4",
messages=[{"role": "user", "content": "Say this is a test"}],
stream=True,
)
for chunk in stream:
if chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
Image Generation:
Generate images using a specified prompt:
response = client.images.generate(
model="dall-e-3",
prompt="a white siamese cat",
...
)
image_url = response.data[0].url
Creating Image Variations:
Create variations of an existing image:
response = client.images.create_variation(
image=open("cat.jpg", "rb"),
model="bing",
...
)
image_url = response.data[0].url
Visual Examples
Original / Variant:
