Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update: tool guides #146

Merged
merged 33 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
d4c44d1
add GitHub tool guide
martyndavies Jan 23, 2024
b788007
add Google Calendar tool guide
martyndavies Jan 23, 2024
115f069
add Google Drive tool guide
martyndavies Jan 23, 2024
f3270ce
add Google Mail tool guide
martyndavies Jan 23, 2024
7db1e2e
add Google Search tool guide
martyndavies Jan 23, 2024
291913d
add Google Sheets tool guide
martyndavies Jan 23, 2024
3fe3f05
add IBM NLU tool guide
martyndavies Jan 23, 2024
f66e6e2
add Infobip tool guide
martyndavies Jan 23, 2024
ba5b9e3
add Jira tool guide
martyndavies Jan 23, 2024
460b3da
update navigation
martyndavies Jan 23, 2024
c393619
add HubSpot tool guide
martyndavies Jan 23, 2024
32fce5f
add Notion tool guide
martyndavies Jan 23, 2024
ddba0a9
update navigation
martyndavies Jan 23, 2024
28f2e88
update typo
martyndavies Jan 23, 2024
91cafdb
update nav
martyndavies Jan 23, 2024
e585972
add Marketstack guide
martyndavies Jan 23, 2024
a4fd696
add OpenWeatherMap guide
martyndavies Jan 23, 2024
95c8600
update navigation
martyndavies Jan 24, 2024
766c97c
add Pipedrive tool guide
martyndavies Jan 24, 2024
615fbb0
Update navigation
martyndavies Jan 24, 2024
62985a1
add Resend tool guide
martyndavies Jan 24, 2024
4c93a9a
update nav
martyndavies Jan 24, 2024
c2ee159
add Weather API tool guide
martyndavies Jan 24, 2024
13a2e20
add world time api guide
martyndavies Jan 24, 2024
6fe6aa4
add wttr.in tool guide
martyndavies Jan 24, 2024
18a2563
add Zendesk tool guide
martyndavies Jan 24, 2024
4c26f9e
update index name
martyndavies Jan 24, 2024
0794664
update navigation tree
martyndavies Jan 24, 2024
e986826
add index for available tools
martyndavies Jan 24, 2024
dcf0ae4
add Slack tool guide
martyndavies Jan 24, 2024
0d49f5f
update Google tools guides
martyndavies Jan 24, 2024
4bd8d2a
rename section to requirements
martyndavies Jan 24, 2024
d9aa7c0
set tools nav to close on load because it's very large
martyndavies Jan 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/tools/available-tools.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import DocCardList from '@theme/DocCardList';

# Tools

<DocCardList />
38 changes: 38 additions & 0 deletions docs/tools/github.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# GitHub

The GitHub Tool for Superface allows you to quickly add the following capabilities:

- Issue Retrieval
- Pull Request details
- Repository Retrieval
- List Current User Repositories
- Organization Repositories
- Pull Request Management
- List Issues
- User Repositories

## Authentication

In order to use the GitHub tool you must authenticate your GitHub account. You can do this from the Config section.

![Connect to GitHub to authenticate the access you need](/img/tools/tools-github-connect.png)

You will be redirected to GitHub to authenticate the required permissions:

![Authenticate the permissions on GitHub](/img/tools/tools-github-auth.png)

Click on **Authorize Superface Agent** to complete the setup. After this you will be redirected back to the config page.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- "List my repositories"
- "Which repo has the most open issues?"
- "Which repo has the oldest PR that is still open?"
36 changes: 36 additions & 0 deletions docs/tools/google-calendar.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Google Calendar

The Google Calendar Tool for Superface allows you to quickly add the following capabilities:

- Insert Event
- Retrieve Event
- List Calendar Events
- Update Event

## Authentication

In order to use the Google Calendar tool you must authenticate your Google account. You can do this from the Config section.

![Connect to Google to authenticate the access you need](/img/tools/tools-google-calendar.png)

You will be redirected to Google to authenticate the required permissions:

![Authenticate the permissions on Google](/img/tools/tools-google-calendar-auth.png)

Select the Google account you want to use. Then give Superface the required permissions by clicking on **Allow**.

