langfuse_client_base/models/public_api_error.rs
1/*
2 * server
3 *
4 * ## 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`
5 *
6 * The version of the OpenAPI document:
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// PublicApiError : Standard error response for the stable evaluators and evaluation-rules API. Use the HTTP status for the broad failure class and `code` for programmatic handling. `details` is included when field-level validation or retry information is available.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct PublicApiError {
17 /// Human-readable description of the failure.
18 #[serde(rename = "message")]
19 pub message: String,
20 #[serde(rename = "code")]
21 pub code: models::PublicApiErrorCode,
22 #[serde(rename = "details", skip_serializing_if = "Option::is_none")]
23 pub details: Option<Box<models::PublicApiErrorDetails>>,
24}
25
26impl PublicApiError {
27 /// Standard error response for the stable evaluators and evaluation-rules API. Use the HTTP status for the broad failure class and `code` for programmatic handling. `details` is included when field-level validation or retry information is available.
28 pub fn new(message: String, code: models::PublicApiErrorCode) -> PublicApiError {
29 PublicApiError {
30 message,
31 code,
32 details: None,
33 }
34 }
35}