/*
* 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 CorrectionScoreV31 {
#[serde(rename = "id")]
pub id: String,
#[serde(rename = "projectId")]
pub project_id: String,
#[serde(rename = "name")]
pub name: String,
#[serde(rename = "source")]
pub source: models::ScoreSource,
#[serde(rename = "timestamp")]
pub timestamp: chrono::DateTime<chrono::FixedOffset>,
/// The environment from which this score originated.
#[serde(rename = "environment")]
pub environment: String,
#[serde(rename = "createdAt")]
pub created_at: chrono::DateTime<chrono::FixedOffset>,
#[serde(rename = "updatedAt")]
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
/// Optional comment attached to the score. Present when \"details\" is included in the fields parameter.
#[serde(
rename = "comment",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub comment: Option<Option<String>>,
/// The score config ID, if this score was created from a config. Present when \"details\" is included in the fields parameter.
#[serde(
rename = "configId",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub config_id: Option<Option<String>>,
/// Arbitrary metadata attached to the score. Present when \"details\" is included in the fields parameter.
#[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>>>,
/// The user who created this score, if available. Present when \"annotation\" is included in the fields parameter.
#[serde(
rename = "authorUserId",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub author_user_id: Option<Option<String>>,
/// The annotation queue this score belongs to, if any. Present when \"annotation\" is included in the fields parameter.
#[serde(
rename = "queueId",
default,
with = "::serde_with::rust::double_option",
skip_serializing_if = "Option::is_none"
)]
pub queue_id: Option<Option<String>>,
#[serde(rename = "subject", skip_serializing_if = "Option::is_none")]
pub subject: Option<Box<models::ScoreSubjectV3>>,
/// The correction content of the score. Empty string if not set.
#[serde(rename = "value")]
pub value: String,
#[serde(rename = "dataType")]
pub data_type: DataType,
}
impl CorrectionScoreV31 {
pub fn new(
id: String,
project_id: String,
name: String,
source: models::ScoreSource,
timestamp: chrono::DateTime<chrono::FixedOffset>,
environment: String,
created_at: chrono::DateTime<chrono::FixedOffset>,
updated_at: chrono::DateTime<chrono::FixedOffset>,
value: String,
data_type: DataType,
) -> CorrectionScoreV31 {
CorrectionScoreV31 {
id,
project_id,
name,
source,
timestamp,
environment,
created_at,
updated_at,
comment: None,
config_id: None,
metadata: None,
author_user_id: None,
queue_id: None,
subject: None,
value,
data_type,
}
}
}
///
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum DataType {
#[serde(rename = "CORRECTION")]
Correction,
}
impl Default for DataType {
fn default() -> DataType {
Self::Correction
}
}