Record Trace Log

POST

api

parea

trace_log

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"}
}'

"<any>"

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"}
}'

Authorizations

x-user-id

string

header

required

Body

application/json

trace_id

string

required

UUID of the trace log. Ex: e3267953-a16f-47f5-b37e-622dbb29d730

start_timestamp

string

required

Start timestamp

configuration

object

If this log was a LLM call, this will contain the configuration used for the call.

inputs

object | null

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.

output

string | null

Response of this step/log/function. If response isnâ€™t a string, it needs to be serialized to a string.

target

string | null

The target or â€œgold standardâ€ response for the inputs of this log.

latency

number | null

default:

Latency of this log in seconds.

time_to_first_token

number | null

If this was a LLM call, this will contain the time taken to generate the first token.

input_tokens

integer | null

default:

If this was a LLM call, this will contain the number of tokens in the input.

output_tokens

integer | null

default:

If this was a LLM call, this will contain the number of tokens in the output.

total_tokens

integer | null

default:

If this was a LLM call, this will contain the total number of tokens in the input and output.

cost

number | null

default:

If this was a LLM call, this will contain the cost of the call.

parent_trace_id

string | null

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

root_trace_id

string | null

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

project_name

string | null

Name of the project with which the trace/log should be associated with. Must be provided if project_uuid is not provided

status

string | null

If the trace was a success or error

error

string | null

If status=error, this should contain any additional information such as the stacktrace

output_for_eval_metrics

string | null

If provided, will be used as output for any specified evaluation metric.

evaluation_metric_names

string[] | null

Names of evaluation metrics deployed on Parea which should be applied to this log.

scores

object[] | null

Any scores/eval results associated with this log.

feedback_score

number | null

Any captured (user) feedback on this log

apply_eval_frac

number | null

default:

If specified, evals given with evaluation_metric_names will be applied to this log with this fraction.

log_sample_rate

number | null

default:

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)

Required range: 0 < x < 1

deployment_id

string | null

Optionally, provide the ID of the used deployed prompt in this log.

cache_hit

boolean

default:

false

If the cache was hit for this log.

trace_name

string | null

The name of this span.

children

string[] | null

UUIDs of any children.

children_ids

integer[] | null

IDs of any children. Will be automatically populated.

end_timestamp

string | null

End timestamp of span.

end_user_identifier

string | null

Unique identifier for a end-user.

session_id

string | null

Unique identifier for a session. Can you be used to associated multiple logs in e.g. chat applications.

metadata

object | null

Any additional key-value pairs which provide context or are useful for filtering.

Response

200

application/json

Successful Response

The response is of type any.

Was this page helpful?

Health Check Record Feedback

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"}
}'

"<any>"

General

Tracing

Experiments

LLM Proxy

Datasets

SDK

Authorizations

Body

Response