Edit on GitHub

langfuse.api.legacy.score_v1

class CreateScoreRequest(langfuse.api.core.pydantic_utilities.UniversalBaseModel):

Examples

from langfuse.scores import CreateScoreRequest

CreateScoreRequest( name="novelty", value=0.9, trace_id="cdef-1234-5678-90ab", )

id: Optional[str]
trace_id: Annotated[Optional[str], <langfuse.api.core.serialization.FieldMetadata object at 0x7f234aaf9e50>]
session_id: Annotated[Optional[str], <langfuse.api.core.serialization.FieldMetadata object at 0x7f234a92eed0>]
observation_id: Annotated[Optional[str], <langfuse.api.core.serialization.FieldMetadata object at 0x7f234a938a10>]
dataset_run_id: Annotated[Optional[str], <langfuse.api.core.serialization.FieldMetadata object at 0x7f234a938b90>]
name: str
value: Union[float, str]

The value of the score. Must be passed as string for categorical and text scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false). Text score values must be between 1 and 500 characters.

comment: Optional[str]
metadata: Optional[Dict[str, Any]]
environment: Optional[str]

The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'.

queue_id: Annotated[Optional[str], <langfuse.api.core.serialization.FieldMetadata object at 0x7f234a938d90>]

The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.

data_type: Annotated[Optional[langfuse.api.ScoreDataType], <langfuse.api.core.serialization.FieldMetadata object at 0x7f234a939150>]

The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric.

config_id: Annotated[Optional[str], <langfuse.api.core.serialization.FieldMetadata object at 0x7f234a939210>]

Reference a score config on a score. The unique langfuse identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated.

source: Optional[CreateScoreSource]

The source of the score. Defaults to API. Set to ANNOTATION to prefill scores (e.g. from an LLM) for a human reviewer to verify in an annotation queue. When source is ANNOTATION, a configId is required unless dataType is CORRECTION. EVAL is reserved for internal evaluator outputs and is not accepted on this endpoint.

model_config: ClassVar[pydantic.config.ConfigDict] = {'protected_namespaces': (), 'extra': 'allow', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CreateScoreResponse(langfuse.api.core.pydantic_utilities.UniversalBaseModel):

!!! abstract "Usage Documentation" Models

A base class for creating Pydantic models.

Attributes:
  • __class_vars__: The names of the class variables defined on the model.
  • __private_attributes__: Metadata about the private attributes of the model.
  • __signature__: The synthesized __init__ [Signature][inspect.Signature] of the model.
  • __pydantic_complete__: Whether model building is completed, or if there are still undefined fields.
  • __pydantic_core_schema__: The core schema of the model.
  • __pydantic_custom_init__: Whether the model has a custom __init__ function.
  • __pydantic_decorators__: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
  • __pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.
  • __pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models.
  • __pydantic_post_init__: The name of the post-init method for the model, if defined.
  • __pydantic_root_model__: Whether the model is a [RootModel][pydantic.root_model.RootModel].
  • __pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model.
  • __pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.
  • __pydantic_fields__: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.
  • __pydantic_computed_fields__: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
  • __pydantic_extra__: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to 'allow'.
  • __pydantic_fields_set__: The names of fields explicitly set during instantiation.
  • __pydantic_private__: Values of private attributes set on the model instance.
id: str

The id of the created object in Langfuse

model_config: ClassVar[pydantic.config.ConfigDict] = {'protected_namespaces': (), 'extra': 'allow', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CreateScoreSource(enum.StrEnum):

Source values accepted when creating a score via the public REST API. EVAL is reserved for internal evaluator outputs and is intentionally not exposed here — use commons.ScoreSource when reading scores.

API = <CreateScoreSource.API: 'API'>
ANNOTATION = <CreateScoreSource.ANNOTATION: 'ANNOTATION'>
def visit( self, api: Callable[[], ~T_Result], annotation: Callable[[], ~T_Result]) -> ~T_Result: