Skip to content

docs: add run arguments and Message input to eval suite Case - #770

Closed
harshsinha03 wants to merge 1 commit into
mainfrom
docs/eval-suite-case-run-arguments
Closed

harshsinha03 wants to merge 1 commit into
mainfrom
docs/eval-suite-case-run-arguments

Conversation

@harshsinha03

Copy link
Copy Markdown
Contributor

Description

Documents the run arguments and Message input added to the eval suite Case in agno-agi/agno#10829.

  • evals/suite/overview.mdx: input now takes str or Message; new rows for session_id, user_id, session_state, dependencies, metadata, and knowledge_filters; new sections Run arguments, Multi-turn cases, and Media input.
  • reference/evals/suite.mdx: the same rows on the Case table; CaseResult.session_id is Case.session_id when set, else generated.
  • examples/evals/suite/suite-session.mdx (new): the suite_session.py cookbook, registered in docs.json after Suite Team Scoring.

Type of Change

  • Bug fix (errors, broken links, outdated info)
  • New content
  • Content improvement
  • Other: ____

Related Issues/PRs (if applicable)

Checklist

  • Content is accurate and up-to-date
  • All links tested and working
  • Code examples verified (if applicable)
  • Deterministic scripts pass for the affected examples, imports, installs, and references
  • OpenAPI JSON and YAML were updated together and scripts/make_openapi.py --check passes (if applicable)
  • mint broken-links -t false and mint validate -t false pass
  • Spelling and grammar checked
  • Screenshots updated (if applicable)

Comment thread evals/suite/overview.mdx
Comment on lines +153 to +161
name="offers_slots_for_the_pictured_venue",
agent=agent,
input=Message(
role="user",
content="I'd like to book a call about a tour of this landmark. Which one is it, and what times do you have?",
images=[Image(url="https://upload.wikimedia.org/wikipedia/commons/0/0c/GoldenGateBridge-001.jpg")],
),
criteria="Names the Golden Gate Bridge and offers Tuesday 10:00 and Wednesday 15:00.",
expected_tool_calls=("get_open_slots",),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This snippet is missing user_id and session_state from the cookbook case.

Comment thread evals/suite/overview.mdx

`session_id`, `user_id`, `session_state`, `dependencies`, `metadata`, and `knowledge_filters` are passed to `agent.arun()` or `team.arun()` for the case's turn. A case that sets none of them runs in a generated session, with the agent or team's own `user_id`, if any, and no state, dependencies, metadata, or filters.

Each run gets its own copy of `session_state` and `dependencies`, so a run that writes into them leaves the `Case` unchanged.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dependencies values that can't be deep copied are passed as the same object, so they are shared across runs. Maybe add: "Values that can't be deep-copied are passed through as is."

@Ayush0054

Copy link
Copy Markdown
Member

wrong repository , please raise prs here : https://github.com/agno-agi/agno-docs/pulls

@harshsinha03

Copy link
Copy Markdown
Contributor Author

wrong repository , please raise prs here : https://github.com/agno-agi/agno-docs/pulls

mb, raising it there, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants