langfuse-client-base 0.14.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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

/*
 * server
 *
 * ## 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
 *
 * 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 Observation {
    /// The unique identifier of the observation
    #[serde(rename = "id")]
    pub id: String,
    /// The trace ID associated with the observation
    #[serde(rename = "traceId", deserialize_with = "Option::deserialize")]
    pub trace_id: Option<String>,
    /// The type of the observation
    #[serde(rename = "type")]
    pub r#type: String,
    /// The name of the observation
    #[serde(rename = "name", deserialize_with = "Option::deserialize")]
    pub name: Option<String>,
    /// The start time of the observation
    #[serde(rename = "startTime")]
    pub start_time: chrono::DateTime<chrono::FixedOffset>,
    /// The end time of the observation.
    #[serde(rename = "endTime", deserialize_with = "Option::deserialize")]
    pub end_time: Option<chrono::DateTime<chrono::FixedOffset>>,
    /// The completion start time of the observation
    #[serde(
        rename = "completionStartTime",
        deserialize_with = "Option::deserialize"
    )]
    pub completion_start_time: Option<chrono::DateTime<chrono::FixedOffset>>,
    /// The model used for the observation
    #[serde(rename = "model", deserialize_with = "Option::deserialize")]
    pub model: Option<String>,
    /// The parameters of the model used for the observation
    #[serde(rename = "modelParameters", deserialize_with = "Option::deserialize")]
    pub model_parameters: Option<serde_json::Value>,
    /// The input data of the observation
    #[serde(rename = "input", deserialize_with = "Option::deserialize")]
    pub input: Option<serde_json::Value>,
    /// The version of the observation
    #[serde(rename = "version", deserialize_with = "Option::deserialize")]
    pub version: Option<String>,
    /// Additional metadata of the observation
    #[serde(rename = "metadata", deserialize_with = "Option::deserialize")]
    pub metadata: Option<serde_json::Value>,
    /// The output data of the observation
    #[serde(rename = "output", deserialize_with = "Option::deserialize")]
    pub output: Option<serde_json::Value>,
    #[serde(rename = "usage")]
    pub usage: Box<models::Usage>,
    #[serde(rename = "level")]
    pub level: models::ObservationLevel,
    /// The status message of the observation
    #[serde(rename = "statusMessage", deserialize_with = "Option::deserialize")]
    pub status_message: Option<String>,
    /// The parent observation ID
    #[serde(
        rename = "parentObservationId",
        deserialize_with = "Option::deserialize"
    )]
    pub parent_observation_id: Option<String>,
    /// The prompt ID associated with the observation
    #[serde(rename = "promptId", deserialize_with = "Option::deserialize")]
    pub prompt_id: Option<String>,
    /// The usage details of the observation. Key is the name of the usage metric, value is the number of units consumed. The total key is the sum of all (non-total) usage metrics or the total value ingested.
    #[serde(rename = "usageDetails")]
    pub usage_details: std::collections::HashMap<String, i32>,
    /// The cost details of the observation. Key is the name of the cost metric, value is the cost in USD. The total key is the sum of all (non-total) cost metrics or the total value ingested.
    #[serde(rename = "costDetails")]
    pub cost_details: std::collections::HashMap<String, f64>,
    /// The environment from which this observation originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'.
    #[serde(rename = "environment")]
    pub environment: String,
}

impl Observation {
    pub fn new(
        id: String,
        trace_id: Option<String>,
        r#type: String,
        name: Option<String>,
        start_time: chrono::DateTime<chrono::FixedOffset>,
        end_time: Option<chrono::DateTime<chrono::FixedOffset>>,
        completion_start_time: Option<chrono::DateTime<chrono::FixedOffset>>,
        model: Option<String>,
        model_parameters: Option<serde_json::Value>,
        input: Option<serde_json::Value>,
        version: Option<String>,
        metadata: Option<serde_json::Value>,
        output: Option<serde_json::Value>,
        usage: models::Usage,
        level: models::ObservationLevel,
        status_message: Option<String>,
        parent_observation_id: Option<String>,
        prompt_id: Option<String>,
        usage_details: std::collections::HashMap<String, i32>,
        cost_details: std::collections::HashMap<String, f64>,
        environment: String,
    ) -> Observation {
        Observation {
            id,
            trace_id,
            r#type,
            name,
            start_time,
            end_time,
            completion_start_time,
            model,
            model_parameters,
            input,
            version,
            metadata,
            output,
            usage: Box::new(usage),
            level,
            status_message,
            parent_observation_id,
            prompt_id,
            usage_details,
            cost_details,
            environment,
        }
    }
}