![Authenticate the permissions on Google](/img/tools/tools-google-calendar-auth2.png)

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- "What is on my calendar today?"
- "Create a new calendar event for the gym, this Friday at 8am CET"
- "Create a new recurring Team Meeting every Wednesday at 1400 CET"
23 changes: 23 additions & 0 deletions docs/tools/google-drive.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Google Drive

The Google Drive Tool for Superface allows you to quickly add the following capabilities:

- Creates a new file and supports uploading media with specified MIME types.

## Authentication

In order to use the Google Drive tool you must authenticate your Google account. You can do this from the Config section.

![Connect to Google to authenticate the access you need](/img/tools/tools-google-calendar.png)

You will be redirected to Google to authenticate the required permissions:

![Authenticate the permissions on Google](/img/tools/tools-google-calendar-auth.png)

Select the Google account you want to use. Then give Superface the required permissions by clicking on **Allow**.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::
29 changes: 29 additions & 0 deletions docs/tools/google-mail.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Google Mail

The Google Mail Tool for Superface allows you to quickly add the following capabilities:

- Send an email

## Authentication

In order to use the Google Mail tool you must authenticate your Google account. You can do this from the Config section.

![Connect to Google to authenticate the access you need](/img/tools/tools-google-calendar.png)

You will be redirected to Google to authenticate the required permissions:

![Authenticate the permissions on Google](/img/tools/tools-google-calendar-auth.png)

Select the Google account you want to use. Then give Superface the required permissions by clicking on **Allow**.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- Send an email to `<email-address>` with the subject "Hello, World!" and the message "It's a great day to be an email".
46 changes: 46 additions & 0 deletions docs/tools/google-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Google Search

The Google Search tool for Superface allows you to quickly add the following capabilities:

- Perform a custom search

## Requirements

