You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
By default Superface uses the *OpenAI ChatGPT-3.5 Turbo* model, however this may not necessarily be the best model for all the capabilities you want to add with your tools.
3
+
4
+
You can modify the model that the agent uses by clicking on **Settings > System** and selecting the model you want to run your tools with from the **Foundation model** drop down list.
5
+
6
+
All Superface tools have a *provider* as part of their configuration. The provider is where necessary elements such as API keys, and additional parameters that are needed to connect to an external service are defined.
3
+
4
+
5
+
6
+
The providers are listed in alpabetical order of the name of the external service they represent.
7
+
8
+
A fully configured provider will have a green dot next to it. If it's green, it's good to go.
9
+
10
+
If there is a red dot next to the name then some additional configuration is needed.
11
+
12
+
## Setting configurations
13
+
To set up configuration options for a provider you can click on the cog icon to see the specific settings required.
14
+
15
+
For example, here are the configuration parameters required for the Mixpanel provider shown in the image above.
Typically a provider outlines the security configuration as well as any additional parameters that are required by the third-party API your tool is connecting to. In this case we can see that Mixpanel requires both of these.
20
+
21
+
To set up your provider, fill out all of the blank fields and click **Save Changes**.
22
+
23
+
## Provider file example
24
+
Below you can see the provider file for Mixpanel. This is where the parameters and security scheme detals you can see on the screen are defined.
25
+
26
+
```json
27
+
{
28
+
"name": "mixpanel",
29
+
"defaultService": "default",
30
+
"parameters": [
31
+
{
32
+
"name": "project_id",
33
+
"description": "The ID of the Mixpanel project"
34
+
},
35
+
{
36
+
"name": "workspace_id",
37
+
"description": "The ID of the workspace to query"
38
+
}
39
+
],
40
+
"services": [
41
+
{
42
+
"baseUrl": "https://eu.mixpanel.com/api/query",
43
+
"id": "default"
44
+
}
45
+
],
46
+
"securitySchemes": [
47
+
{
48
+
"type": "http",
49
+
"scheme": "basic",
50
+
"id": "ServiceAccount"
51
+
}
52
+
]
53
+
}
54
+
```
55
+
56
+
## Replacing a provider
57
+
If you need to replace a provider at any time you can click on the edit icon to upload a new version.
It is possible to pass your own instructions that will be pre-loaded into the agent every time you use it.
3
+
4
+
This is useful for setting rules that are specific to you and how you want to use the agent on a day to day basis.
5
+
6
+
You can set your custom instructions by clicking on **Settings > System** and adding to the *Custom instructions* section.
7
+
8
+
9
+
10
+
## Custom instruction examples
11
+
How you set up your instructions is up to you, but we recommend using a list. For example:
12
+
13
+
```text
14
+
- When I ask for the top events from Mixpanel, always format the results in a table with the percentage change in descending order
15
+
16
+
- When sending an email always set the sender name to Operations Department
17
+
18
+
- When extracting sentiment from support tickets, only show me the email address of the user and if their sentiment was positive or negative, exclude other information.
After logging in to Superface, you will see a fresh agent interface ready to get started with your prompts.
4
+
5
+
6
+
7
+
If it's your first time using the agent, there probably won't be any tools set up yet. You can check this by asking `What can you do?`. If there are already tools installed, Superface will respond with a list of the capabilities they enable.
8
+
9
+
:::tip What are tools?
10
+
In Superface world, "Tools" are what connects the agent to your external services. They are built using our [Command Line Interface](../develop/install-superface).
11
+
:::
12
+
13
+
To get started, you will need to add some tools. You can do this by clicking on **Settings** and following our [Adding new tools](./adding-tools.mdx) guide.
14
+
15
+
If you have not developed any tools yet, you can start by following our [Developing Superface Tools](../develop/)
16
+
17
+
## Writing prompts
18
+
19
+
To get the most out of Superface you need to prompt it for answers. You can do this from the prompt bar at the bottom of the screen.
20
+
21
+
22
+
23
+
## Task history
24
+
25
+
To access previous tasks, click on **History**. A drawer of your previous tasks (and any scheduled tasks) will appear on the left of the screen.
26
+
27
+
You can update the tools you have available in Superface at any time by clicking on the edit icon.
3
+
4
+
5
+
6
+
This will take you to the **Add Comlinks** section where you can re-upload new files for the tool you want to make changes to.
7
+
8
+
.
9
+
10
+
Drag and drop your updated/edited files and they will overwrite the previous versions if the naming convention used has not changed.
11
+
12
+
:::tip
13
+
You only need to upload the files that you have made changes to. If nothing has changed in the profile, or provider files, you don't need to add these because they already exist in Superface.
Copy file name to clipboardExpand all lines: docs/api-examples/index.mdx
+9-25Lines changed: 9 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,19 @@
1
1
---
2
-
slug: /api-examples
2
+
slug: /tool-examples
3
3
id: index
4
4
---
5
5
6
-
# API Examples
6
+
# Tool Examples
7
7
8
-
Superface is the AI for APIs. It makes creating API integrations faster, and more manageable so you can focus on developing your application.
8
+
Superface's agent relies on tools in order to access external systems and perform the tasks that you require. Below are some walkthrough examples of creating tools that can be used directly in the agent interface with popular services such as HubSpot, Pipedrive, Slack and more.
0 commit comments