APIEvaluators

Submit Evaluator Judgment

Submit Evaluator judgment for an existing Log. Creates a new Log. The evaluated Log will be set as the parent of the created Log.

Headers

X-API-KEYstringRequired

Query parameters

version_idstringOptional
ID of the Evaluator version to log against.
environmentstringOptional
Name of the Environment identifying a deployed version to log to.

Request

This endpoint expects an object.
parent_idstringRequired
Identifier of the evaluated Log. The newly created Log will have this one set as parent.
pathstringOptional

Path of the Evaluator, including the name. This locates the Evaluator in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name or just name.

idstringOptional
ID for an existing Evaluator.
start_timedatetimeOptional
When the logged event started.
end_timedatetimeOptional
When the logged event ended.
outputstringOptional
Generated output from the LLM. Only populated for LLM Evaluator Logs.
created_atdatetimeOptional
User defined timestamp for when the log was created.
errorstringOptional
Error message if the log is an error.
provider_latencydoubleOptional
Duration of the logged event in seconds.
stdoutstringOptional
Captured log and debug statements.
provider_requestmap from strings to anyOptional
Raw request sent to provider. Only populated for LLM Evaluator Logs.
provider_responsemap from strings to anyOptional
Raw response received the provider. Only populated for LLM Evaluator Logs.
inputsmap from strings to anyOptional
The inputs passed to the prompt template.
sourcestringOptional
Identifies where the model was called from.
metadatamap from strings to anyOptional
Any additional metadata to record.
source_datapoint_idstringOptional

Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.

trace_parent_idstringOptional
The ID of the parent Log to nest this Log under in a Trace.
userstringOptional

End-user ID related to the Log.

environmentstringOptional
The name of the Environment the Log is associated to.
savebooleanOptionalDefaults to true

Whether the request/response payloads will be stored on Humanloop.

log_idstringOptional
This will identify a Log. If you don't provide a Log ID, Humanloop will generate one for you.
output_messageobjectOptional
The message returned by the LLM. Only populated for LLM Evaluator Logs.
judgmentboolean or string or list of strings or doubleOptional
Evaluator assessment of the Log.
marked_completedbooleanOptional
Whether the Log has been manually marked as completed by a user.
specobjectOptional

Response

Successful Response
idstring
String identifier of the new Log.
parent_idstring
Identifier of the evaluated parent Log.
version_idstring
Identifier of Evaluator Version for which the Log was registered.
session_idstring or null
Identifier of the Session containing both the parent and the new child Log. If the parent Log does not belong to a Session, a new Session is created with this ID.

Errors