langfuse.api

 9class AccessDeniedError(ApiError):
10    def __init__(self, body: typing.Any):
11        super().__init__(status_code=403, body=body)

11class BaseEvent(pydantic_v1.BaseModel):
12    id: str = pydantic_v1.Field()
13    """
14    UUID v4 that identifies the event
15    """
16
17    timestamp: str = pydantic_v1.Field()
18    """
19    Datetime (ISO 8601) of event creation in client. Should be as close to actual event creation in client as possible, this timestamp will be used for ordering of events in future release. Resolution: milliseconds (required), microseconds (optimal).
20    """
21
22    metadata: typing.Optional[typing.Any] = pydantic_v1.Field(default=None)
23    """
24    Optional. Metadata field used by the Langfuse SDKs for debugging.
25    """
26
27    def json(self, **kwargs: typing.Any) -> str:
28        kwargs_with_defaults: typing.Any = {
29            "by_alias": True,
30            "exclude_unset": True,
31            **kwargs,
32        }
33        return super().json(**kwargs_with_defaults)
34
35    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
36        kwargs_with_defaults: typing.Any = {
37            "by_alias": True,
38            "exclude_unset": True,
39            **kwargs,
40        }
41        return super().dict(**kwargs_with_defaults)
42
43    class Config:
44        frozen = True
45        smart_union = True
46        extra = pydantic_v1.Extra.allow
47        json_encoders = {dt.datetime: serialize_datetime}

43    class Config:
44        frozen = True
45        smart_union = True
46        extra = pydantic_v1.Extra.allow
47        json_encoders = {dt.datetime: serialize_datetime}

11class BasePrompt(pydantic_v1.BaseModel):
12    name: str
13    version: int
14    config: typing.Any
15    labels: typing.List[str] = pydantic_v1.Field()
16    """
17    List of deployment labels of this prompt version.
18    """
19
20    tags: typing.List[str] = pydantic_v1.Field()
21    """
22    List of tags. Used to filter via UI and API. The same across versions of a prompt.
23    """
24
25    def json(self, **kwargs: typing.Any) -> str:
26        kwargs_with_defaults: typing.Any = {
27            "by_alias": True,
28            "exclude_unset": True,
29            **kwargs,
30        }
31        return super().json(**kwargs_with_defaults)
32
33    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
34        kwargs_with_defaults: typing.Any = {
35            "by_alias": True,
36            "exclude_unset": True,
37            **kwargs,
38        }
39        return super().dict(**kwargs_with_defaults)
40
41    class Config:
42        frozen = True
43        smart_union = True
44        extra = pydantic_v1.Extra.allow
45        json_encoders = {dt.datetime: serialize_datetime}

41    class Config:
42        frozen = True
43        smart_union = True
44        extra = pydantic_v1.Extra.allow
45        json_encoders = {dt.datetime: serialize_datetime}

12class BaseScore(pydantic_v1.BaseModel):
13    id: str
14    trace_id: str = pydantic_v1.Field(alias="traceId")
15    name: str
16    source: ScoreSource
17    observation_id: typing.Optional[str] = pydantic_v1.Field(
18        alias="observationId", default=None
19    )
20    timestamp: dt.datetime
21    created_at: dt.datetime = pydantic_v1.Field(alias="createdAt")
22    updated_at: dt.datetime = pydantic_v1.Field(alias="updatedAt")
23    author_user_id: typing.Optional[str] = pydantic_v1.Field(
24        alias="authorUserId", default=None
25    )
26    comment: typing.Optional[str] = None
27    config_id: typing.Optional[str] = pydantic_v1.Field(alias="configId", default=None)
28    """
29    Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range
30    """
31
32    def json(self, **kwargs: typing.Any) -> str:
33        kwargs_with_defaults: typing.Any = {
34            "by_alias": True,
35            "exclude_unset": True,
36            **kwargs,
37        }
38        return super().json(**kwargs_with_defaults)
39
40    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
41        kwargs_with_defaults: typing.Any = {
42            "by_alias": True,
43            "exclude_unset": True,
44            **kwargs,
45        }
46        return super().dict(**kwargs_with_defaults)
47
48    class Config:
49        frozen = True
50        smart_union = True
51        allow_population_by_field_name = True
52        populate_by_name = True
53        extra = pydantic_v1.Extra.allow
54        json_encoders = {dt.datetime: serialize_datetime}

48    class Config:
49        frozen = True
50        smart_union = True
51        allow_population_by_field_name = True
52        populate_by_name = True
53        extra = pydantic_v1.Extra.allow
54        json_encoders = {dt.datetime: serialize_datetime}

