#![allow(deprecated)]
/*
* 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};
/// BlobStorageExportFieldGroup : Field group selecting which columns are included in the export. Applies to all export sources. - Observation groups (`core` through `trace_context`) select observation columns; groups without a counterpart in the legacy data model (e.g. `trace_context`) are omitted from the legacy observations export. - Score groups (`score_` prefix) add optional columns to the scores export. The core score columns (`id`, `timestamp`, `trace_id`, `name`, `value`, …) are always exported and are not a selectable group; score groups add columns on top of them. `score_metadata` adds the score `metadata` column. `score_provenance` adds the references to where a score came from: `author_user_id`, `config_id`, `queue_id`, `evaluator_id`, `evaluation_rule_id`, `execution_trace_id`. Score groups are never selected by default.
/// Field group selecting which columns are included in the export. Applies to all export sources. - Observation groups (`core` through `trace_context`) select observation columns; groups without a counterpart in the legacy data model (e.g. `trace_context`) are omitted from the legacy observations export. - Score groups (`score_` prefix) add optional columns to the scores export. The core score columns (`id`, `timestamp`, `trace_id`, `name`, `value`, …) are always exported and are not a selectable group; score groups add columns on top of them. `score_metadata` adds the score `metadata` column. `score_provenance` adds the references to where a score came from: `author_user_id`, `config_id`, `queue_id`, `evaluator_id`, `evaluation_rule_id`, `execution_trace_id`. Score groups are never selected by default.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum BlobStorageExportFieldGroup {
#[serde(rename = "core")]
Core,
#[serde(rename = "basic")]
Basic,
#[serde(rename = "time")]
Time,
#[serde(rename = "io")]
Io,
#[serde(rename = "metadata")]
Metadata,
#[serde(rename = "model")]
Model,
#[serde(rename = "usage")]
Usage,
#[serde(rename = "prompt")]
Prompt,
#[serde(rename = "metrics")]
Metrics,
#[serde(rename = "tools")]
Tools,
#[serde(rename = "trace_context")]
TraceContext,
#[serde(rename = "score_metadata")]
ScoreMetadata,
#[serde(rename = "score_provenance")]
ScoreProvenance,
/// 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 BlobStorageExportFieldGroup {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Self::Core => write!(f, "core"),
Self::Basic => write!(f, "basic"),
Self::Time => write!(f, "time"),
Self::Io => write!(f, "io"),
Self::Metadata => write!(f, "metadata"),
Self::Model => write!(f, "model"),
Self::Usage => write!(f, "usage"),
Self::Prompt => write!(f, "prompt"),
Self::Metrics => write!(f, "metrics"),
Self::Tools => write!(f, "tools"),
Self::TraceContext => write!(f, "trace_context"),
Self::ScoreMetadata => write!(f, "score_metadata"),
Self::ScoreProvenance => write!(f, "score_provenance"),
Self::Unknown => write!(f, "unknown"),
}
}
}
impl crate::models::validation::Validate for BlobStorageExportFieldGroup {
fn validate_into(
&self,
_path: &crate::models::validation::Path<'_>,
_errors: &mut Vec<crate::models::validation::ValidationError>,
) {
}
}
impl ::std::str::FromStr for BlobStorageExportFieldGroup {
type Err = crate::models::ParseEnumError;
fn from_str(value: &str) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
match value {
"core" => Ok(Self::Core),
"basic" => Ok(Self::Basic),
"time" => Ok(Self::Time),
"io" => Ok(Self::Io),
"metadata" => Ok(Self::Metadata),
"model" => Ok(Self::Model),
"usage" => Ok(Self::Usage),
"prompt" => Ok(Self::Prompt),
"metrics" => Ok(Self::Metrics),
"tools" => Ok(Self::Tools),
"trace_context" => Ok(Self::TraceContext),
"score_metadata" => Ok(Self::ScoreMetadata),
"score_provenance" => Ok(Self::ScoreProvenance),
_ => Err(crate::models::ParseEnumError::new(
"BlobStorageExportFieldGroup",
value,
)),
}
}
}
impl ::std::convert::TryFrom<&str> for BlobStorageExportFieldGroup {
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 BlobStorageExportFieldGroup {
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 BlobStorageExportFieldGroup {
type Error = crate::models::ParseEnumError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
value.parse()
}
}