The Google Custom Search API requires a Google Cloud Account. You can set up a free edition [via the documentation](https://developers.google.com/custom-search/v1/introduction).

Additionally, you will need a Programmable Search Engine. This is a custom search engine that you define for yourself. It can either be a specific set of pages, or the entire web.

To set up a Programmable Search Engine, follow the steps outlined in the [PSE Control Panel](https://programmablesearchengine.google.com/controlpanel).

## Authentication

In order to use the Google Search tool you must generate an API Key for that capability in Google Cloud. You can do this directly from the [Programmable Search Engine](https://developers.google.com/custom-search/v1/introduction) documentation by clicking on _Get a key_ button.

![Get a key](/img/tools/tools-google-search-getkey.png)

Now you should have:

- A CX ID for your Programmable Search Engine (They look like this: `e522fcff67c3e4d4b`).
- An API Key with ability to access Programmable Search Engine.

You can add these into the configuration for the Google Search tool in Superface by clicking on the Config button.

![The params and security settings for the Google Search tool in Superface](/img/tools/tools-google-search-config.png)

- Add your CX ID into the field labelled `cx`
- Add your API key into the field labelled `API Key`.
- Click on Save Changes.

Your Google Search tool is now set up and ready to be used.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- Search for "How to Connect GPTs to APIs"
33 changes: 33 additions & 0 deletions docs/tools/google-sheets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Google Sheets

The Google Sheets tool for Superface allows you to quickly add the following capabilities:

- Create a Google Sheet
- Retrieve a Google Sheet
- Update a Google Sheet
- Add a row
- Add a column

## Authentication

In order to use the Google Sheets tool you must authenticate your Google account. You can do this from the Config section.

![Connect to Google to authenticate the access you need](/img/tools/tools-google-calendar.png)

You will be redirected to Google to authenticate the required permissions:

![Authenticate the permissions on Google](/img/tools/tools-google-calendar-auth.png)

Select the Google account you want to use. Then give Superface the required permissions by clicking on **Allow**.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- Create a new spreadsheet named "Quarterly Numbers"
47 changes: 47 additions & 0 deletions docs/tools/hubspot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# HubSpot

The HubSpot tool for Superface allows you to quickly add the following capabilities:

- Create, List or Search, Update and Delete _Companies_
- Create, List or Search, Update and Delete _Deals_
- Create, List or Search, Update and Delete _Contacts_
- List Organization owners

## Requirements

You will need a HubSpot account with the ability to create a [Private App](https://developers.hubspot.com/docs/api/private-apps).

To do this, click on _Settings_ and in the Account Setup section, click on _Integrations > Private Apps_

![Private Apps in HubSpot](/img/tools/tools-hubspot-privateapps.png)

Start by clicking _Create a Private App_.

Give your app a name. You can use "Superface" to keep things clear or have HubSpot generate a random name for you. A logo and description are not required.

Next, click on _Scopes_, this will allow you to select the permissions your application (or in this case, Superface), can access. Select all of the CRM scopes shown below.

![The CRM Scope settings in HubSpot](/img/tools/tools-hubspot-scopes.png)

Complete the setup by clicking _Create App_. You will then be shown the PAT (Personal Access Token) that you can use to authenticate Superface. You can copy it from the pop up and it is available at any time from the _Auth_ section of your Prviate App settings.

![The CRM Scope settings in HubSpot](/img/tools/tools-hubspot-pat.png)

## Authentication

In Superface, click on the Config button for the HubSpot tool.

Paste the access token you got from HubSpot into the `Token` field of the Security section and click on Save Changes.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- Create a new contact with name Hubert Bossington
- Create a deal with name Big Winners with stage Qualified To Buy
47 changes: 47 additions & 0 deletions docs/tools/ibm-nlu.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# IBM NLU (Sentiment Analysis)

The IBM Natural Language Understanding tool for Superface allows you to quickly add the following capabilities:

- Analyze Sentiment

## Requirements

In order to use the IBM Watson Natural Language Understanding tool you will first need to register an account. You can do this via the [IBM Cloud website](https://www.ibm.com/products/natural-language-understanding).

Once you have an account you will need to create a Natural Language Understanding instance. You can do this from the [IBM Cloud Catalog](https://cloud.ibm.com/catalog?category=ai&search=label%3Aibm_created).

You must choose the region that your NLU instance will be created in. If you are not sure, choose the city that is closest to you.

We recommend choosing the Lite pricing plan which offers 30,000 NLU items per month for free. If you need more than this you can always upgrade later.

## Authentication

To use the IBM Natural Language Understanding tool with Superface you will need the API key for the NLU instance you have created. You can find this through the [Resource List](https://cloud.ibm.com/resources) in your IBM Cloud account.

![The IBM Cloud Resource List](/img/tools/tools-ibmnlu-resourcelist.png)

Click to copy the API key from the Credentials section:

![The credentials section](/img/tools/tools-ibmnlu-apikey.png)

In the Superface config for the IBM NLU tool you need to enter values for three fields:

1. The `REGION` is the location of your NLU instance. You can find this by looking at the URL in the credentials section, for example `eu-de` is the location code for Frankfurt.
2. The username should be set to `apikey`.
3. In the password field you can paste your API Key.

![Authenticate the permissions on Google](/img/tools/tools-ibmnlu-superface.png)

Click on Save Changes to update the tool with the new credentials.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- What is the sentiment of this: "I was very happy with the performance of Superface after setting up their built in tools, it allowed me to connect my GPT to other services very quickly."
2 changes: 1 addition & 1 deletion docs/tools/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import DocCardList from '@theme/DocCardList';

# Tools
# Managing Tools

Tools sit at the heart of Superface. They connect you to the APIs of the platforms you want to use from your GPT, or with our Agent.

Expand Down
42 changes: 42 additions & 0 deletions docs/tools/infobip.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Infobip

The Infobip tool for Superface allows you to quickly add the following capabilities:

- Send an SMS message to a phone number

## Requirements

In order to use the [Infobip](https://infobip.com) tool you will first need to register an Infobip account and add a source of credit in order to send SMS messages. You will also need to rent a valid SMS number which can vary in cost depending on location and capability.

## Authentication

To use the Infobip tool with Superface you will need:

- The `API Base URL` for your account
- Your `API Key`

These can both be located on the dashboard of your Infobip account.

![Infobip Dashboard](/img/tools/tools-infobip-apikey.png)

In the Superface config for the Infobip tool you need to enter values for these fields:

1. The `SUBDOMAIN` is the API Base URL value before `.api.infobip.com`, for example the subdomain for `s45fdg.api.infobip.com` is `s45fdg`.
2. The username should be set to `apikey`.
3. In the password field you can paste your API Key.

![Authenticate the permissions on Google](/img/tools/tools-infobip-credentials.png)

Click on Save Changes to update the tool with the new credentials.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- Send an SMS to `<phone number>` from `<your Infobip SMS number>` with the message "Hello, world!"
Loading
Loading