Skip to content

docs: improve docs #137

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.

Sign up for GitHub

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

Open
Ang-dot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve docs #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion examples/acp-base/external-evaluation/buyer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,12 @@ async function buyer() {
const chosenJobOffering = chosenAgent.jobOfferings[0];

const jobId = await chosenJobOffering.initiateJob(
"Help me to generate a flower meme.",
// <your-schema-field> can be found in your ACP Visualiser's "Edit Service" pop-up.
// Reference: (./images/specify_requirement_toggle_switch.png)
{
"<your-schema-key-1>": "<your-schema-value-1>",
"<your-schema-key-2>": "<your-schema-value-2>",
},
EVALUATOR_AGENT_WALLET_ADDRESS, // evaluator address
new Date(Date.now() + 1000 * 60 * 3.1) // job expiry duration, minimum 3 minutes
);
Expand Down
2 changes: 2 additions & 0 deletions examples/acp-base/funds/prediction-market/buyer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ const question = (prompt: string): Promise<string> => {
});
};

// <your-schema-field> can be found in your ACP Visualiser's "Edit Service" pop-up.
// Reference: (./images/specify_requirement_toggle_switch.png)
const SERVICE_REQUIREMENTS_JOB_TYPE_MAPPING: Record<string, PredictionMarketDemoJobPayload> = {
create_market: {
question: "Will ETH close above $3000 on Dec 31, 2025?",
Expand Down
2 changes: 2 additions & 0 deletions examples/acp-base/funds/trading/buyer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ const question = (prompt: string): Promise<string> => {
});
};

// <your-schema-field> can be found in your ACP Visualiser's "Edit Service" pop-up.
// Reference: (./images/specify_requirement_toggle_switch.png)
const SERVICE_REQUIREMENTS_JOB_TYPE_MAPPING: Record<string, FundsJobDemoPayload> = {
swap_token: {
fromSymbol: "USDC",
Expand Down
2 changes: 2 additions & 0 deletions examples/acp-base/polling-mode/buyer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ async function buyer() {
);

const jobId = await chosenJobOffering.initiateJob(
// <your-schema-field> can be found in your ACP Visualiser's "Edit Service" pop-up.
// Reference: (./images/specify_requirement_toggle_switch.png)
{
"<your-schema-key-1>": "<your-schema-value-1>",
"<your-schema-key-2>": "<your-schema-value-2>",
Expand Down
2 changes: 2 additions & 0 deletions examples/acp-base/skip-evaluation/buyer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ async function buyer() {
const chosenJobOffering = chosenAgent.jobOfferings[0];

const jobId = await chosenJobOffering.initiateJob(
// <your-schema-field> can be found in your ACP Visualiser's "Edit Service" pop-up.
// Reference: (./images/specify_requirement_toggle_switch.png)
{
"<your-schema-key-1>": "<your-schema-value-1>",
"<your-schema-key-2>": "<your-schema-value-2>",
Expand Down