Skip to main content

langfuse_client_base/models/
public_api_error_code.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/// PublicApiErrorCode : Stable machine-readable error code returned by the evaluators and evaluation-rules API.
15/// Stable machine-readable error code returned by the evaluators and evaluation-rules API.
16#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
17pub enum PublicApiErrorCode {
18    #[serde(rename = "authentication_failed")]
19    AuthenticationFailed,
20    #[serde(rename = "access_denied")]
21    AccessDenied,
22    #[serde(rename = "invalid_request")]
23    InvalidRequest,
24    #[serde(rename = "invalid_query")]
25    InvalidQuery,
26    #[serde(rename = "invalid_body")]
27    InvalidBody,
28    #[serde(rename = "resource_not_found")]
29    ResourceNotFound,
30    #[serde(rename = "conflict")]
31    Conflict,
32    #[serde(rename = "rate_limited")]
33    RateLimited,
34    #[serde(rename = "method_not_allowed")]
35    MethodNotAllowed,
36    #[serde(rename = "internal_error")]
37    InternalError,
38}
39
40impl std::fmt::Display for PublicApiErrorCode {
41    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
42        match self {
43            Self::AuthenticationFailed => write!(f, "authentication_failed"),
44            Self::AccessDenied => write!(f, "access_denied"),
45            Self::InvalidRequest => write!(f, "invalid_request"),
46            Self::InvalidQuery => write!(f, "invalid_query"),
47            Self::InvalidBody => write!(f, "invalid_body"),
48            Self::ResourceNotFound => write!(f, "resource_not_found"),
49            Self::Conflict => write!(f, "conflict"),
50            Self::RateLimited => write!(f, "rate_limited"),
51            Self::MethodNotAllowed => write!(f, "method_not_allowed"),
52            Self::InternalError => write!(f, "internal_error"),
53        }
54    }
55}
56
57impl Default for PublicApiErrorCode {
58    fn default() -> PublicApiErrorCode {
59        Self::AuthenticationFailed
60    }
61}