12class BooleanScore(BaseScore):
13    value: float = pydantic_v1.Field()
14    """
15    The numeric value of the score. Equals 1 for "True" and 0 for "False"
16    """
17
18    string_value: str = pydantic_v1.Field(alias="stringValue")
19    """
20    The string representation of the score value. Is inferred from the numeric value and equals "True" or "False"
21    """
22
23    def json(self, **kwargs: typing.Any) -> str:
24        kwargs_with_defaults: typing.Any = {
25            "by_alias": True,
26            "exclude_unset": True,
27            **kwargs,
28        }
29        return super().json(**kwargs_with_defaults)
30
31    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
32        kwargs_with_defaults: typing.Any = {
33            "by_alias": True,
34            "exclude_unset": True,
35            **kwargs,
36        }
37        return super().dict(**kwargs_with_defaults)
38
39    class Config:
40        frozen = True
41        smart_union = True
42        allow_population_by_field_name = True
43        populate_by_name = True
44        extra = pydantic_v1.Extra.allow
45        json_encoders = {dt.datetime: serialize_datetime}

39    class Config:
40        frozen = True
41        smart_union = True
42        allow_population_by_field_name = True
43        populate_by_name = True
44        extra = pydantic_v1.Extra.allow
45        json_encoders = {dt.datetime: serialize_datetime}

12class CategoricalScore(BaseScore):
13    value: typing.Optional[float] = pydantic_v1.Field(default=None)
14    """
15    Only defined if a config is linked. Represents the numeric category mapping of the stringValue
16    """
17
18    string_value: str = pydantic_v1.Field(alias="stringValue")
19    """
20    The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category
21    """
22
23    def json(self, **kwargs: typing.Any) -> str:
24        kwargs_with_defaults: typing.Any = {
25            "by_alias": True,
26            "exclude_unset": True,
27            **kwargs,
28        }
29        return super().json(**kwargs_with_defaults)
30
31    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
32        kwargs_with_defaults: typing.Any = {
33            "by_alias": True,
34            "exclude_unset": True,
35            **kwargs,
36        }
37        return super().dict(**kwargs_with_defaults)
38
39    class Config:
40        frozen = True
41        smart_union = True
42        allow_population_by_field_name = True
43        populate_by_name = True
44        extra = pydantic_v1.Extra.allow
45        json_encoders = {dt.datetime: serialize_datetime}

39    class Config:
40        frozen = True
41        smart_union = True
42        allow_population_by_field_name = True
43        populate_by_name = True
44        extra = pydantic_v1.Extra.allow
45        json_encoders = {dt.datetime: serialize_datetime}

11class ChatMessage(pydantic_v1.BaseModel):
12    role: str
13    content: str
14
15    def json(self, **kwargs: typing.Any) -> str:
16        kwargs_with_defaults: typing.Any = {
17            "by_alias": True,
18            "exclude_unset": True,
19            **kwargs,
20        }
21        return super().json(**kwargs_with_defaults)
22
23    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
24        kwargs_with_defaults: typing.Any = {
25            "by_alias": True,
26            "exclude_unset": True,
27            **kwargs,
28        }
29        return super().dict(**kwargs_with_defaults)
30
31    class Config:
32        frozen = True
33        smart_union = True
34        extra = pydantic_v1.Extra.allow
35        json_encoders = {dt.datetime: serialize_datetime}

31    class Config:
32        frozen = True
33        smart_union = True
34        extra = pydantic_v1.Extra.allow
35        json_encoders = {dt.datetime: serialize_datetime}

13class ChatPrompt(BasePrompt):
14    prompt: typing.List[ChatMessage]
15
16    def json(self, **kwargs: typing.Any) -> str:
17        kwargs_with_defaults: typing.Any = {
18            "by_alias": True,
19            "exclude_unset": True,
20            **kwargs,
21        }
22        return super().json(**kwargs_with_defaults)
23
24    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
25        kwargs_with_defaults: typing.Any = {
26            "by_alias": True,
27            "exclude_unset": True,
28            **kwargs,
29        }
30        return super().dict(**kwargs_with_defaults)
31
32    class Config:
33        frozen = True
34        smart_union = True
35        allow_population_by_field_name = True
36        populate_by_name = True
37        extra = pydantic_v1.Extra.allow
38        json_encoders = {dt.datetime: serialize_datetime}

32    class Config:
33        frozen = True
34        smart_union = True
35        allow_population_by_field_name = True
36        populate_by_name = True
37        extra = pydantic_v1.Extra.allow
38        json_encoders = {dt.datetime: serialize_datetime}

