Trace Ingestion
Creates a new trace on Confident AI.
Headers
CONFIDENT_API_KEY
The API key of your Confident AI project.
Request
uuid
This is the unique identifier of the trace.
startTime
This is the time the trace started.
endTime
This is the time the trace ended.
name
This is the name of the trace.
input
This is the input to the trace.
output
This is the output of the trace.
environment
This is the environment where your trace was posted, which helps with separating and debugging traces from different environments on the Confident AI platform.
metadata
This is any additional metadata associated with the trace.
spans
This is the list of base spans associated with the trace.
threadId
This is the unique identifier of the thread associated with the trace.
thread
Thread-level fields applied to the thread record. thread.id is an alternate way to specify the thread (must match top-level threadId if both are provided). metadata and tags only take effect when a thread id is resolvable; successive ingestions merge metadata keys, while tags replace any prior value.
userId
This is the unique identifier for your end user for the trace.
metricCollection
This is the metric collection you wish to use to evaluate the trace.
retrievalContext
This is the retrieval context of your trace, which is to be used for evaluation.
context
This is the ideal retrieval context of your trace, which is to be used for evaluation.
expectedOutput
This is the expected output of your trace, which is the ideal actual output and to be used for evaluation.
toolsCalled
This is the tools called by your trace, which is to be used for evaluation.
expectedTools
This is the expected tools to be called by the trace, which is to be used for evaluation.
attachments
Map of attachment ids to payloads for all [DEEPEVAL:IMAGE:…] and [DEEPEVAL:PDF:…] markers in this trace. Define attachments at the trace level with same ids for same instances.
Response
success
A boolean indicating the success or failure of the API call
data
This maps to the trace id.
link
This is the URL to the trace on the Confident AI platform.
deprecated
This is true if this endpoint is deprecated.