ensure to pass host to client not request

Aleph-Alpha · Dec 4, 2024 · 8ee43e7 · 8ee43e7
1 parent 43989c1
commit 8ee43e7
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -18,10 +18,12 @@ Python client for the [Aleph Alpha](https://aleph-alpha.com) API.
 import os
 from aleph_alpha_client import Client, CompletionRequest, Prompt
 
-client = Client(token=os.getenv("AA_TOKEN"))
+client = Client(
+    token=os.getenv("AA_TOKEN"),
+    host="https://inference-api.your-domain.com",
+)
 request = CompletionRequest(
     prompt=Prompt.from_text("Provide a short description of AI:"),
-    host="https://inference-api.your-domain.com",
     maximum_tokens=64,
 )
 response = client.complete(request, model="pharia-1-llm-7b-control")
@@ -36,10 +38,12 @@ import os
 from aleph_alpha_client import AsyncClient, CompletionRequest, Prompt
 
 # Can enter context manager within an async function
-async with AsyncClient(token=os.environ["AA_TOKEN"]) as client:
+async with AsyncClient(
+    token=os.environ["AA_TOKEN"]
+    host="https://inference-api.your-domain.com",
+) as client:
     request = CompletionRequest(
         prompt=Prompt.from_text("Provide a short description of AI:"),
-        host="https://inference-api.your-domain.com",
         maximum_tokens=64,
     )
     response = client.complete_with_streaming(request, model="pharia-1-llm-7b-control")

diff --git a/aleph_alpha_client/aleph_alpha_client.py b/aleph_alpha_client/aleph_alpha_client.py
@@ -163,10 +163,11 @@ class Client:
             Internal feature.
 
     Example usage:
-        >>> request = CompletionRequest(
-                prompt=Prompt.from_text(f"Request"), host="https://inference-api.your-domain.com", maximum_tokens=64
+        >>> request = CompletionRequest(prompt=Prompt.from_text(f"Request"), maximum_tokens=64)
+        >>> client = Client(
+                token=os.environ["AA_TOKEN"],
+                host="https://inference-api.your-domain.com",
             )
-        >>> client = Client(token=os.environ["AA_TOKEN"])
         >>> response: CompletionResponse = client.complete(request, "pharia-1-llm-7b-control")
     """
 
@@ -740,10 +741,11 @@ class AsyncClient:
             Internal feature.
 
     Example usage:
-        >>> request = CompletionRequest(
-                prompt=Prompt.from_text(f"Request"), host="https://inference-api.your-domain.com", maximum_tokens=64
-            )
-        >>> async with AsyncClient(token=os.environ["AA_TOKEN"]) as client:
+        >>> request = CompletionRequest(prompt=Prompt.from_text(f"Request"), maximum_tokens=64)
+        >>> async with AsyncClient(
+                token=os.environ["AA_TOKEN"],
+                host="https://inference-api.your-domain.com"
+            ) as client:
                 response: CompletionResponse = await client.complete(request, "pharia-1-llm-7b-control")
     """
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,7 +18,7 @@ Synchronous client.
       from aleph_alpha_client import Client, CompletionRequest, Prompt
       import os
 
-      client = Client(token=os.getenv("AA_TOKEN"))
+      client = Client(token=os.getenv("AA_TOKEN"), host="https://inference-api.your-domain.com")
       prompt = Prompt.from_text("Provide a short description of AI:")
       request = CompletionRequest(prompt=prompt, maximum_tokens=20)
       result = client.complete(request, model="luminous-extended")
@@ -32,7 +32,7 @@ Synchronous client with prompt containing an image.
       from aleph_alpha_client import Client, CompletionRequest, PromptTemplate, Image
       import os
 
-      client = Client(token=os.getenv("AA_TOKEN"))
+      client = Client(token=os.getenv("AA_TOKEN"), host="https://inference-api.your-domain.com")
       image = Image.from_file("path-to-an-image")
       prompt_template = PromptTemplate("{{image}}This picture shows ")
       prompt = prompt_template.to_prompt(image=prompt_template.placeholder(image))
@@ -50,7 +50,7 @@ Asynchronous client.
    from aleph_alpha_client import AsyncClient, CompletionRequest, Prompt
 
    # Can enter context manager within an async function
-   async with AsyncClient(token=os.environ["AA_TOKEN"]) as client:
+   async with AsyncClient(token=os.environ["AA_TOKEN"], host="https://inference-api.your-domain.com") as client:
       request = CompletionRequest(
          prompt=Prompt.from_text("Request"),
          maximum_tokens=64,