curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/trace_log' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <<PAREA_API_KEY>>' \
--data '{
"trace_id": "<<UUID>>",
"root_trace_id": "<<SAME_UUID>>",
"parent_trace_id": "<<SAME_UUID>>",
"trace_name":"test",
"project_name":"default",
"inputs": {
"x": "Golang",
"y": "Fiber"
},
"start_timestamp":"2024-05-30 13:48:34",
"end_timestamp":"2024-05-30 13:48:35",
"status": "success",
"output": "Some logged output",
"metadata": {"purpose": "testing"}
}'
curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/trace_log' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <<PAREA_API_KEY>>' \
--data '{
"trace_id": "<<UUID>>",
"root_trace_id": "<<SAME_UUID>>",
"parent_trace_id": "<<SAME_UUID>>",
"trace_name": "LLM",
"project_name": "default",
"inputs": {
"promptTemplateVar1": "value",
"promptTemplateVar2": "some other value"
},
"output": "LLM repsonse",
"configuration": {
"model": "gpt-4o",
"provider": "openai",
"messages": [
{
"role": "user",
"content": "Some prompt"
}
]
},
"start_timestamp": "2024-05-30 13:48:34",
"end_timestamp": "2024-05-30 13:48:35",
"status": "success",
"metadata": {"purpose": "testing"}
}'
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Record Trace Log
Log a (LLM) span to visualize inference results, or chains.
curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/trace_log' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <<PAREA_API_KEY>>' \
--data '{
"trace_id": "<<UUID>>",
"root_trace_id": "<<SAME_UUID>>",
"parent_trace_id": "<<SAME_UUID>>",
"trace_name":"test",
"project_name":"default",
"inputs": {
"x": "Golang",
"y": "Fiber"
},
"start_timestamp":"2024-05-30 13:48:34",
"end_timestamp":"2024-05-30 13:48:35",
"status": "success",
"output": "Some logged output",
"metadata": {"purpose": "testing"}
}'
curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/trace_log' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <<PAREA_API_KEY>>' \
--data '{
"trace_id": "<<UUID>>",
"root_trace_id": "<<SAME_UUID>>",
"parent_trace_id": "<<SAME_UUID>>",
"trace_name": "LLM",
"project_name": "default",
"inputs": {
"promptTemplateVar1": "value",
"promptTemplateVar2": "some other value"
},
"output": "LLM repsonse",
"configuration": {
"model": "gpt-4o",
"provider": "openai",
"messages": [
{
"role": "user",
"content": "Some prompt"
}
]
},
"start_timestamp": "2024-05-30 13:48:34",
"end_timestamp": "2024-05-30 13:48:35",
"status": "success",
"metadata": {"purpose": "testing"}
}'
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/trace_log' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <<PAREA_API_KEY>>' \
--data '{
"trace_id": "<<UUID>>",
"root_trace_id": "<<SAME_UUID>>",
"parent_trace_id": "<<SAME_UUID>>",
"trace_name":"test",
"project_name":"default",
"inputs": {
"x": "Golang",
"y": "Fiber"
},
"start_timestamp":"2024-05-30 13:48:34",
"end_timestamp":"2024-05-30 13:48:35",
"status": "success",
"output": "Some logged output",
"metadata": {"purpose": "testing"}
}'
curl --location 'https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/trace_log' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <<PAREA_API_KEY>>' \
--data '{
"trace_id": "<<UUID>>",
"root_trace_id": "<<SAME_UUID>>",
"parent_trace_id": "<<SAME_UUID>>",
"trace_name": "LLM",
"project_name": "default",
"inputs": {
"promptTemplateVar1": "value",
"promptTemplateVar2": "some other value"
},
"output": "LLM repsonse",
"configuration": {
"model": "gpt-4o",
"provider": "openai",
"messages": [
{
"role": "user",
"content": "Some prompt"
}
]
},
"start_timestamp": "2024-05-30 13:48:34",
"end_timestamp": "2024-05-30 13:48:35",
"status": "success",
"metadata": {"purpose": "testing"}
}'
Authorizations
Body
UUID of the trace log. Ex: e3267953-a16f-47f5-b37e-622dbb29d730
Start timestamp
If this log was a LLM call, this will contain the configuration used for the call.
Show child attributes
Show child attributes
Key-value pair inputs of this trace. Note, there is a special field to capture messages in LLM calls. You can still use it in the case of LLM calls to track the key-value pairs for prompt templates.
Response of this step/log/function. If response isn’t a string, it needs to be serialized to a string.
The target or “gold standard†response for the inputs of this log.
Latency of this log in seconds.
If this was a LLM call, this will contain the time taken to generate the first token.
If this was a LLM call, this will contain the number of tokens in the input.
If this was a LLM call, this will contain the number of tokens in the output.
If this was a LLM call, this will contain the total number of tokens in the input and output.
If this was a LLM call, this will contain the cost of the call.
If given, current trace will be a child of this trace. If current child is not a child, parent_trace_id should be equal to trace_id
This is the UUID of the root trace/span of this trace. If current trace is the root trace, root_trace_id must be equal to trace_id
Name of the project with which the trace/log should be associated with. Must be provided if project_uuid is not provided
If the trace was a success or error
If status=error, this should contain any additional information such as the stacktrace
If provided, will be used as output for any specified evaluation metric.
Names of evaluation metrics deployed on Parea which should be applied to this log.
Any scores/eval results associated with this log.
Show child attributes
Show child attributes
Any captured (user) feedback on this log
If specified, evals given with evaluation_metric_names will be applied to this log with this fraction.
If specified, this log and its entire associated trace will logged with this probability. Must be between 0 and 1 (incl.). Defaults to 1.0 (i.e., keeping all logs)
0 <= x <= 1Optionally, provide the ID of the used deployed prompt in this log.
If the cache was hit for this log.
The name of this span.
UUIDs of any children.
IDs of any children. Will be automatically populated.
End timestamp of span.
Unique identifier for a end-user.
Unique identifier for a session. Can you be used to associated multiple logs in e.g. chat applications.
Any additional key-value pairs which provide context or are useful for filtering.
List of tags which provide additional context or are useful for filtering.
If given, will be used to associate this log with an experiment.
Any images associated with trace.
Show child attributes
Show child attributes
Any comments on log which were collected on Parea frontend.
Show child attributes
Show child attributes
Any annotations on log which were collected on Parea frontend. It maps annoation criterion ID to a dictionary mapping user_id (Parea user ID) to annotation.
Show child attributes
Show child attributes
Depth/level of nestedness of span in overall trace. Root-level trace is 0 and it always increments by 1.
The execution number of span in trace. It starts with 0 and increments by 1 with every span.
Deprecated
Deprecated
UUID of project with which this log is associated. Will be automatically filled-in by SDKs
Organization ID associated with Parea API key. Will be automatically determined from API key
Response
Successful Response
Was this page helpful?