From aba4b96f23ef38ca75195b3b78a88bb92035b4a9 Mon Sep 17 00:00:00 2001
From: Heiner Lohaus <hlohaus@users.noreply.github.com>
Date: Mon, 12 Feb 2024 11:41:27 +0100
Subject: Add new Client API with Docs Use object urls for the preview of image
 uploads. Fix upload images in You provider Fix create image. It's now a
 single image. Improve system message for create images.

---
 docs/client.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 docs/client.md

(limited to 'docs/client.md')

diff --git a/docs/client.md b/docs/client.md
new file mode 100644
index 00000000..1201a83d
--- /dev/null
+++ b/docs/client.md
@@ -0,0 +1,71 @@
+### Client API
+##### from g4f (beta)
+
+#### Start
+This new client could:
+
+```python
+from g4f.client import Client
+```
+replaces this:
+
+```python
+from openai import OpenAI
+```
+in your Python Code.
+
+New client have the same API as OpenAI.
+
+#### Client
+
+Create the client with custom providers:
+
+```python
+from g4f.client import Client
+from g4f.Provider import BingCreateImages, OpenaiChat, Gemini
+
+client = Client(
+    provider=OpenaiChat,
+    image_provider=Gemini,
+    proxies=None
+)
+```
+
+#### Examples
+
+Use the ChatCompletions:
+
+```python
+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 is not None:
+        print(chunk.choices[0].delta.content, end="")
+```
+
+Or use it for creating a image:
+```python
+response = client.images.generate(
+  model="dall-e-3",
+  prompt="a white siamese cat",
+  ...
+)
+
+image_url = response.data[0].url
+```
+
+Also this works with the client:
+```python
+response = client.images.create_variation(
+  image=open('cat.jpg')
+  model="bing",
+  ...
+)
+
+image_url = response.data[0].url
+```
+
+[to Home](/docs/client.md)
-- 
cgit v1.2.3