langfuse_client_base/apis/
observations_v2_api.rs

1/*
2 * langfuse
3 *
4 * ## 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 - Postman collection: https://cloud.langfuse.com/generated/postman/collection.json
5 *
6 * The version of the OpenAPI document:
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use super::{configuration, ContentType, Error};
12use crate::{apis::ResponseContent, models};
13use reqwest;
14use serde::{de::Error as _, Deserialize, Serialize};
15
16/// struct for typed errors of method [`observations_v2_get_many`]
17#[derive(Debug, Clone, Serialize, Deserialize)]
18#[serde(untagged)]
19pub enum ObservationsV2GetManyError {
20    Status400(serde_json::Value),
21    Status401(serde_json::Value),
22    Status403(serde_json::Value),
23    Status404(serde_json::Value),
24    Status405(serde_json::Value),
25    UnknownValue(serde_json::Value),
26}
27
28/// Get a list of observations with cursor-based pagination and flexible field selection.  ## Cursor-based Pagination This endpoint uses cursor-based pagination for efficient traversal of large datasets. The cursor is returned in the response metadata and should be passed in subsequent requests to retrieve the next page of results.  ## Field Selection Use the `fields` parameter to control which observation fields are returned: - `core` - Always included: id, traceId, startTime, endTime, projectId, parentObservationId, type - `basic` - name, level, statusMessage, version, environment, bookmarked, public, userId, sessionId - `time` - completionStartTime, createdAt, updatedAt - `io` - input, output - `metadata` - metadata (truncated to 200 chars by default, use `expandMetadata` to get full values) - `model` - providedModelName, internalModelId, modelParameters - `usage` - usageDetails, costDetails, totalCost - `prompt` - promptId, promptName, promptVersion - `metrics` - latency, timeToFirstToken  If not specified, `core` and `basic` field groups are returned.  ## Filters Multiple filtering options are available via query parameters or the structured `filter` parameter. When using the `filter` parameter, it takes precedence over individual query parameter filters.
29#[bon::builder]
30pub async fn observations_v2_get_many(
31    configuration: &configuration::Configuration,
32    fields: Option<&str>,
33    expand_metadata: Option<&str>,
34    limit: Option<i32>,
35    cursor: Option<&str>,
36    parse_io_as_json: Option<bool>,
37    name: Option<&str>,
38    user_id: Option<&str>,
39    r#type: Option<&str>,
40    trace_id: Option<&str>,
41    level: Option<models::ObservationLevel>,
42    parent_observation_id: Option<&str>,
43    environment: Option<Vec<String>>,
44    from_start_time: Option<String>,
45    to_start_time: Option<String>,
46    version: Option<&str>,
47    filter: Option<&str>,
48) -> Result<models::ObservationsV2Response, Error<ObservationsV2GetManyError>> {
49    // add a prefix to parameters to efficiently prevent name collisions
50    let p_query_fields = fields;
51    let p_query_expand_metadata = expand_metadata;
52    let p_query_limit = limit;
53    let p_query_cursor = cursor;
54    let p_query_parse_io_as_json = parse_io_as_json;
55    let p_query_name = name;
56    let p_query_user_id = user_id;
57    let p_query_type = r#type;
58    let p_query_trace_id = trace_id;
59    let p_query_level = level;
60    let p_query_parent_observation_id = parent_observation_id;
61    let p_query_environment = environment;
62    let p_query_from_start_time = from_start_time;
63    let p_query_to_start_time = to_start_time;
64    let p_query_version = version;
65    let p_query_filter = filter;
66
67    let uri_str = format!("{}/api/public/v2/observations", configuration.base_path);
68    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
69
70    if let Some(ref param_value) = p_query_fields {
71        req_builder = req_builder.query(&[("fields", &param_value.to_string())]);
72    }
73    if let Some(ref param_value) = p_query_expand_metadata {
74        req_builder = req_builder.query(&[("expandMetadata", &param_value.to_string())]);
75    }
76    if let Some(ref param_value) = p_query_limit {
77        req_builder = req_builder.query(&[("limit", &param_value.to_string())]);
78    }
79    if let Some(ref param_value) = p_query_cursor {
80        req_builder = req_builder.query(&[("cursor", &param_value.to_string())]);
81    }
82    if let Some(ref param_value) = p_query_parse_io_as_json {
83        req_builder = req_builder.query(&[("parseIoAsJson", &param_value.to_string())]);
84    }
85    if let Some(ref param_value) = p_query_name {
86        req_builder = req_builder.query(&[("name", &param_value.to_string())]);
87    }
88    if let Some(ref param_value) = p_query_user_id {
89        req_builder = req_builder.query(&[("userId", &param_value.to_string())]);
90    }
91    if let Some(ref param_value) = p_query_type {
92        req_builder = req_builder.query(&[("type", &param_value.to_string())]);
93    }
94    if let Some(ref param_value) = p_query_trace_id {
95        req_builder = req_builder.query(&[("traceId", &param_value.to_string())]);
96    }
97    if let Some(ref param_value) = p_query_level {
98        req_builder = req_builder.query(&[("level", &param_value.to_string())]);
99    }
100    if let Some(ref param_value) = p_query_parent_observation_id {
101        req_builder = req_builder.query(&[("parentObservationId", &param_value.to_string())]);
102    }
103    if let Some(ref param_value) = p_query_environment {
104        req_builder = match "multi" {
105            "multi" => req_builder.query(
106                &param_value
107                    .into_iter()
108                    .map(|p| ("environment".to_owned(), p.to_string()))
109                    .collect::<Vec<(std::string::String, std::string::String)>>(),
110            ),
111            _ => req_builder.query(&[(
112                "environment",
113                &param_value
114                    .into_iter()
115                    .map(|p| p.to_string())
116                    .collect::<Vec<String>>()
117                    .join(",")
118                    .to_string(),
119            )]),
120        };
121    }
122    if let Some(ref param_value) = p_query_from_start_time {
123        req_builder = req_builder.query(&[("fromStartTime", &param_value.to_string())]);
124    }
125    if let Some(ref param_value) = p_query_to_start_time {
126        req_builder = req_builder.query(&[("toStartTime", &param_value.to_string())]);
127    }
128    if let Some(ref param_value) = p_query_version {
129        req_builder = req_builder.query(&[("version", &param_value.to_string())]);
130    }
131    if let Some(ref param_value) = p_query_filter {
132        req_builder = req_builder.query(&[("filter", &param_value.to_string())]);
133    }
134    if let Some(ref user_agent) = configuration.user_agent {
135        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
136    }
137    if let Some(ref auth_conf) = configuration.basic_auth {
138        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
139    };
140
141    let req = req_builder.build()?;
142    let resp = configuration.client.execute(req).await?;
143
144    let status = resp.status();
145    let content_type = resp
146        .headers()
147        .get("content-type")
148        .and_then(|v| v.to_str().ok())
149        .unwrap_or("application/octet-stream");
150    let content_type = super::ContentType::from(content_type);
151
152    if !status.is_client_error() && !status.is_server_error() {
153        let content = resp.text().await?;
154        match content_type {
155            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
156            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::ObservationsV2Response`"))),
157            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::ObservationsV2Response`")))),
158        }
159    } else {
160        let content = resp.text().await?;
161        let entity: Option<ObservationsV2GetManyError> = serde_json::from_str(&content).ok();
162        Err(Error::ResponseError(ResponseContent {
163            status,
164            content,
165            entity,
166        }))
167    }
168}
langfuse_client_base/apis/observations_v2_api.rs

langfuse_client_base/apis/
observations_v2_api.rs
