p = Parea(api_key="PAREA_API_KEY") # replace with your API key
exp_uuids = p.list_experiment_uuids(ListExperimentUUIDsFilters())
const p = new Parea("PAREA_API_KEY"); // replace with your API key
const uuids = await p.listExperimentUUIDS();
curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/experiments' \
--header 'Content-Type: application/json' \
--header 'x-api-key: PAREA_API_KEY' \
--data '{
"experiment_name_filter": "Hello World",
"metadata_filter": {
"purpose": "testing"
},
"project_name": "development",
"run_name_filter": "v1"
}'
[
{
"created_at": "2024-04-15 22:19:13",
"is_public": false,
"metadata": {
"dataset": "dev 123"
},
"name": "greeting",
"num_samples": 6,
"pinned_stats": [
{
"operation": "mean",
"value": 0.176471,
"var1": "levenshtein"
},
{
"operation": "mean",
"value": 0.00002,
"var1": "Cost"
},
{
"operation": "mean",
"value": 11,
"var1": "Total Tokens"
},
{
"operation": "mean",
"value": 9,
"var1": "Output Tokens"
},
{
"operation": "mean",
"value": 2,
"var1": "Input Tokens"
},
{
"operation": "mean",
"value": 0.65273,
"var1": "Latency"
}
],
"project_uuid": "...",
"run_name": "bijou-kail",
"status": "completed",
"uuid": "..."
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}List Experiments
Lists experiments given a set of filters incl. their high-level statistics.
p = Parea(api_key="PAREA_API_KEY") # replace with your API key
exp_uuids = p.list_experiment_uuids(ListExperimentUUIDsFilters())
const p = new Parea("PAREA_API_KEY"); // replace with your API key
const uuids = await p.listExperimentUUIDS();
curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/experiments' \
--header 'Content-Type: application/json' \
--header 'x-api-key: PAREA_API_KEY' \
--data '{
"experiment_name_filter": "Hello World",
"metadata_filter": {
"purpose": "testing"
},
"project_name": "development",
"run_name_filter": "v1"
}'
[
{
"created_at": "2024-04-15 22:19:13",
"is_public": false,
"metadata": {
"dataset": "dev 123"
},
"name": "greeting",
"num_samples": 6,
"pinned_stats": [
{
"operation": "mean",
"value": 0.176471,
"var1": "levenshtein"
},
{
"operation": "mean",
"value": 0.00002,
"var1": "Cost"
},
{
"operation": "mean",
"value": 11,
"var1": "Total Tokens"
},
{
"operation": "mean",
"value": 9,
"var1": "Output Tokens"
},
{
"operation": "mean",
"value": 2,
"var1": "Input Tokens"
},
{
"operation": "mean",
"value": 0.65273,
"var1": "Latency"
}
],
"project_uuid": "...",
"run_name": "bijou-kail",
"status": "completed",
"uuid": "..."
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}p = Parea(api_key="PAREA_API_KEY") # replace with your API key
exp_uuids = p.list_experiment_uuids(ListExperimentUUIDsFilters())
const p = new Parea("PAREA_API_KEY"); // replace with your API key
const uuids = await p.listExperimentUUIDS();
curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/experiments' \
--header 'Content-Type: application/json' \
--header 'x-api-key: PAREA_API_KEY' \
--data '{
"experiment_name_filter": "Hello World",
"metadata_filter": {
"purpose": "testing"
},
"project_name": "development",
"run_name_filter": "v1"
}'
Authorizations
Body
Name of the project to filter experiments by.
Filters experiments to contain the given metadata. The metadata_filter is a dictionary where the keys are the metadata keys and the values are the metadata values to filter by.
Filters experiments to contain the given string in their name.
Filters experiments to contain the given string in their run name.
Filters experiments to contain the given UUIDs.
Response
Successful Response
Name of the experiment
UUID of the project associated with this experiment
UUID of the created experiment
Timestamp the experiment was created
Status of the experiment
pending, running, completed, failed List of population/dataset-level statistics. Typically contains mean of any reported scores, latencies, etc.
Show child attributes
Show child attributes
Name of the run. Must be unique for each experiment and can only contain alphanumeric characters, hyphens, and underscores.
If experiment should be public
Any additional key-value pairs which provide context or are useful for filtering.
Show child attributes
Show child attributes
Number of samples in the experiment
Was this page helpful?