API Reference
List Evaluations
- Documentation
- API Reference
- POSTGet Model Parameters
- GETGet Prompt
- PUTUpdate Prompt
- DELDelete Prompt
- GETList Prompts
- POSTCreate Prompt
- GETList tools
- POSTCreates tool
- GETGet Tool
- PUTUpdate tool
- DELDelete tool
- GETList Evaluation Assertions
- POSTCreate Evaluation Assertion
- GETGet Evaluation Assertion
- PUTUpdate Evaluation Assertion
- DELDelete Evaluation Assertion
- GETList Evaluations
- POSTCreate Evaluation
- GETGet Evaluation
- PUTUpdate Evaluation
- DELDelete Evaluation
API Reference
API Reference
List Evaluations
Retrieve all evaluations
GET
/
sdk
/
v1
/
evaluations
X-API-KEY
string
*
X-API-KEY
Required
string
curl --request GET \
--url https://api.promptfoundry.ai/sdk/v1/evaluations[
{
"id": "<string>",
"promptId": "<string>",
"appendedMessages": [
{
"content": "<string>",
"role": "assistant",
"toolCallId": "<string>",
"toolCalls": [
{
"toolCallId": "<string>",
"type": "function",
"function": {
"arguments": "<string>",
"name": "<string>"
}
}
]
}
],
"variables": {}
}
]Response
200 - application/json
id
string
requiredpromptId
string
requiredappendedMessages
object[]
requiredThe messages to append to the completion messages when running the evaluation.
appendedMessages.content
string | null
requiredExample: "Hello, {{city}}!"
appendedMessages.role
enum<string>
requiredAvailable options:
assistant, system, tool, user appendedMessages.toolCallId
string | null
requiredappendedMessages.toolCalls
object[] | null
requiredappendedMessages.toolCalls.toolCallId
string
requiredTOOL_CALL_1
appendedMessages.toolCalls.type
enum<string>
requiredThe type of the tool. Currently, only function is supported.
Available options:
function appendedMessages.toolCalls.function
object
requiredappendedMessages.toolCalls.function.arguments
string
requiredThe arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
appendedMessages.toolCalls.function.name
string
requiredThe name of the function to call.
variables
object
requiredThe template variables added to the prompt when executing the prompt.
curl --request GET \
--url https://api.promptfoundry.ai/sdk/v1/evaluations[
{
"id": "<string>",
"promptId": "<string>",
"appendedMessages": [
{
"content": "<string>",
"role": "assistant",
"toolCallId": "<string>",
"toolCalls": [
{
"toolCallId": "<string>",
"type": "function",
"function": {
"arguments": "<string>",
"name": "<string>"
}
}
]
}
],
"variables": {}
}
]