langfuse-client-base 0.15.0

Auto-generated Langfuse API client from OpenAPI specification
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

/*
 * 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 crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct Experiment {
    #[serde(rename = "id")]
    pub id: String,
    #[serde(rename = "name")]
    pub name: String,
    #[serde(rename = "description", deserialize_with = "Option::deserialize")]
    pub description: Option<String>,
    /// Start of the experiment, i.e. the earliest event within the requested time range. Clipped to `fromStartTime` when the experiment started before the requested range.
    #[serde(rename = "startTime")]
    pub start_time: chrono::DateTime<chrono::FixedOffset>,
    /// End of the experiment, i.e. the latest event end within the requested time range.
    #[serde(rename = "endTime")]
    pub end_time: chrono::DateTime<chrono::FixedOffset>,
    /// Number of experiment items within the requested time range.
    #[serde(rename = "itemCount")]
    pub item_count: i32,
    /// Null when the experiment is not associated with a dataset.
    #[serde(rename = "datasetId", deserialize_with = "Option::deserialize")]
    pub dataset_id: Option<String>,
    /// Included only when `fields=metadata` is requested.
    #[serde(
        rename = "metadata",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub metadata: Option<Option<std::collections::HashMap<String, serde_json::Value>>>,
    /// Included only when `fields=scores` is requested. Contains scores directly attached to the experiment.
    #[serde(
        rename = "scores",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub scores: Option<Option<Vec<models::ScoreV3>>>,
}

impl Experiment {
    pub fn new(
        id: String,
        name: String,
        description: Option<String>,
        start_time: chrono::DateTime<chrono::FixedOffset>,
        end_time: chrono::DateTime<chrono::FixedOffset>,
        item_count: i32,
        dataset_id: Option<String>,
    ) -> Experiment {
        Experiment {
            id,
            name,
            description,
            start_time,
            end_time,
            item_count,
            dataset_id,
            metadata: None,
            scores: None,
        }
    }
}