-
Notifications
You must be signed in to change notification settings - Fork 223
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9a84e2b
commit 3003b68
Showing
6 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
71 changes: 71 additions & 0 deletions
71
src/routes/blog/post/function-template-prompt-chatgpt/+page.markdoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
layout: post | ||
title: Build An Intelligent Chatbot With ChatGPT And Appwrite Functions | ||
description: Learn how to use an Appwrite Function Template to create an interactive bot using GPT-3.5. | ||
date: 2023-11-15 | ||
cover: /images/blog/function-template-prompt-chatgpt/cover.png | ||
timeToRead: 5 | ||
author: aditya-oberai | ||
category: functions | ||
--- | ||
|
||
Function templates are pre-built Appwrite Functions that can be integrated into your Appwrite project with just a few clicks. Using them, you can easily incorporate new features and integrations into your app without writing additional code or managing infrastructure. | ||
|
||
One such integration you can implement using Appwrite Functions is an **intelligent chatbot** using **ChatGPT**. In this blog, you will learn how you can use an Appwrite Function Template to create an interactive bot that will answer any of your questions using OpenAI’s GPT-3.5 API. | ||
|
||
## Setting up the OpenAI Platform | ||
|
||
To get an OpenAI API Key, you must create an account on the [OpenAI platform](https://platform.openai.com/). Once your account is set up, visit their [API keys](https://platform.openai.com/account/api-keys) page and create an **API Key**. Ensure you copy and save this key in a safe place, as the OpenAI platform will not let you view the key after it is created. | ||
|
||
![OpenAI Platform](/images/blog/function-template-prompt-chatgpt/openai-api-keys.png) | ||
|
||
## Preparing the Appwrite Function | ||
|
||
Now that we have our OpenAI API Key, let us get the function ready on **[Appwrite](https://cloud.appwrite.io)**. Head over to your Appwrite project and visit the **Functions** page. From there, we will select the **Templates** tab, search for and select the **Prompt ChatGPT** function template. | ||
|
||
![Function Templates](/images/blog/function-template-prompt-chatgpt/templates.png) | ||
|
||
This function requires **1 environment variable** to setup: | ||
|
||
- `OPENAI_API_KEY`: API Key from our OpenAI account | ||
|
||
After you have configured the environment variables, you must connect your Appwrite account with GitHub, select **Create a new repository** (this will generate a GitHub repository for you with the function), and leave the production branch and root settings as default to create this function. | ||
|
||
Once the function is ready, visit the **Domains** tab on the function page and copy the domain URL to test the function. | ||
|
||
![Function Domain](/images/blog/function-template-prompt-chatgpt/domains.png) | ||
|
||
## Testing the Function | ||
|
||
Once all the aforementioned steps are complete, it is time to test the function! | ||
|
||
To consume this function, you must send the function URL a `POST` HTTP Request with a **JSON Body** in the following format: | ||
|
||
```json | ||
{ | ||
"prompt": "<ENTER YOUR PROMPT>" | ||
} | ||
``` | ||
|
||
If successful, you will receive a response in the following format: | ||
|
||
```json | ||
{ | ||
"ok": true, | ||
"completion": "<CHAT COMPLETION FROM GPT-3.5>" | ||
} | ||
``` | ||
|
||
Here’s a screenshot of a test prompt that was sent to the function using Postman: | ||
|
||
![Postman](/images/blog/function-template-prompt-chatgpt/postman.png) | ||
|
||
## Next Steps | ||
|
||
We’ve covered the basics, and now it’s your time to shine! With a few changes, you should be able to extend this template to fit your app. Be sure to check out the other available Function Templates. We’ve created many that could be of use in your projects. You can find the [templates GitHub repository here](https://github.com/appwrite/templates). | ||
|
||
For more information about Appwrite and Appwrite Functions: | ||
|
||
- [Appwrite Function Docs](https://appwrite.io/docs/functions): These documents provide more information on how to use Appwrite Functions. | ||
- [Functions Announcement](https://dev.to/appwrite/serverless-your-way-unleashing-appwrite-functions-true-potential-2l4f): Read the full announcement on Functions 1.4. | ||
- [Appwrite Discord](https://discord.com/invite/appwrite): Connect with other developers and the Appwrite team for discussion, questions, and collaboration. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+698 KB
static/images/blog/function-template-prompt-chatgpt/openai-api-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.