From 738ef54eb834fff16d3d29ce816177f22a9c3598 Mon Sep 17 00:00:00 2001 From: Tejas Mahajan <141305477+mahajantejas@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:13:04 +0530 Subject: [PATCH] Update ChatGPT using OpenAI APIs.md updated the sample flow removed the pre-requisites part which mentioned that the orgs need to add their own OpenAI api keys. --- .../ChatGPT using OpenAI APIs.md | 32 +++---------------- 1 file changed, 5 insertions(+), 27 deletions(-) diff --git a/docs/4. Integrations/ChatGPT using OpenAI APIs.md b/docs/4. Integrations/ChatGPT using OpenAI APIs.md index a88373b95..2b2cbecd0 100644 --- a/docs/4. Integrations/ChatGPT using OpenAI APIs.md +++ b/docs/4. Integrations/ChatGPT using OpenAI APIs.md @@ -4,37 +4,22 @@ _**Leverage the capabilities of GPT models developed by OpenAI by using OpenAI APIs.**_ -## Pre-requisites -1. Create an account in OpenAI platform [platform](https://openai.com/product) -2. Create new API keys -3. Make sure there is enough credit in OpenAI account to allow usage. -4. Pricing for API calls is as per OpenAI platform [pricing](https://openai.com/pricing) - -Screenshot 2024-02-07 at 10 50 58 AM - -_Above is a representative image from the OpenAI platform account_ ## How it will work 1. Question is asked by the user after the flow is initiated 2. OpenAI API call is made using webhooks within the flow -3. Model being called to generate responses is `gpt-3.5-turbo-16k` -4. The response to the question is then sent to the user - -## Steps to follow to set up OpenAI API in Glific platform -1. Go to `Settings`, find `OpenAI (ChatGPT) (Beta)` -2. Click on `is active` and paste the OpenAI API key from your OpenAI platform account - -Screenshot 2024-02-07 at 10 48 51 AM +3. Question, prompt to the model, and the type of model being called to answer the question or perform the task is provided inside the webhook params +4. The response is returned from the GPT models which can be sent to the user directly or used as desired in the flow. + ## Using the webhook for OpenAI API call in a Glific flow -Screenshot 2024-02-07 at 9 59 24 AM +Screenshot 2024-09-25 at 11 10 13 AM _Representative image to explain the steps in OpenAI API calls in a simple flow_ -[Sample flow](https://drive.google.com/file/d/1jl0NWn73YlK1qMRedaPnGCQwDKHfG_7j/view?usp=drive_link) - +[Sample flow](https://drive.google.com/file/d/1r2dKE1i95lKrz6V1BiEyvZTXgxXgX87N/view?usp=sharing) 1. Get the user question 2. In `call a webhook` node, select `function` and paste function name as `parse_via_chat_gpt` @@ -43,8 +28,6 @@ _Representative image to explain the steps in OpenAI API calls in a simple flow_ 3. Share the following function body ` { - "contact": "@contact", - "results": "@results", "question_text": "@results.question", "gpt_model":"gpt-4o", "prompt":"Provide an additional prompt for the model" @@ -57,11 +40,6 @@ here `question_text` is the parameter name corresponding to user question. Screenshot 2024-05-22 at 3 52 18 PM - 4. The response from GPT is shown as `@results.webhookresultname.parsed_msg`, in the given example `gpt_response` is the webhook result name. (see the first image) - -## Limitations -1. Text to speech and speech to text models cannot be used via this webhook call. - _Reach out to the Glific team to flag any further customizations within this functionality_