alex/nova-python
1
0
Fork 0
mirror of https://github.com/NovaOSS/nova-python.git synced 2024-11-25 20:23:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixed the readme

Browse source
This commit is contained in:
henceiusegentoo 2023-08-15 14:00:35 +02:00
parent 2bdab522ee
commit 1361d09025
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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")
reponse = client.make_request( response = client.make_request(
endpoint=Endpoints.CHAT_COMPLETION, endpoint=Endpoints.CHAT_COMPLETION,
model=Models.GPT3, model=Models.GPT3,
data=[ data=[
@ -54,7 +54,7 @@ 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")
reponse = client.make_request( response = 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."}]
@ -65,20 +65,20 @@ reponse = client.make_request(
If everything goes to plan, you'll receive a string containing JSON-Data, which you can then use in your project. 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. 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: You can access the response's json.data, by casting it to a string using the `str` method, like this:
```python ```python
... ...
str(reponse) str(response)
... ...
``` ```
but more importantly, you can use it's `get_message_content` function, to directly get access to the chat reponse. Used like this: but more importantly, you can use it's `get_message_content` function, to directly get access to the chat response. Used like this:
``` ```
... ...
content = reponse.get_message_content() content = response.get_message_content()
... ...
``` ```