Skip to main content

langfuse_client_base/models/
usage.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/// Usage : (Deprecated. Use usageDetails and costDetails instead.) Standard interface for usage and cost
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct Usage {
17    /// Number of input units (e.g. tokens)
18    #[serde(rename = "input")]
19    pub input: i32,
20    /// Number of output units (e.g. tokens)
21    #[serde(rename = "output")]
22    pub output: i32,
23    /// Defaults to input+output if not set
24    #[serde(rename = "total")]
25    pub total: i32,
26    /// Unit of measurement
27    #[serde(rename = "unit", deserialize_with = "Option::deserialize")]
28    pub unit: Option<String>,
29    /// USD input cost
30    #[serde(
31        rename = "inputCost",
32        default,
33        with = "::serde_with::rust::double_option",
34        skip_serializing_if = "Option::is_none"
35    )]
36    pub input_cost: Option<Option<f64>>,
37    /// USD output cost
38    #[serde(
39        rename = "outputCost",
40        default,
41        with = "::serde_with::rust::double_option",
42        skip_serializing_if = "Option::is_none"
43    )]
44    pub output_cost: Option<Option<f64>>,
45    /// USD total cost, defaults to input+output
46    #[serde(
47        rename = "totalCost",
48        default,
49        with = "::serde_with::rust::double_option",
50        skip_serializing_if = "Option::is_none"
51    )]
52    pub total_cost: Option<Option<f64>>,
53}
54
55impl Usage {
56    /// (Deprecated. Use usageDetails and costDetails instead.) Standard interface for usage and cost
57    pub fn new(input: i32, output: i32, total: i32, unit: Option<String>) -> Usage {
58        Usage {
59            input,
60            output,
61            total,
62            unit,
63            input_cost: None,
64            output_cost: None,
65            total_cost: None,
66        }
67    }
68}