tracer-sessions

Read Tracer Sessions

Changed on

List all projects.

get/api/v1/sessions

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/sessions
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Query parameters

reference_freeboolean nullable
reference_datasetstring[] nullable
idstring[] nullable
namestring nullable
name_containsstring nullable
dataset_versionstring nullable
sort_by'name' | 'start_time' | 'last_run_start_time' | 'latency_p50' | 'latency_p99' | 'error_rate' | 'feedback'
sort_by_descboolean
metadatastring nullable
sort_by_feedback_keystring nullable
sort_by_feedback_source'session' | 'run'
offsetinteger
limitinteger
tag_value_idstring[] nullable
facetsboolean
filterstring nullable
include_statsboolean
use_approx_statsboolean
stats_start_timestring date-time nullable
stats_selectstring[] nullable
stats_filterstring nullable

Headers

acceptstring nullable

Response

Successful Response

start_timestring date-time
end_timestring date-time nullable
extraobject nullable
namestring
descriptionstring nullable
default_dataset_idstring uuid nullable
reference_dataset_idstring uuid nullable
trace_tier'longlived' | 'shortlived'
idstring uuid required
run_countinteger nullable
latency_p50number nullable
latency_p99number nullable
first_token_p50number nullable
first_token_p99number nullable
total_tokensinteger nullable
prompt_tokensinteger nullable
completion_tokensinteger nullable
total_coststring nullable
prompt_coststring nullable
completion_coststring nullable
tenant_idstring uuid required
last_run_start_timestring date-time nullable
last_run_start_time_livestring date-time nullable
feedback_statsobject nullable
session_feedback_statsobject nullable
run_facetsobject[] nullable
error_ratenumber nullable
streaming_ratenumber nullable
test_run_numberinteger nullable

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      removed the enum value runs_count from the query request parameter sort_by

    • 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

      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

  • d3056703d8deRevision changes
    • info

      added the optional property / to the response with the status