langfuse_client_base/models/dataset_run.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 DatasetRun {
16 /// Unique identifier of the dataset run
17 #[serde(rename = "id")]
18 pub id: String,
19 /// Name of the dataset run
20 #[serde(rename = "name")]
21 pub name: String,
22 /// Description of the run
23 #[serde(rename = "description", deserialize_with = "Option::deserialize")]
24 pub description: Option<String>,
25 /// Metadata of the dataset run
26 #[serde(rename = "metadata", deserialize_with = "Option::deserialize")]
27 pub metadata: Option<serde_json::Value>,
28 /// Id of the associated dataset
29 #[serde(rename = "datasetId")]
30 pub dataset_id: String,
31 /// Name of the associated dataset
32 #[serde(rename = "datasetName")]
33 pub dataset_name: String,
34 /// The date and time when the dataset run was created
35 #[serde(rename = "createdAt")]
36 pub created_at: chrono::DateTime<chrono::FixedOffset>,
37 /// The date and time when the dataset run was last updated
38 #[serde(rename = "updatedAt")]
39 pub updated_at: chrono::DateTime<chrono::FixedOffset>,
40}
41
42impl DatasetRun {
43 pub fn new(
44 id: String,
45 name: String,
46 description: Option<String>,
47 metadata: Option<serde_json::Value>,
48 dataset_id: String,
49 dataset_name: String,
50 created_at: chrono::DateTime<chrono::FixedOffset>,
51 updated_at: chrono::DateTime<chrono::FixedOffset>,
52 ) -> DatasetRun {
53 DatasetRun {
54 id,
55 name,
56 description,
57 metadata,
58 dataset_id,
59 dataset_name,
60 created_at,
61 updated_at,
62 }
63 }
64}