11class ConfigCategory(pydantic_v1.BaseModel):
12    value: float
13    label: str
14
15    def json(self, **kwargs: typing.Any) -> str:
16        kwargs_with_defaults: typing.Any = {
17            "by_alias": True,
18            "exclude_unset": True,
19            **kwargs,
20        }
21        return super().json(**kwargs_with_defaults)
22
23    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
24        kwargs_with_defaults: typing.Any = {
25            "by_alias": True,
26            "exclude_unset": True,
27            **kwargs,
28        }
29        return super().dict(**kwargs_with_defaults)
30
31    class Config:
32        frozen = True
33        smart_union = True
34        extra = pydantic_v1.Extra.allow
35        json_encoders = {dt.datetime: serialize_datetime}

31    class Config:
32        frozen = True
33        smart_union = True
34        extra = pydantic_v1.Extra.allow
35        json_encoders = {dt.datetime: serialize_datetime}

12class CreateChatPromptRequest(pydantic_v1.BaseModel):
13    name: str
14    prompt: typing.List[ChatMessage]
15    config: typing.Optional[typing.Any] = None
16    labels: typing.Optional[typing.List[str]] = pydantic_v1.Field(default=None)
17    """
18    List of deployment labels of this prompt version.
19    """
20
21    tags: typing.Optional[typing.List[str]] = pydantic_v1.Field(default=None)
22    """
23    List of tags to apply to all versions of this prompt.
24    """
25
26    def json(self, **kwargs: typing.Any) -> str:
27        kwargs_with_defaults: typing.Any = {
28            "by_alias": True,
29            "exclude_unset": True,
30            **kwargs,
31        }
32        return super().json(**kwargs_with_defaults)
33
34    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
35        kwargs_with_defaults: typing.Any = {
36            "by_alias": True,
37            "exclude_unset": True,
38            **kwargs,
39        }
40        return super().dict(**kwargs_with_defaults)
41
42    class Config:
43        frozen = True
44        smart_union = True
45        extra = pydantic_v1.Extra.allow
46        json_encoders = {dt.datetime: serialize_datetime}

42    class Config:
43        frozen = True
44        smart_union = True
45        extra = pydantic_v1.Extra.allow
46        json_encoders = {dt.datetime: serialize_datetime}

12class CreateDatasetItemRequest(pydantic_v1.BaseModel):
13    dataset_name: str = pydantic_v1.Field(alias="datasetName")
14    input: typing.Optional[typing.Any] = None
15    expected_output: typing.Optional[typing.Any] = pydantic_v1.Field(
16        alias="expectedOutput", default=None
17    )
18    metadata: typing.Optional[typing.Any] = None
19    source_trace_id: typing.Optional[str] = pydantic_v1.Field(
20        alias="sourceTraceId", default=None
21    )
22    source_observation_id: typing.Optional[str] = pydantic_v1.Field(
23        alias="sourceObservationId", default=None
24    )
25    id: typing.Optional[str] = pydantic_v1.Field(default=None)
26    """
27    Dataset items are upserted on their id. Id needs to be globally unique and cannot be reused across datasets.
28    """
29
30    status: typing.Optional[DatasetStatus] = pydantic_v1.Field(default=None)
31    """
32    Defaults to ACTIVE for newly created items
33    """
34
35    def json(self, **kwargs: typing.Any) -> str:
36        kwargs_with_defaults: typing.Any = {
37            "by_alias": True,
38            "exclude_unset": True,
39            **kwargs,
40        }
41        return super().json(**kwargs_with_defaults)
42
43    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
44        kwargs_with_defaults: typing.Any = {
45            "by_alias": True,
46            "exclude_unset": True,
47            **kwargs,
48        }
49        return super().dict(**kwargs_with_defaults)
50
51    class Config:
52        frozen = True
53        smart_union = True
54        allow_population_by_field_name = True
55        populate_by_name = True
56        extra = pydantic_v1.Extra.allow
57        json_encoders = {dt.datetime: serialize_datetime}

51    class Config:
52        frozen = True
53        smart_union = True
54        allow_population_by_field_name = True
55        populate_by_name = True
56        extra = pydantic_v1.Extra.allow
57        json_encoders = {dt.datetime: serialize_datetime}

11class CreateDatasetRequest(pydantic_v1.BaseModel):
12    name: str
13    description: typing.Optional[str] = None
14    metadata: typing.Optional[typing.Any] = None
15
16    def json(self, **kwargs: typing.Any) -> str:
17        kwargs_with_defaults: typing.Any = {
18            "by_alias": True,
19            "exclude_unset": True,
20            **kwargs,
21        }
22        return super().json(**kwargs_with_defaults)
23
24    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
25        kwargs_with_defaults: typing.Any = {
26            "by_alias": True,
27            "exclude_unset": True,
28            **kwargs,
29        }
30        return super().dict(**kwargs_with_defaults)
31
32    class Config:
33        frozen = True
34        smart_union = True
35        extra = pydantic_v1.Extra.allow
36        json_encoders = {dt.datetime: serialize_datetime}