langfuse_client_base/models/
create_evaluation_rule_request.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 CreateEvaluationRuleRequest {
16    /// Human-readable rule name. Names are not identifiers and do not need to be unique.
17    #[serde(rename = "name")]
18    pub name: String,
19    /// Whether live execution should start immediately. Enabled rules require at least one evaluator assignment.
20    #[serde(rename = "enabled")]
21    pub enabled: bool,
22    /// Fraction of matching observations to evaluate. Omit this field to use the default of `1`, which evaluates every match. `null` is not accepted.
23    #[serde(
24        rename = "sampling",
25        default,
26        with = "::serde_with::rust::double_option",
27        skip_serializing_if = "Option::is_none"
28    )]
29    pub sampling: Option<Option<f64>>,
30    /// Conditions used to select observations. Defaults to an empty list, which matches every incoming observation.
31    #[serde(
32        rename = "filter",
33        default,
34        with = "::serde_with::rust::double_option",
35        skip_serializing_if = "Option::is_none"
36    )]
37    pub filter: Option<Option<Vec<models::EvaluationRuleFilter>>>,
38    /// Evaluators to attach to this rule. Disabled rules may use an empty list as a draft.
39    #[serde(rename = "evaluatorAssignments")]
40    pub evaluator_assignments: Vec<models::EvaluationRuleEvaluatorAssignmentInput>,
41}
42
43impl CreateEvaluationRuleRequest {
44    pub fn new(
45        name: String,
46        enabled: bool,
47        evaluator_assignments: Vec<models::EvaluationRuleEvaluatorAssignmentInput>,
48    ) -> CreateEvaluationRuleRequest {
49        CreateEvaluationRuleRequest {
50            name,
51            enabled,
52            sampling: None,
53            filter: None,
54            evaluator_assignments,
55        }
56    }
57}
langfuse_client_base/models/create_evaluation_rule_request.rs

langfuse_client_base/models/
create_evaluation_rule_request.rs
