|
|
|
# Prerequisites
|
|
|
|
|
|
|
|
OpenAI Account.
|
|
|
|
|
|
|
|
# Installation
|
|
|
|
|
|
|
|
**To install the GPT Integration add-on, please follow these steps:**
|
|
|
|
|
|
|
|
> Step 1: Install “GPT Integration” add-on (Main Menu \> Extension Store, and search for “GPT Integration”, and click Install )
|
|
|
|
>
|
|
|
|
> Step 2: Open the “GPT Integration” configuration page (Main Menu \> Settings \> Integration \>GPT Integration)
|
|
|
|
>
|
|
|
|
> Step 3: Enter your OpenAI “API Key” and “Organization ID” values in the “Configuration” tab.
|
|
|
|
>
|
|
|
|
> {width="634" height="302"}
|
|
|
|
|
|
|
|
**To get OpenAI API Key:**
|
|
|
|
|
|
|
|
> Login to your OpenAI account - **https://platform.openai.com/account/**
|
|
|
|
>
|
|
|
|
> Visit the API Keys page, anc click on “Create new secret key”
|
|
|
|
>
|
|
|
|
> {width="648" height="326"}
|
|
|
|
>
|
|
|
|
> Copy the secret key
|
|
|
|
>
|
|
|
|
> {width="645" height="324"}
|
|
|
|
>
|
|
|
|
> Paste it in the API field
|
|
|
|
>
|
|
|
|
> {width="652" height="310"}
|
|
|
|
|
|
|
|
**To get Organization ID:**
|
|
|
|
|
|
|
|
> Open the Organization page in your OpenAI portal https://platform.openai.com/account/organization
|
|
|
|
>
|
|
|
|
> Copy the Organization ID
|
|
|
|
>
|
|
|
|
> {width="647" height="325"}
|
|
|
|
>
|
|
|
|
> Paste it in the Organization ID field
|
|
|
|
>
|
|
|
|
> {width="650" height="309"}
|
|
|
|
>
|
|
|
|
> Click on "Save." The system will validate the entered details. It will display masked Api Key and Organization ID if the submitted details are valid.
|
|
|
|
>
|
|
|
|
> {width="654" height="312"}
|
|
|
|
|
|
|
|
This completes the installation.
|
|
|
|
|
|
|
|
# **Use Cases for GPT Integration in CRM**
|
|
|
|
|
|
|
|
You can access OpenAI functionality from multiple pages in the CRM.
|
|
|
|
|
|
|
|
**Use Case 1: Ask OpenAI to generate an email draft**
|
|
|
|
|
|
|
|
> From Contact detail view, click on "Send Email". In the Send Email Compose form, the "Ask Open AI" button will be visible.
|
|
|
|
>
|
|
|
|
> {width="658" height="282"}
|
|
|
|
>
|
|
|
|
> In the popup, enter your prompt text and click Submit
|
|
|
|
>
|
|
|
|
> Here is an example of a prompt:
|
|
|
|
>
|
|
|
|
> * “Draft a persuasive email to introduce Vtiger CRM to John Doe, highlighting its benefits and addressing his potential pain points identified earlier. Emphasize our unique value proposition and tailor the message to his interests”
|
|
|
|
>
|
|
|
|
> {width="649" height="311"}
|
|
|
|
> * You will see the response
|
|
|
|
>
|
|
|
|
> {width="653" height="313"}
|
|
|
|
>
|
|
|
|
> You can directly copy the content by clicking the arrow mark into the email composer.
|
|
|
|
>
|
|
|
|
> {width="693" height="333"}
|
|
|
|
|
|
|
|
**Use Case 2: Get suggestions for Email Subject**
|
|
|
|
|
|
|
|
> When sending an email, to see alternative subjects that you can use, you can click on the Suggestions button after entering the subject text.
|
|
|
|
>
|
|
|
|
> {width="700" height="366"}
|
|
|
|
|
|
|
|
# Usage Logs
|
|
|
|
|
|
|
|
To view the requests and responses sent to OpenAI, view the “Logs” tab in Settings \> Integrations \> AskoAI page.
|
|
|
|
|
|
|
|
The logs table shows the following details for each request sent to Open AI.
|
|
|
|
|
|
|
|
* CRM User name
|
|
|
|
* Requested Time
|
|
|
|
* Requested Prompt
|
|
|
|
* Response
|
|
|
|
* Tokens Consumed
|
|
|
|
|
|
|
|
{width="744" height="222"}
|
|
|
|
|
|
|
|
# Limitations
|
|
|
|
|
|
|
|
The service serves requests based on the available Open AI tokens. |
|
|
|
\ No newline at end of file |
