Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adityaoberai/novu-livestream
https://github.com/adityaoberai/novu-livestream
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/adityaoberai/novu-livestream
- Owner: adityaoberai
- Created: 2023-10-12T15:33:34.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-12T15:59:30.000Z (about 1 year ago)
- Last Synced: 2024-10-15T01:02:21.860Z (29 days ago)
- Language: HTML
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🤖 Node Prompt ChatGPT Function
Ask question, and let OpenAI GPT-3.5-turbo answer.
## 🧰 Usage
### GET /
HTML form for interacting with the function.
### POST /
Query the model for a completion.
**Parameters**
| Name | Description | Location | Type | Sample Value |
| ------------ | ------------------------------------ | -------- | ------------------ | ----------------------------- |
| Content-Type | The content type of the request body | Header | `application/json` | N/A |
| prompt | Text to prompt the model | Body | String | `Write a haiku about Mondays` |
Sample `200` Response:
Response from the model.
```json
{
"ok": true,
"completion": "Monday's heavy weight, Dawning with a sigh of grey, Hopeful hearts await."
}
```
Sample `400` Response:
Response when the request body is missing.
```json
{
"ok": false,
"error": "Missing body with a prompt."
}
```
Sample `500` Response:
Response when the model fails to respond.
```json
{
"ok": false,
"error": "Failed to query model."
}
```
## ⚙️ Configuration
| Setting | Value |
| ----------------- | ------------- |
| Runtime | Node (18.0) |
| Entrypoint | `src/main.js` |
| Build Commands | `npm install` |
| Permissions | `any` |
| Timeout (Seconds) | 15 |
## 🔒 Environment Variables
### OPENAI_API_KEY
A unique key used to authenticate with the OpenAI API. Please note that this is a paid service and you will be charged for each request made to the API. For more information, see the [OpenAI pricing page](https://openai.com/pricing/).
| Question | Answer |
| ------------- | --------------------------------------------------------------------------- |
| Required | Yes |
| Sample Value | `sk-wzG...vcy` |
| Documentation | [OpenAI Docs](https://platform.openai.com/docs/quickstart/add-your-api-key) |
### OPENAI_MAX_TOKENS
The maximum number of tokens that the OpenAI response should contain. Be aware that OpenAI models read and write a maximum number of tokens per API call, which varies depending on the model. For GPT-3.5-turbo, the limit is 4096 tokens.
| Question | Answer |
| ------------- | ------------------------------------------------------------------------------------------------------------- |
| Required | No |
| Sample Value | `512` |
| Documentation | [OpenAI: What are tokens?](https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them) |