annotation-queues

Get Run From Annotation Queue

Changed on

Get a run from an annotation queue

get/api/v1/annotation-queues/{queue_id}/run/{index}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/annotation-queues/{queue_id}/run/{index}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

queue_idstring uuid required
indexinteger required

Query parameters

include_extraboolean

Response

Successful Response

namestring required
inputsobject nullable
inputs_previewstring nullable
run_type'tool' | 'chain' | 'llm' | 'retriever' | 'embedding' | 'prompt' | 'parser' required

Enum for run types.

start_timestring date-time
end_timestring date-time nullable
extraobject nullable
errorstring nullable
execution_orderinteger
serializedobject nullable
outputsobject nullable
outputs_previewstring nullable
parent_run_idstring uuid nullable
manifest_idstring uuid nullable
manifest_s3_idstring uuid nullable
eventsobject[] nullable
tagsstring[] nullable
inputs_s3_urlsobject nullable
outputs_s3_urlsobject nullable
s3_urlsobject nullable
trace_idstring uuid required
dotted_orderstring required
trace_min_start_timestring date-time nullable
trace_max_start_timestring date-time nullable
idstring uuid required
statusstring required
child_run_idsstring[] nullable
direct_child_run_idsstring[] nullable
parent_run_idsstring[] nullable
feedback_statsobject nullable
reference_example_idstring uuid nullable
total_tokensinteger
prompt_tokensinteger
completion_tokensinteger
prompt_token_detailsobject nullable
completion_token_detailsobject nullable
total_coststring nullable
prompt_coststring nullable
completion_coststring nullable
prompt_cost_detailsobject nullable
completion_cost_detailsobject nullable
price_model_idstring uuid nullable
first_token_timestring date-time nullable
messagesobject[] nullable
session_idstring uuid required
app_pathstring required
last_queued_atstring date-time nullable
in_datasetboolean nullable
share_tokenstring uuid nullable
trace_tier'longlived' | 'shortlived'
trace_first_received_atstring date-time nullable
ttl_secondsinteger nullable
trace_upgradeboolean
reference_dataset_idstring uuid nullable
thread_idstring nullable
queue_run_idstring uuid required
last_reviewed_timestring date-time nullable
added_atstring date-time nullable
effective_added_atstring date-time nullable
reserved_bystring[]
completed_bystring[]
source_proposed_example_idstring uuid nullable

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      endpoint deprecated

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the // response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the // response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

  • a0acb3a6a101Revision changes
    • info

      added the optional property to the response with the status