Skip to content

Update /evaluate endpoint doc #126

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

Merged
merged 1 commit into from
Apr 14, 2025
Merged

Update /evaluate endpoint doc #126

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
11 changes: 11 additions & 0 deletions docs/source/guides/evaluate-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ limitations under the License.
-->

# Evaluate API Endpoints
:::{note}
It is recommended that the [Evaluating AgentIQ Workflows](./evaluate.md) guide be read before proceeding with this detailed documentation.
:::

The evaluation endpoint can be used to start evaluation jobs on a remote AgentIQ server.

## Evaluation Endpoint Overview
Expand All @@ -27,6 +31,13 @@ graph TD
B --> E["GET /evaluate/jobs"]
```

## Start AgentIQ API Server
See AgentIQ [UI and Server](./using-agentiq-ui-and-server.md) guide for instructions on starting the AgentIQ server.
Sample Usage:
```bash
aiq serve --config_file=examples/simple/configs/config.yml
```

## Evaluate Request and Response
The /evaluate endpoint allows you to start an evaluation job. The request is stored for background processing, and the server returns a job ID for tracking the job status.

Expand Down