API Reference
- POSTCompletion
- GETGet Prompt
- PUTUpdate Prompt
- POSTGet Model Parameters
- 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
Create Evaluation
Create a new evaluation.
POST
/
sdk
/
v1
/
evaluations
Copy
import PromptFoundry from '@prompt-foundry/typescript-sdk';
const client = new PromptFoundry({
apiKey: process.env['PROMPT_FOUNDRY_API_KEY'], // This is the default and can be omitted
});
async function main() {
const evaluation = await client.evaluations.create({
appendedMessages: [
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
role: 'assistant',
},
],
promptId: 'promptId',
variables: { foo: 'string' },
});
console.log(evaluation.id);
}
main();
Copy
{
"id": "<string>",
"promptId": "<string>",
"appendedMessages": [
{
"content": [
{
"type": "TEXT",
"text": "<string>"
}
],
"role": "assistant"
}
],
"variables": {},
"weight": 1,
"threshold": 1
}
Body
application/json
Response
201
application/json
Successful operation
The response is of type object
.
Was this page helpful?
Copy
import PromptFoundry from '@prompt-foundry/typescript-sdk';
const client = new PromptFoundry({
apiKey: process.env['PROMPT_FOUNDRY_API_KEY'], // This is the default and can be omitted
});
async function main() {
const evaluation = await client.evaluations.create({
appendedMessages: [
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
role: 'assistant',
},
{
content: [
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
{ text: 'text', type: 'TEXT' },
],
role: 'assistant',
},
],
promptId: 'promptId',
variables: { foo: 'string' },
});
console.log(evaluation.id);
}
main();
Copy
{
"id": "<string>",
"promptId": "<string>",
"appendedMessages": [
{
"content": [
{
"type": "TEXT",
"text": "<string>"
}
],
"role": "assistant"
}
],
"variables": {},
"weight": 1,
"threshold": 1
}
Assistant
Responses are generated using AI and may contain mistakes.