langfuse-client-base 0.17.0

Auto-generated Langfuse API client from OpenAPI specification
Documentation
/*
 * 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, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct EvaluatorLlmAsJudgeEvaluator {
    /// Stable identifier of this evaluator across all versions.
    #[serde(rename = "id")]
    pub id: String,
    /// Human-readable evaluator name. Names are not identifiers and do not need to be unique.
    #[serde(rename = "name")]
    pub name: String,
    /// Optional human-readable evaluator description.
    #[serde(rename = "description", deserialize_with = "Option::deserialize")]
    pub description: Option<String>,
    #[serde(rename = "createdBy")]
    pub created_by: models::Creator,
    #[serde(rename = "status")]
    pub status: models::EvaluatorStatus,
    /// Timestamp when the evaluator was paused, otherwise `null`.
    #[serde(rename = "pausedAt", deserialize_with = "Option::deserialize")]
    pub paused_at: Option<chrono::DateTime<chrono::FixedOffset>>,
    /// Machine-readable reason when `status=paused`, otherwise `null`.
    #[serde(rename = "pausedReason", deserialize_with = "Option::deserialize")]
    pub paused_reason: Option<String>,
    /// Human-readable explanation when `status=paused`, otherwise `null`.
    #[serde(rename = "pausedMessage", deserialize_with = "Option::deserialize")]
    pub paused_message: Option<String>,
    /// All modern and legacy evaluation-rule assignments in newest-assignment-first order. Rule-specific mappings are exposed as `variableMappingOverride`; inherited defaults are omitted.
    #[serde(rename = "evaluationRuleAssignments")]
    pub evaluation_rule_assignments: Vec<models::EvaluationRuleAssignment>,
    /// Timestamp when the evaluator was created.
    #[serde(rename = "createdAt")]
    pub created_at: chrono::DateTime<chrono::FixedOffset>,
    /// Timestamp when the evaluator was last updated.
    #[serde(rename = "updatedAt")]
    pub updated_at: chrono::DateTime<chrono::FixedOffset>,
    /// Stable identifier of the latest evaluator version.
    #[serde(rename = "versionId")]
    pub version_id: String,
    /// Monotonically increasing latest evaluator version number.
    #[serde(rename = "version")]
    pub version: i64,
    /// Timestamp when the latest evaluator version was created.
    #[serde(rename = "versionCreatedAt")]
    pub version_created_at: chrono::DateTime<chrono::FixedOffset>,
    #[serde(rename = "versionCreatedBy")]
    pub version_created_by: models::Creator,
    #[serde(rename = "type")]
    pub r#type: Type,
    /// An ordered list of chat messages. A system message is only allowed as the first message.
    #[serde(rename = "prompt")]
    pub prompt: Vec<models::EvaluatorChatMessage>,
    /// Variables extracted from the latest prompt and available for evaluation-rule mappings.
    #[serde(rename = "variables")]
    pub variables: Vec<String>,
    /// Default variable mapping for the latest version, or `null` when no default is configured.
    #[serde(rename = "variableMapping", deserialize_with = "Option::deserialize")]
    pub variable_mapping: Option<Vec<models::PromptVariableMappingRead>>,
    #[serde(rename = "modelConfig")]
    pub model_config: models::EvaluatorModelConfig,
    #[serde(rename = "outputDefinition")]
    pub output_definition: models::PublicEvaluatorOutputDefinition,
}

impl EvaluatorLlmAsJudgeEvaluator {
    pub fn new(
        id: String,
        name: String,
        description: Option<String>,
        created_by: models::Creator,
        status: models::EvaluatorStatus,
        paused_at: Option<chrono::DateTime<chrono::FixedOffset>>,
        paused_reason: Option<String>,
        paused_message: Option<String>,
        evaluation_rule_assignments: Vec<models::EvaluationRuleAssignment>,
        created_at: chrono::DateTime<chrono::FixedOffset>,
        updated_at: chrono::DateTime<chrono::FixedOffset>,
        version_id: String,
        version: i64,
        version_created_at: chrono::DateTime<chrono::FixedOffset>,
        version_created_by: models::Creator,
        r#type: Type,
        prompt: Vec<models::EvaluatorChatMessage>,
        variables: Vec<String>,
        variable_mapping: Option<Vec<models::PromptVariableMappingRead>>,
        model_config: models::EvaluatorModelConfig,
        output_definition: models::PublicEvaluatorOutputDefinition,
    ) -> EvaluatorLlmAsJudgeEvaluator {
        EvaluatorLlmAsJudgeEvaluator {
            id,
            name,
            description,
            created_by,
            status,
            paused_at,
            paused_reason,
            paused_message,
            evaluation_rule_assignments,
            created_at,
            updated_at,
            version_id,
            version,
            version_created_at,
            version_created_by,
            r#type,
            prompt,
            variables,
            variable_mapping,
            model_config,
            output_definition,
        }
    }
}
///
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
    #[serde(rename = "llm_as_judge")]
    LlmAsJudge,
    /// A value this client does not know. It is not kept: this serializes as `"unknown"`, which the API does not list.
    #[serde(rename = "unknown", other)]
    Unknown,
}

impl ::std::fmt::Display for Type {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        f.write_str(match self {
            Self::LlmAsJudge => "llm_as_judge",
            Self::Unknown => "unknown",
        })
    }
}

impl ::std::str::FromStr for Type {
    type Err = crate::models::ParseEnumError;

    fn from_str(value: &str) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
        match value {
            "llm_as_judge" => Ok(Self::LlmAsJudge),
            _ => Err(crate::models::ParseEnumError::new("Type", value)),
        }
    }
}

impl ::std::convert::TryFrom<&str> for Type {
    type Error = crate::models::ParseEnumError;

    fn try_from(value: &str) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
        value.parse()
    }
}

impl ::std::convert::TryFrom<&::std::string::String> for Type {
    type Error = crate::models::ParseEnumError;

    fn try_from(
        value: &::std::string::String,
    ) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
        value.parse()
    }
}

impl ::std::convert::TryFrom<::std::string::String> for Type {
    type Error = crate::models::ParseEnumError;

    fn try_from(
        value: ::std::string::String,
    ) -> ::std::result::Result<Self, crate::models::ParseEnumError> {
        value.parse()
    }
}