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

fix(docs): agentverse screenshots edits and fixes #1082

Merged
merged 3 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ You will need to provide the **local agent address** and make sure it is running

Once your agent is retrieved correctly, you will see a box depicting it within the **My Agents** tab. Click on it and head over to the **Deploy** tab and click on **+ New Function**. Here, you can now provide the needed details for your Agent Function in the dedicated fields. Remember to provide detailed descriptions for what your **Agent Function** does and the **Fields** for data Models expected. understanding of Functions fields descriptions.

You will need to fill the Agent Function form out with a description for each _Primary_ and _Secondary_ functions.
You will need to fill the Agent Function form out with a description for each _Primary_ and _Secondary_ functions. Below you have a full description for each field requested considering the example from this guide.

### News Reading URL System

Expand Down
6 changes: 3 additions & 3 deletions pages/guides/agents/intermediate/agent-functions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -154,13 +154,13 @@ The **Description** is super important to the success of your Agent Function. Th

Read more and see examples on how to properly set field descriptions by heading over to: [Field descriptions for DeltaV ↗️](/guides/services/field-descriptions-for-deltav) guide.

## Objective Service and Sub-Service
## Primary and Secondary Functions

**Objective Service** and **Sub-Service** functions are different but have strong similarities.
**Primary** and **Secondary** functions are different but have strong similarities.

The first one is the primary Agent Function and for instance, it could be an agent that would respond to a user or be accessible via DeltaV. _Primary Functions are expected to fully or partially fulfill an objective provided by users_.

Similarly, a **Sub-Service** function is an Agent Sub-function providing secondary services that likely need additional context or information to carry out the Primary Function. _Secondary Functions are executed in combination with the Objective task_. If that's the case, DeltaV would see that the Agent Primary Function can be fulfilled by executing a Secondary Function, thus, it will contact this latter one which may or may not require gaining context directly from the user.
Similarly, a **Secondary** function is an Agent Sub-function providing secondary functionalities that likely need additional context or information to carry out the Primary Function. _Secondary Functions are executed in combination with the Objective task_. If that's the case, DeltaV would see that the Agent Primary Function can be fulfilled by executing a Secondary Function, thus, it will contact this latter one which may or may not require gaining context directly from the user.

<Callout type="info" emoji="ℹ️">
DeltaV supports rich text and hyperlinks, enhancing formatting and navigation within the interface. You can include hyperlinks using standard HTML tags for clickable links. For more details, refer to the [guide on rich text and hyperlinks ↗️](/guides/agentverse/agentverse-functions/hyperlinks-and-rich-text-deltav).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ For setting up Hugging Face function we need to create different agents as liste

### Hugging Face System Agent

