langfuse_client_base/models/open_ai_completion_usage_schema.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/// OpenAiCompletionUsageSchema : OpenAI Usage schema from (Chat-)Completion APIs
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
16pub struct OpenAiCompletionUsageSchema {
17 #[serde(rename = "prompt_tokens")]
18 pub prompt_tokens: i32,
19 #[serde(rename = "completion_tokens")]
20 pub completion_tokens: i32,
21 #[serde(rename = "total_tokens")]
22 pub total_tokens: i32,
23 #[serde(
24 rename = "prompt_tokens_details",
25 default,
26 with = "::serde_with::rust::double_option",
27 skip_serializing_if = "Option::is_none"
28 )]
29 pub prompt_tokens_details: Option<Option<std::collections::HashMap<String, i32>>>,
30 #[serde(
31 rename = "completion_tokens_details",
32 default,
33 with = "::serde_with::rust::double_option",
34 skip_serializing_if = "Option::is_none"
35 )]
36 pub completion_tokens_details: Option<Option<std::collections::HashMap<String, i32>>>,
37}
38
39impl OpenAiCompletionUsageSchema {
40 /// OpenAI Usage schema from (Chat-)Completion APIs
41 pub fn new(
42 prompt_tokens: i32,
43 completion_tokens: i32,
44 total_tokens: i32,
45 ) -> OpenAiCompletionUsageSchema {
46 OpenAiCompletionUsageSchema {
47 prompt_tokens,
48 completion_tokens,
49 total_tokens,
50 prompt_tokens_details: None,
51 completion_tokens_details: None,
52 }
53 }
54}