Skip to content

Commit d99c4e6

Browse files
author
Brandon Meyerowitz
committed
chore: revise examples & readme
1 parent 6dc2c85 commit d99c4e6

File tree

2 files changed

+15
-50
lines changed

2 files changed

+15
-50
lines changed

README.md

Lines changed: 8 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -15,59 +15,21 @@ pip install commonbase
1515
A project ID is required for all Commonbase requests. You can find your project ID
1616
in the [Commonbase Dashboard](https://commonbase.com/).
1717

18-
## Text Completion
19-
20-
To create a basic text completion, use the `Completion.create` class method with a `prompt` argument.
21-
22-
```py
23-
import commonbase
24-
25-
project_id="XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"
26-
27-
result = commonbase.Completion.create(project_id=project_id, prompt="Hello!")
28-
29-
print(result.choices[0].text)
30-
```
31-
32-
Use `Completion.stream` to stream a completion response.
33-
34-
```py
35-
import commonbase
36-
37-
project_id="XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"
38-
39-
result = commonbase.Completion.stream(
40-
project_id=project_id,
41-
prompt="Write me a short essay about artificial intelligence."
42-
)
43-
44-
for completion in result:
45-
print(completion.choices[0].text, end="")
46-
```
47-
48-
### Chat
49-
50-
To create a chat completion, use the `chat_context` argument to provide a list of chat messages.
51-
You must also set the OpenAI configuration to `chat`. In this mode, the `prompt` argument
52-
functions as a system message.
18+
To create text and chat completions, use `commonbase.Completion.create`:
5319

5420
```py
5521
import commonbase
5622

57-
project_id="XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"
23+
project_id=
5824

5925
result = commonbase.Completion.create(
60-
project_id=project_id,
61-
prompt="You are an assistant who helps users with tech problems.",
62-
chat_context=commonbase.ChatContext([
63-
commonbase.ChatMessage(role="user", content="My internet isn't working."),
64-
commonbase.ChatMessage(role="assistant", content="Have you tried restarting your router?"),
65-
commonbase.ChatMessage(role="user", content="Yes I've tried that."),
66-
]),
67-
provider_config=commonbase.ProviderConfig(
68-
provider="cb-openai-eu", params=commonbase.OpenAIParams(type="chat")
69-
),
26+
project_id="<your_project_id>",
27+
prompt="Hello!"
7028
)
7129

7230
print(result.choices[0].text)
7331
```
32+
33+
To stream a completion as it is generated, use `commonbase.Completion.stream`.
34+
35+
For more examples, see [/examples](https://github.com/commonbaseapp/commonbase-python/tree/main/examples).

examples/completion.ipynb

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
"source": [
4747
"import commonbase\n",
4848
"\n",
49-
"project_id=\"<YOUR PROJECT ID>\"\n",
49+
"project_id=\"<YOUR_PROJECT_ID>\"\n",
5050
"\n",
5151
"result = commonbase.Completion.create(project_id=project_id, prompt=\"Hello!\")\n",
5252
"\n",
@@ -68,12 +68,15 @@
6868
"source": [
6969
"import commonbase\n",
7070
"\n",
71-
"project_id=\"<YOUR PROJECT_ID>\"\n",
71+
"project_id=\"<YOUR_PROJECT_ID>\"\n",
7272
"\n",
7373
"result = commonbase.Completion.stream(project_id=project_id, prompt=\"Write me a short essay about artificial intelligence.\")\n",
7474
"\n",
7575
"for completion in result:\n",
76-
" print(completion.choices[0].text, end=\"\")"
76+
" if not completion.completed:\n",
77+
" print(completion.choices[0].text, end=\"\")\n",
78+
" else:\n",
79+
" print(\"\\n\\ndone\")"
7780
]
7881
},
7982
{
@@ -95,7 +98,7 @@
9598
"source": [
9699
"import commonbase\n",
97100
"\n",
98-
"project_id=\"<YOUR PROJECT_ID>\"\n",
101+
"project_id=\"<YOUR_PROJECT_ID>\"\n",
99102
"\n",
100103
"result = commonbase.Completion.create(\n",
101104
" project_id=project_id,\n",

0 commit comments

Comments
 (0)