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

feat: add Superface GPT guide #156

Merged
merged 6 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
76 changes: 76 additions & 0 deletions docs/superface-gpt.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Superface GPT

Superface GPT allows you to interact with your _Google, Notion, Jira, Slack_ and _Microsoft Teams_ accounts directly from your ChatGPT conversation.

![The Superface GPT](/img/gpts/superfacegpt-main.png)

## Available tools

- Google Mail
- Google Sheets
- Google Calendar
- Slack
- Jira
- Notion
- Microsoft Teams

## How to get it

To start using these actions in your own GPTs, you need to:

1. [Click here to open the GPT.](https://chat.openai.com/g/g-XElhtlxOR-superface)
2. Pin it to your sidebar by clicking _Keep in sidebar_.

![Click on the menu to find Keep in Sidebar](/img/gpts/superfacegpt-keepinsidebar.png)

## How to use Superface GPT

You can access this GPT by typing `@superface` in the message bar.

![Superface appears in the message bar](/img/gpts/superfacegpt-atsuperface.png)

Then, by clicking on Superface, you will then be able to interact with any of the available actions.

![Superface is ready to accept prompts](/img/gpts/superfacegpt-talkingtosuperface.png)

## Authentication

You will need to provide your own authentication for any of the tools you want to use. The flow for that authentication works like this:

1. You write a prompt that uses one of the tools provided by Superface.
2. Superface will respond with a message asking you to configure the tool by logging in, or providing your own API key.

![The response from Superface in a GPT](/img/gpts/superfacegpt-googlesheets.png)

3. This will open a new window for the secure authentication service that Superface provides.

![The Superface authentication window](/img/gpts/superfacegpt-googlesheetsauth.png)

4. After authenticating successfully, you will redirected back to the authentication page.

![A successful authentication](/img/gpts/superfacegpt-userloggedin.png)

You can now confirm that the required authentication is in place and your original prompt will be attempted again.

![A successful Google sheet creation](/img/gpts/superfacegpt-success.png)

:::note Authentication expiration

Superface uses a temporary ID provided by OpenAI to recognize you. This ID is valid for up to 24 hours, but can expire at any time. If the ID expires, you will be asked to re-authenticate.

:::

## Conversation starters

There are a selection of prompts available to get you started.

- Create a new Google spreadsheet
- List taks in Jira project `<name>` that were not updated in over a week
- Send message to Slack channel `<channel>`
- Send message to MS Teams channel `<channel>`

## Available capabilities

To see a full list of what Superface GPT enables you to do you can use the prompt `What can you do?`.

![The full list of available capabilties](/img/gpts/superfacegpt-availablecapabilities.png)
5 changes: 5 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,11 @@ module.exports = {
}
]
},
{
type: 'doc',
label: 'Superface GPT',
id: 'superface-gpt'
},
{
type: 'category',
label: 'Superface Agent',
Expand Down
3 changes: 3 additions & 0 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -282,4 +282,7 @@ aside.docSidebarContainer_node_modules-\@docusaurus-theme-classic-lib-next-theme
text-decoration: underline;
}

.row .col ol li a {
text-decoration: underline;
}

Binary file added static/img/gpts/superfacegpt-atsuperface.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.
Binary file added static/img/gpts/superfacegpt-googlesheets.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.
Binary file added static/img/gpts/superfacegpt-keepinsidebar.png
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 static/img/gpts/superfacegpt-logo.png
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 static/img/gpts/superfacegpt-main.png
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 static/img/gpts/superfacegpt-success.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.
Binary file added static/img/gpts/superfacegpt-userloggedin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading