-
Notifications
You must be signed in to change notification settings - Fork 50
feat/update-tool-desc #275
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
base: master
Are you sure you want to change the base?
Conversation
if (!actorDefinitionPruned) continue; | ||
|
||
const isRag = actorDefinitionPruned.actorFullName === RAG_WEB_BROWSER; | ||
const { inputSchema } = buildActorInputSchema(actorDefinitionPruned.actorFullName, actorDefinitionPruned.input, isRag); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: why additional isRag
param, we can you just check the actorFullName
to match the RAG browser.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm also using it below .... but either fine is fine with me
I'll fix the conflict later |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice rework 👍 The structure makes more sense and hopefully it will work better for the LLMs. Just a few nits and one question otherwise LGTM (did not test though).
|
||
MANDATORY TWO-STEP WORKFLOW: | ||
A successful run returns a \`datasetId\` (the Actor's output stored as an Apify dataset) and a short preview of items. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: the short preview of the items may or may not be included
@@ -344,7 +352,8 @@ Step 2: Call Actor (step="call") | |||
- This calls and runs the Actor. It will create an output as an Apify dataset (with datasetId). | |||
- This step returns a dataset preview, typically JSON-formatted tabular data. | |||
|
|||
The step parameter enforces this workflow - you cannot call an Actor without first getting its info.`, | |||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: examples of what? I would include something like "EXAMPLE WHEN TO USE THIS TOOL"
USAGE: | ||
- Use when you need dataset metadata to understand its structure before fetching items. | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
USAGE: | ||
- Use when you need to read data from a dataset (all items or only selected fields). | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
USAGE: | ||
- Use when you need to infer the structure of dataset items for downstream processing or validation. | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
USAGE: | ||
- Use when you need to inspect run status or retrieve associated resource IDs (e.g., datasetId for output). | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
USAGE: | ||
- Use when you need to inspect recent logs to debug or monitor a run. | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
USAGE: | ||
- Use when you need to stop a run that is taking too long or misconfigured. | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
USAGE: | ||
- Use when you need to browse or filter recent Actor runs. | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
- Use when a user asks about specific data and available Actors in the Apify Store | ||
- Use when a user needs to discover MCP servers or automation tools | ||
- Use when you need to discover Actors for a specific task or find MCP servers. | ||
- Use to explore available tools in the Apify ecosystem based on keywords. | ||
|
||
EXAMPLES: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: same here
Update tool descriptions based on evaluations.
Also, keep only a few attributes for the RAG Web Browser. Having all attributes was confusing and just wasted LLM tokens.
So, the RAG Web Browser is a special case: it’s used as the default tool with limited attributes.
The obvious drawback is that it can’t be used with all attributes—but I think that’s fine.
https://app.phoenix.arize.com/s/michal-kalita/datasets/RGF0YXNldDo1NQ==/experiments
related to https://github.com/apify/ai-team/issues/67