List task columns
curl --request GET \
--url https://my.orq.ai/v3/experiments/{experiment_id}/runs/{run_id}/tasks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.orq.ai/v3/experiments/{experiment_id}/runs/{run_id}/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.orq.ai/v3/experiments/{experiment_id}/runs/{run_id}/tasks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"column_id": "<string>",
"key": "<string>",
"display_name": "<string>",
"position": 123,
"active": true,
"prompt": {
"prompt_config": {
"model": "<string>",
"provider": "<string>",
"messages": [
{}
],
"model_parameters": {},
"model_db_id": "<string>",
"model_type": "<string>",
"integration_id": "<string>",
"stream": true,
"version": "<string>"
},
"messages_source": "MESSAGES_SOURCE_UNSPECIFIED",
"engine": "<string>",
"tools": [
{}
],
"knowledge_bases": [
{}
],
"metadata": {}
},
"agent": {
"agent_key": "<string>",
"messages_source": "MESSAGES_SOURCE_UNSPECIFIED",
"messages": [
{}
],
"engine": "<string>",
"parent_id": "<string>",
"agent_tag": "<string>"
},
"openresponse": {},
"evaluator": {
"evaluator_id": "<string>",
"evaluator_name": "<string>",
"evaluator_type": "<string>",
"evaluator_output_type": "<string>"
},
"annotation": {
"annotation_id": "<string>",
"annotation_name": "<string>",
"annotation_type": "<string>"
},
"dataset": {
"column_type": "<string>"
},
"metric": {
"metric_key": "<string>"
},
"job_output": {
"job_name": "<string>"
},
"width": 123
}
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}Columns
List task columns
Lists the task columns of a run: prompt, agent and openresponse columns.
GET
/
v3
/
experiments
/
{experiment_id}
/
runs
/
{run_id}
/
tasks
List task columns
curl --request GET \
--url https://my.orq.ai/v3/experiments/{experiment_id}/runs/{run_id}/tasks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.orq.ai/v3/experiments/{experiment_id}/runs/{run_id}/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.orq.ai/v3/experiments/{experiment_id}/runs/{run_id}/tasks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"column_id": "<string>",
"key": "<string>",
"display_name": "<string>",
"position": 123,
"active": true,
"prompt": {
"prompt_config": {
"model": "<string>",
"provider": "<string>",
"messages": [
{}
],
"model_parameters": {},
"model_db_id": "<string>",
"model_type": "<string>",
"integration_id": "<string>",
"stream": true,
"version": "<string>"
},
"messages_source": "MESSAGES_SOURCE_UNSPECIFIED",
"engine": "<string>",
"tools": [
{}
],
"knowledge_bases": [
{}
],
"metadata": {}
},
"agent": {
"agent_key": "<string>",
"messages_source": "MESSAGES_SOURCE_UNSPECIFIED",
"messages": [
{}
],
"engine": "<string>",
"parent_id": "<string>",
"agent_tag": "<string>"
},
"openresponse": {},
"evaluator": {
"evaluator_id": "<string>",
"evaluator_name": "<string>",
"evaluator_type": "<string>",
"evaluator_output_type": "<string>"
},
"annotation": {
"annotation_id": "<string>",
"annotation_name": "<string>",
"annotation_type": "<string>"
},
"dataset": {
"column_type": "<string>"
},
"metric": {
"metric_key": "<string>"
},
"job_output": {
"job_name": "<string>"
},
"width": 123
}
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}Related guide: Experiments guide. See the Experiments guide for a walkthrough with examples.
Authorizations
Was this page helpful?