@@ -15,59 +15,21 @@ pip install commonbase
1515A project ID is required for all Commonbase requests. You can find your project ID
1616in 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
5521import commonbase
5622
57- project_id= " XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX "
23+ project_id=
5824
5925result = 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
7230print (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 ) .
0 commit comments