/*
* server
*
* ## Real-time data The only real-time path to get tracing data is to ingest via OpenTelemetry (`POST /api/public/otel/v1/traces`) and retrieve via Observations API v2 (`GET /api/public/v2/observations`) and Metrics API v2 (`GET /api/public/v2/metrics`). Other public API write and read endpoints can delay data by about 10 minutes. Direct OpenTelemetry exporters must send the `x-langfuse-ingestion-version: 4` header; current Python and JS SDKs already do. See the [Public API docs](https://langfuse.com/docs/api-and-data-platform/features/public-api) and [real-time ingestion](https://langfuse.com/integrations/native/opentelemetry.md#real-time-ingestion). ## Authentication Authenticate with the API using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), get API keys in the project settings: - username: Langfuse Public Key - password: Langfuse Secret Key ## Exports - OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml - Self-hosted deployments: interactive API reference at `/api/docs` and OpenAPI spec at `/api/openapi.yaml`
*
* The version of the OpenAPI document:
*
* Generated by: https://openapi-generator.tech
*/
use super::{configuration, ContentType, Error};
use crate::{apis::ResponseContent, models};
use reqwest;
use serde::{de::Error as _, Deserialize, Serialize};
/// struct for typed errors of method [`experiments_list`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ExperimentsListError {
Status400(serde_json::Value),
Status401(serde_json::Value),
Status403(serde_json::Value),
Status404(serde_json::Value),
Status405(serde_json::Value),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`experiments_list_items`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ExperimentsListItemsError {
Status400(serde_json::Value),
Status401(serde_json::Value),
Status403(serde_json::Value),
Status404(serde_json::Value),
Status405(serde_json::Value),
UnknownValue(serde_json::Value),
}
/// List experiments with cursor-based pagination. Results are ordered by latest experiment activity descending.
#[bon::builder]
pub async fn experiments_list(
configuration: &configuration::Configuration,
from_start_time: chrono::DateTime<chrono::FixedOffset>,
fields: Option<&str>,
limit: Option<i32>,
score_limit: Option<i32>,
cursor: Option<&str>,
to_start_time: Option<chrono::DateTime<chrono::FixedOffset>>,
id: Option<&str>,
name: Option<&str>,
dataset_id: Option<&str>,
filter: Option<&str>,
) -> Result<models::ExperimentsResponse, Error<ExperimentsListError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_query_from_start_time = from_start_time;
let p_query_fields = fields;
let p_query_limit = limit;
let p_query_score_limit = score_limit;
let p_query_cursor = cursor;
let p_query_to_start_time = to_start_time;
let p_query_id = id;
let p_query_name = name;
let p_query_dataset_id = dataset_id;
let p_query_filter = filter;
let uri_str = format!("{}/api/public/experiments", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
if let Some(ref param_value) = p_query_fields {
req_builder = req_builder.query(&[("fields", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_limit {
req_builder = req_builder.query(&[("limit", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_score_limit {
req_builder = req_builder.query(&[("scoreLimit", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_cursor {
req_builder = req_builder.query(&[("cursor", ¶m_value.to_string())]);
}
req_builder = req_builder.query(&[("fromStartTime", &p_query_from_start_time.to_string())]);
if let Some(ref param_value) = p_query_to_start_time {
req_builder = req_builder.query(&[("toStartTime", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_id {
req_builder = req_builder.query(&[("id", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_name {
req_builder = req_builder.query(&[("name", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_dataset_id {
req_builder = req_builder.query(&[("datasetId", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_filter {
req_builder = req_builder.query(&[("filter", ¶m_value.to_string())]);
}
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref auth_conf) = configuration.basic_auth {
req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
};
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::ExperimentsResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::ExperimentsResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<ExperimentsListError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent {
status,
content,
entity,
}))
}
}
/// List experiment items with cursor-based pagination. Use this endpoint to export experiment item inputs, outputs, expected outputs, metadata, and optionally item/trace scores. Results are ordered by time descending.
#[bon::builder]
pub async fn experiments_list_items(
configuration: &configuration::Configuration,
from_start_time: chrono::DateTime<chrono::FixedOffset>,
fields: Option<&str>,
limit: Option<i32>,
score_limit: Option<i32>,
cursor: Option<&str>,
to_start_time: Option<chrono::DateTime<chrono::FixedOffset>>,
experiment_id: Option<&str>,
experiment_name: Option<&str>,
experiment_item_id: Option<&str>,
dataset_id: Option<&str>,
filter: Option<&str>,
) -> Result<models::ExperimentItemsResponse, Error<ExperimentsListItemsError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_query_from_start_time = from_start_time;
let p_query_fields = fields;
let p_query_limit = limit;
let p_query_score_limit = score_limit;
let p_query_cursor = cursor;
let p_query_to_start_time = to_start_time;
let p_query_experiment_id = experiment_id;
let p_query_experiment_name = experiment_name;
let p_query_experiment_item_id = experiment_item_id;
let p_query_dataset_id = dataset_id;
let p_query_filter = filter;
let uri_str = format!("{}/api/public/experiment-items", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
if let Some(ref param_value) = p_query_fields {
req_builder = req_builder.query(&[("fields", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_limit {
req_builder = req_builder.query(&[("limit", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_score_limit {
req_builder = req_builder.query(&[("scoreLimit", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_cursor {
req_builder = req_builder.query(&[("cursor", ¶m_value.to_string())]);
}
req_builder = req_builder.query(&[("fromStartTime", &p_query_from_start_time.to_string())]);
if let Some(ref param_value) = p_query_to_start_time {
req_builder = req_builder.query(&[("toStartTime", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_experiment_id {
req_builder = req_builder.query(&[("experimentId", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_experiment_name {
req_builder = req_builder.query(&[("experimentName", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_experiment_item_id {
req_builder = req_builder.query(&[("experimentItemId", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_dataset_id {
req_builder = req_builder.query(&[("datasetId", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_filter {
req_builder = req_builder.query(&[("filter", ¶m_value.to_string())]);
}
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref auth_conf) = configuration.basic_auth {
req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
};
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::ExperimentItemsResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::ExperimentItemsResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<ExperimentsListItemsError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent {
status,
content,
entity,
}))
}
}