This Agent helps users with their queries for a text-classification model of their choosing. The agent always prioritizes Hugging Face request secondary function. Below is the script for creating our agent on [Agentverse ↗️](https://agentverse.ai/agents) using the **+New Agent** button.
This Agent helps users with their queries for a text-classification model of their choosing. The agent always prioritizes Hugging Face request secondary function. Below is the script for creating our agent on [Agentverse ↗️](https://agentverse.ai/) using the **+New Agent** button.

<GithubCodeSegment digest="a5a18b6cea7a34043525508675836ff0">
<CodeSegment
Expand Down Expand Up @@ -306,8 +306,7 @@ The properties of function for each Agent are listed below.

### Hugging Face System

![](../../../../src/images/guides/agentverse/Hugging-Face-System/Hugging-Face-System-1.png)
![](../../../../src/images/guides/agentverse/Hugging-Face-System/Hugging-Face-System-2.png)
![](../../../../src/images/guides/services/service-guide/hugging_face_1.png)

- **Function title**: just the name of your function - in this example let's call it **Hugging Face System**.
- **Description**: super important to be as detailed as you can, as reasoning AI Engine looks at descriptions to understand what your function does - in this example we can specify something like this: **This function helps user to give any query to the selected model and gets the response to their query. Always go for hugging face request secondary function for this objective.**
Expand All @@ -319,8 +318,7 @@ The properties of function for each Agent are listed below.

### Hugging Face Request

![](../../../../src/images/guides/agentverse/Hugging-Face-System/Hugging-Face-Request-1.png)
![](../../../../src/images/guides/agentverse/Hugging-Face-System/Hugging-Face-Request-2.png)
![](../../../../src/images/guides/services/service-guide/hugging_face_2.png)

- **Function title**: just the name of your function - in this example let's call it **Hugging Face Request**.
- **Description**: super important to be as detailed as you can, as reasoning AI Engine looks at descriptions to understand what your function does - in this example we can specify something like this: **This function handles the request to help user ask question to a selected model from hugging face. Model_id is always given by Model Lists secondary function**.
Expand All @@ -332,8 +330,7 @@ The properties of function for each Agent are listed below.

### Model List

![](../../../../src/images/guides/agentverse/Hugging-Face-System/Model-List-1.png)
![](../../../../src/images/guides/agentverse/Hugging-Face-System/Model-List-2.png)
![](../../../../src/images/guides/services/service-guide/hugging_face_3.png)

- **Function title**: just the name of your function - in this example let's call it **Model List**.
- **Description**: super important to be as detailed as you can, as reasoning AI Engine looks at descriptions to understand what your function does - in this example we can specify something like this: **This function helps user to select from different model options available. This always gives list of options to the user. make user select one from these options. Present list of strings as select from option.**
Expand Down
3 changes: 0 additions & 3 deletions pages/guides/agentverse/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
"agentverse-functions": {
"title": "Agentverse: Agent Functions"
},
"agentverse-teams": {
"title": "Agentverse: Teams"
},
"avctl": {
"title": "Deploying agents with AVCTL"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ Consider the following Agent Function:

![](src/images/guides/agentverse/registering-agent-coin-toss/new-service-dialog.png)

Providing a detailed field description for the `num_rolls` data `Model` is important to correctly execute the Function. A well written field description enhances the LLM understanding of the type of Function and the user objective requires to be executed. This would help in the accurate interpretation and execution of users' requests.
Providing a detailed field description for the `CoinToss` data `Model` is important to correctly execute the Function. A well written field description enhances the LLM understanding of the type of Function and the user objective requires to be executed. This would help in the accurate interpretation and execution of users' requests.

It is possible to call additional other **Sub-Services** from either **Objective or other Sub-Services** by specifying this within the field description itself. For additional information on Objective Service and Sub-Service, check the following [resource ↗️](/guides/services/services#primary-and-secondary-functions)

For a network of Objective Services and Sub-Services, please refer to the below examples.
For a network of Primary and Secondary Functions, please refer to the below examples.

## Auto-description functionality

It is possible for you to generate **auto-descriptions** for your Functions when it comes to deploy them on Agentverse.

You can make use of this functionality by opening your Agent's details by clicking on the Agent's box within the list of Agents available in **My Agents** tab in Agentverse. Then, head over to the **Deploy** tab as shown below:

![](src/images/guides/agentverse/autodescriptions_initial.png)
![](src/images/guides/agentverse/registering-agent-coin-toss/deploy-coin-toss-function.png)

Here, you will need to either create a **New Function** or **edit an existing one**. This way, you will open your Agent's Function editor, and you will be able to provide/edit the description for what that Function does. It is here where you can make use of the auto-description functionality to fill in such field. At the moment, this functionality is available just for the **Function Description**, but it will be available for **Fields** description at a later stage.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,12 @@ Now click on the **Run** button in the upper right corner of the editor so that

## Register your coin toss agent function!

Similar to the this [guide ↗️](/guides/agentverse/agentverse-functions/registering-agent-services#register-your-agents-and-services), let's navigate to the [Agentverse: My Agents ↗️](https://agentverse.ai/) tab. Here, click on your agent to show the Agent Editor and then click on the **Deploy** tab to start registering your agent function.
Similar to the this [guide ↗️](/guides/agentverse/agentverse-functions/registering-agent-services#register-your-agents-and-services), let's navigate to the [Agentverse: My Agents ↗️](https://agentverse.ai/) tab. Here, click on your agent to show the Agent Editor and then click on the **Deploy** tab to start registering your agent function. For Agents build up from a pre-defined Agent, the function will be already available once you build them. Indeed, you will see something similar to:

After clicking the **+ New Function** button, you will need to provide all details required. Fill the form out as follows:
![](src/images/guides/agentverse/registering-agent-coin-toss/deploy-coin-toss-function.png)


Otherwise, if you want to register a newly created Function for your Agent, click the **+ New Function** button. This way, you will need to provide all details required:

![](src/images/guides/agentverse/registering-agent-coin-toss/new-service-dialog.png)

Expand Down
Binary file modified src/images/agentverse/create-agent/agentverse-myagent_1.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 modified src/images/agentverse/create-agent/agentverse-myagent_3.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 modified src/images/agentverse/create-agent/agentverse-myagent_4.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 modified src/images/agentverse/create-agent/agentverse-myagent_4a.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 modified src/images/agentverse/create-agent/agentverse-myagent_5.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 modified src/images/agentverse/create-agent/agentverse-myagent_6.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 modified src/images/agentverse/create-agent/agentverse-myagent_9.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 modified src/images/guides/101/service_sentiment_a.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 modified src/images/guides/101/service_sentiment_b.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 modified src/images/guides/101/service_url_summary.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 not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/guides/agentverse/agentverse_intro.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 modified src/images/guides/agentverse/autodescriptions.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 not shown.
Binary file modified src/images/guides/agentverse/avctl/agentverse_secret.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 modified src/images/guides/agentverse/mailbox/mailbox_1.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 modified src/images/guides/services/service-guide/business_finder_2.png
Binary file modified src/images/guides/services/service-guide/deploy_service_1.png
Binary file modified src/images/guides/services/service-guide/hugging_face_1.png
Binary file modified src/images/guides/services/service-guide/hugging_face_2.png
Binary file modified src/images/guides/services/service-guide/hugging_face_3.png
Binary file modified src/images/guides/services/service-guide/simple_protocol_1.png
Binary file modified src/images/guides/uagent/servicefordungeons_1.png
Binary file modified src/images/guides/uagent/servicefordungeons_3.png
Loading