Skip to main content

langfuse_client_base/models/
project.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#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
15pub struct Project {
16    #[serde(rename = "id")]
17    pub id: String,
18    #[serde(rename = "name")]
19    pub name: String,
20    #[serde(rename = "organization")]
21    pub organization: Box<models::Organization>,
22    /// Metadata for the project
23    #[serde(rename = "metadata")]
24    pub metadata: std::collections::HashMap<String, serde_json::Value>,
25    /// Number of days to retain data. Null or 0 means no retention. Omitted if no retention is configured.
26    #[serde(
27        rename = "retentionDays",
28        default,
29        with = "::serde_with::rust::double_option",
30        skip_serializing_if = "Option::is_none"
31    )]
32    pub retention_days: Option<Option<i32>>,
33}
34
35impl Project {
36    pub fn new(
37        id: String,
38        name: String,
39        organization: models::Organization,
40        metadata: std::collections::HashMap<String, serde_json::Value>,
41    ) -> Project {
42        Project {
43            id,
44            name,
45            organization: Box::new(organization),
46            metadata,
47            retention_days: None,
48        }
49    }
50}