Skip to content

docs: clarify response context capture #334

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
koriyoshi2041 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify response context capture #334

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: 7 additions & 0 deletions docs/tutorial-hosted-agent-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,13 @@ request_field: message
response_field: text
```

If your endpoint returns retrieval context or retrieved documents in the same
JSON response as the answer, capture those fields with `response_fields` instead
of relying only on static dataset `context`. In evaluator `input_mapping`,
`$context` still refers to the dataset row, while `$response.context` refers to
the context captured from the live endpoint response. See
[`how-it-works.md`](how-it-works.md) for the full grey-box retrieval example.

The `.agentops/.env` file is intentional: AgentOps keeps local Azure values out
of source control while eval, Doctor, and Cockpit commands resolve the same
workspace environment. The Foundry project endpoint lives there instead of in
Expand Down