mirror of
https://github.com/NovaOSS/nova-python.git
synced 2024-11-25 18:23:59 +01:00
Updated readme
This commit is contained in:
parent
2d113df795
commit
72c01024cb
29
README.md
29
README.md
|
@ -36,7 +36,7 @@ Now, to make a request, use the `make_request` function. For example:
|
||||||
from nova_python import Endpoints, Models, NovaClient
|
from nova_python import Endpoints, Models, NovaClient
|
||||||
client = NovaClient("YOUR_API_KEY")
|
client = NovaClient("YOUR_API_KEY")
|
||||||
|
|
||||||
client.make_request(
|
reponse = client.make_request(
|
||||||
endpoint=Endpoints.CHAT_COMPLETION,
|
endpoint=Endpoints.CHAT_COMPLETION,
|
||||||
model=Models.GPT3,
|
model=Models.GPT3,
|
||||||
data=[
|
data=[
|
||||||
|
@ -44,6 +44,8 @@ client.make_request(
|
||||||
{"role": "user", "content": "Hello!"}
|
{"role": "user", "content": "Hello!"}
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
or
|
or
|
||||||
|
@ -52,15 +54,36 @@ or
|
||||||
from nova_python import Endpoints, Models, NovaClient
|
from nova_python import Endpoints, Models, NovaClient
|
||||||
client = NovaClient("YOUR_API_KEY")
|
client = NovaClient("YOUR_API_KEY")
|
||||||
|
|
||||||
client.make_request(
|
reponse = client.make_request(
|
||||||
endpoint=Endpoints.MODERATION,
|
endpoint=Endpoints.MODERATION,
|
||||||
model=Models.MODERATION_STABLE,
|
model=Models.MODERATION_STABLE,
|
||||||
data=[{"input": "I'm going to kill them."}]
|
data=[{"input": "I'm going to kill them."}]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
...
|
||||||
|
```
|
||||||
|
If everything goes to plan, you'll receive a string containing JSON-Data, which you can then use in your project.
|
||||||
|
|
||||||
|
Note, that when using chat completion, as special ChatResponse-Instance get's returned.
|
||||||
|
You can access the reponse's json.data, by casting it to a string using the `str` method, like this:
|
||||||
|
```python
|
||||||
|
...
|
||||||
|
|
||||||
|
str(reponse)
|
||||||
|
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
but more importantly, you can use it's `get_message_content` function, to directly get access to the chat reponse. Used like this:
|
||||||
|
```
|
||||||
|
...
|
||||||
|
|
||||||
|
content = reponse.get_message_content()
|
||||||
|
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
If everything goes to plan, you'll receive a string containing JSON-Data, which you can then use in your project.
|
|
||||||
*Happy prompting!*
|
*Happy prompting!*
|
||||||
<br><br>
|
<br><br>
|
||||||
## FAQ ##
|
## FAQ ##
|
||||||
|
|
Loading…
Reference in a new issue