/*
* 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 serde::{Deserialize, Serialize};
/// BlobStorageExportSource : What data the integration exports. - `LEGACY_TRACES_OBSERVATIONS`: traces, observations, and scores tables. Observation columns are controlled by `exportFieldGroups`; field groups without a counterpart in this data model (e.g. `trace_context`) are omitted. - `OBSERVATIONS_V2`: same data model as the `/api/public/v2/observations` endpoint, plus scores. Columns are controlled by `exportFieldGroups`. - `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS`: both sets. Observation columns of both portions are controlled by `exportFieldGroups`. **Note:** which sources a deployment accepts depends on how far it has moved to the v4 data model. `OBSERVATIONS_V2` and the enriched-observations portion of `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS` read the enriched observations table, so they require a deployment that already populates it. `LEGACY_TRACES_OBSERVATIONS` and the legacy portion of `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS` read the legacy traces and observations tables, so they require a deployment that still populates those. A deployment part-way through the migration populates both and accepts every source. Selecting a source the deployment cannot serve is rejected with `400`, rather than exporting an empty result. See <https://langfuse.com/docs/v4>.
/// What data the integration exports. - `LEGACY_TRACES_OBSERVATIONS`: traces, observations, and scores tables. Observation columns are controlled by `exportFieldGroups`; field groups without a counterpart in this data model (e.g. `trace_context`) are omitted. - `OBSERVATIONS_V2`: same data model as the `/api/public/v2/observations` endpoint, plus scores. Columns are controlled by `exportFieldGroups`. - `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS`: both sets. Observation columns of both portions are controlled by `exportFieldGroups`. **Note:** which sources a deployment accepts depends on how far it has moved to the v4 data model. `OBSERVATIONS_V2` and the enriched-observations portion of `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS` read the enriched observations table, so they require a deployment that already populates it. `LEGACY_TRACES_OBSERVATIONS` and the legacy portion of `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS` read the legacy traces and observations tables, so they require a deployment that still populates those. A deployment part-way through the migration populates both and accepts every source. Selecting a source the deployment cannot serve is rejected with `400`, rather than exporting an empty result. See <https://langfuse.com/docs/v4>.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum BlobStorageExportSource {
#[serde(rename = "LEGACY_TRACES_OBSERVATIONS")]
LegacyTracesObservations,
#[serde(rename = "OBSERVATIONS_V2")]
ObservationsV2,
#[serde(rename = "LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS")]
LegacyTracesAndEnrichedObservations,
/// A value this client does not know. It is not kept: this serializes as `"unknown"`, which the API does not list.
#[serde(rename = "unknown", other)]
Unknown,
}
impl std::fmt::Display for BlobStorageExportSource {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Self::LegacyTracesObservations => write!(f, "LEGACY_TRACES_OBSERVATIONS"),
Self::ObservationsV2 => write!(f, "OBSERVATIONS_V2"),
Self::LegacyTracesAndEnrichedObservations => {
write!(f, "LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS")
}
Self::Unknown => write!(f, "unknown"),
}
}
}
impl ::std::str::FromStr for BlobStorageExportSource {
type Err = crate::models::ParseEnumError;
fn from_str(value: &str) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
match value {
"LEGACY_TRACES_OBSERVATIONS" => Ok(Self::LegacyTracesObservations),
"OBSERVATIONS_V2" => Ok(Self::ObservationsV2),
"LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS" => {
Ok(Self::LegacyTracesAndEnrichedObservations)
}
_ => Err(crate::models::ParseEnumError::new(
"BlobStorageExportSource",
value,
)),
}
}
}
impl ::std::convert::TryFrom<&str> for BlobStorageExportSource {
type Error = crate::models::ParseEnumError;
fn try_from(value: &str) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for BlobStorageExportSource {
type Error = crate::models::ParseEnumError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for BlobStorageExportSource {
type Error = crate::models::ParseEnumError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
value.parse()
}
}