# This file was auto-generated by Fern from our API Definition. import datetime as dt import typing from ..commons.types.score import Score from ..commons.types.score_data_type import ScoreDataType from ..commons.types.score_source import ScoreSource from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.request_options import RequestOptions from .raw_client import AsyncRawScoresClient, RawScoresClient from .types.get_scores_response import GetScoresResponse class ScoresClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._raw_client = RawScoresClient(client_wrapper=client_wrapper) @property def with_raw_response(self) -> RawScoresClient: """ Retrieves a raw implementation of this client that returns raw responses. Returns ------- RawScoresClient """ return self._raw_client def get_many( self, *, page: typing.Optional[int] = None, limit: typing.Optional[int] = None, user_id: typing.Optional[str] = None, name: typing.Optional[str] = None, from_timestamp: typing.Optional[dt.datetime] = None, to_timestamp: typing.Optional[dt.datetime] = None, environment: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None, source: typing.Optional[ScoreSource] = None, operator: typing.Optional[str] = None, value: typing.Optional[float] = None, score_ids: typing.Optional[str] = None, config_id: typing.Optional[str] = None, session_id: typing.Optional[str] = None, dataset_run_id: typing.Optional[str] = None, trace_id: typing.Optional[str] = None, observation_id: typing.Optional[str] = None, queue_id: typing.Optional[str] = None, data_type: typing.Optional[ScoreDataType] = None, trace_tags: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None, fields: typing.Optional[str] = None, filter: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> GetScoresResponse: """ Get a list of scores (supports both trace and session scores) Parameters ---------- page : typing.Optional[int] Page number, starts at 1. limit : typing.Optional[int] Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit. user_id : typing.Optional[str] Retrieve only scores with this userId associated to the trace. name : typing.Optional[str] Retrieve only scores with this name. from_timestamp : typing.Optional[dt.datetime] Optional filter to only include scores created on or after a certain datetime (ISO 8601) to_timestamp : typing.Optional[dt.datetime] Optional filter to only include scores created before a certain datetime (ISO 8601) environment : typing.Optional[typing.Union[str, typing.Sequence[str]]] Optional filter for scores where the environment is one of the provided values. source : typing.Optional[ScoreSource] Retrieve only scores from a specific source. operator : typing.Optional[str] Retrieve only scores with value. value : typing.Optional[float] Retrieve only scores with value. score_ids : typing.Optional[str] Comma-separated list of score IDs to limit the results to. config_id : typing.Optional[str] Retrieve only scores with a specific configId. session_id : typing.Optional[str] Retrieve only scores with a specific sessionId. dataset_run_id : typing.Optional[str] Retrieve only scores with a specific datasetRunId. trace_id : typing.Optional[str] Retrieve only scores with a specific traceId. observation_id : typing.Optional[str] Comma-separated list of observation IDs to filter scores by. queue_id : typing.Optional[str] Retrieve only scores with a specific annotation queueId. data_type : typing.Optional[ScoreDataType] Retrieve only scores with a specific dataType. trace_tags : typing.Optional[typing.Union[str, typing.Sequence[str]]] Only scores linked to traces that include all of these tags will be returned. fields : typing.Optional[str] Comma-separated list of field groups to include in the response. Available field groups: 'score' (core score fields), 'trace' (trace properties: userId, tags, environment, sessionId). If not specified, both 'score' and 'trace' are returned by default. Example: 'score' to exclude trace data, 'score,trace' to include both. Note: When filtering by trace properties (using userId or traceTags parameters), the 'trace' field group must be included, otherwise a 400 error will be returned. filter : typing.Optional[str] A JSON stringified array of filter objects. Each object requires type, column, operator, and value. Supports filtering by score metadata using the stringObject type. Example: [{"type":"stringObject","column":"metadata","key":"user_id","operator":"=","value":"abc123"}]. Supported types: stringObject (metadata key-value filtering), string, number, datetime, stringOptions, arrayOptions. Supported operators for stringObject: =, contains, does not contain, starts with, ends with. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- GetScoresResponse Examples -------- from langfuse import LangfuseAPI client = LangfuseAPI( x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME", x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION", x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY", username="YOUR_USERNAME", password="YOUR_PASSWORD", base_url="https://yourhost.com/path/to/api", ) client.scores.get_many() """ _response = self._raw_client.get_many( page=page, limit=limit, user_id=user_id, name=name, from_timestamp=from_timestamp, to_timestamp=to_timestamp, environment=environment, source=source, operator=operator, value=value, score_ids=score_ids, config_id=config_id, session_id=session_id, dataset_run_id=dataset_run_id, trace_id=trace_id, observation_id=observation_id, queue_id=queue_id, data_type=data_type, trace_tags=trace_tags, fields=fields, filter=filter, request_options=request_options, ) return _response.data def get_by_id( self, score_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> Score: """ Get a score (supports both trace and session scores) Parameters ---------- score_id : str The unique langfuse identifier of a score request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Score Examples -------- from langfuse import LangfuseAPI client = LangfuseAPI( x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME", x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION", x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY", username="YOUR_USERNAME", password="YOUR_PASSWORD", base_url="https://yourhost.com/path/to/api", ) client.scores.get_by_id( score_id="scoreId", ) """ _response = self._raw_client.get_by_id( score_id, request_options=request_options ) return _response.data class AsyncScoresClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._raw_client = AsyncRawScoresClient(client_wrapper=client_wrapper) @property def with_raw_response(self) -> AsyncRawScoresClient: """ Retrieves a raw implementation of this client that returns raw responses. Returns ------- AsyncRawScoresClient """ return self._raw_client async def get_many( self, *, page: typing.Optional[int] = None, limit: typing.Optional[int] = None, user_id: typing.Optional[str] = None, name: typing.Optional[str] = None, from_timestamp: typing.Optional[dt.datetime] = None, to_timestamp: typing.Optional[dt.datetime] = None, environment: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None, source: typing.Optional[ScoreSource] = None, operator: typing.Optional[str] = None, value: typing.Optional[float] = None, score_ids: typing.Optional[str] = None, config_id: typing.Optional[str] = None, session_id: typing.Optional[str] = None, dataset_run_id: typing.Optional[str] = None, trace_id: typing.Optional[str] = None, observation_id: typing.Optional[str] = None, queue_id: typing.Optional[str] = None, data_type: typing.Optional[ScoreDataType] = None, trace_tags: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None, fields: typing.Optional[str] = None, filter: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> GetScoresResponse: """ Get a list of scores (supports both trace and session scores) Parameters ---------- page : typing.Optional[int] Page number, starts at 1. limit : typing.Optional[int] Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit. user_id : typing.Optional[str] Retrieve only scores with this userId associated to the trace. name : typing.Optional[str] Retrieve only scores with this name. from_timestamp : typing.Optional[dt.datetime] Optional filter to only include scores created on or after a certain datetime (ISO 8601) to_timestamp : typing.Optional[dt.datetime] Optional filter to only include scores created before a certain datetime (ISO 8601) environment : typing.Optional[typing.Union[str, typing.Sequence[str]]] Optional filter for scores where the environment is one of the provided values. source : typing.Optional[ScoreSource] Retrieve only scores from a specific source. operator : typing.Optional[str] Retrieve only scores with value. value : typing.Optional[float] Retrieve only scores with value. score_ids : typing.Optional[str] Comma-separated list of score IDs to limit the results to. config_id : typing.Optional[str] Retrieve only scores with a specific configId. session_id : typing.Optional[str] Retrieve only scores with a specific sessionId. dataset_run_id : typing.Optional[str] Retrieve only scores with a specific datasetRunId. trace_id : typing.Optional[str] Retrieve only scores with a specific traceId. observation_id : typing.Optional[str] Comma-separated list of observation IDs to filter scores by. queue_id : typing.Optional[str] Retrieve only scores with a specific annotation queueId. data_type : typing.Optional[ScoreDataType] Retrieve only scores with a specific dataType. trace_tags : typing.Optional[typing.Union[str, typing.Sequence[str]]] Only scores linked to traces that include all of these tags will be returned. fields : typing.Optional[str] Comma-separated list of field groups to include in the response. Available field groups: 'score' (core score fields), 'trace' (trace properties: userId, tags, environment, sessionId). If not specified, both 'score' and 'trace' are returned by default. Example: 'score' to exclude trace data, 'score,trace' to include both. Note: When filtering by trace properties (using userId or traceTags parameters), the 'trace' field group must be included, otherwise a 400 error will be returned. filter : typing.Optional[str] A JSON stringified array of filter objects. Each object requires type, column, operator, and value. Supports filtering by score metadata using the stringObject type. Example: [{"type":"stringObject","column":"metadata","key":"user_id","operator":"=","value":"abc123"}]. Supported types: stringObject (metadata key-value filtering), string, number, datetime, stringOptions, arrayOptions. Supported operators for stringObject: =, contains, does not contain, starts with, ends with. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- GetScoresResponse Examples -------- import asyncio from langfuse import AsyncLangfuseAPI client = AsyncLangfuseAPI( x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME", x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION", x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY", username="YOUR_USERNAME", password="YOUR_PASSWORD", base_url="https://yourhost.com/path/to/api", ) async def main() -> None: await client.scores.get_many() asyncio.run(main()) """ _response = await self._raw_client.get_many( page=page, limit=limit, user_id=user_id, name=name, from_timestamp=from_timestamp, to_timestamp=to_timestamp, environment=environment, source=source, operator=operator, value=value, score_ids=score_ids, config_id=config_id, session_id=session_id, dataset_run_id=dataset_run_id, trace_id=trace_id, observation_id=observation_id, queue_id=queue_id, data_type=data_type, trace_tags=trace_tags, fields=fields, filter=filter, request_options=request_options, ) return _response.data async def get_by_id( self, score_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> Score: """ Get a score (supports both trace and session scores) Parameters ---------- score_id : str The unique langfuse identifier of a score request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- Score Examples -------- import asyncio from langfuse import AsyncLangfuseAPI client = AsyncLangfuseAPI( x_langfuse_sdk_name="YOUR_X_LANGFUSE_SDK_NAME", x_langfuse_sdk_version="YOUR_X_LANGFUSE_SDK_VERSION", x_langfuse_public_key="YOUR_X_LANGFUSE_PUBLIC_KEY", username="YOUR_USERNAME", password="YOUR_PASSWORD", base_url="https://yourhost.com/path/to/api", ) async def main() -> None: await client.scores.get_by_id( score_id="scoreId", ) asyncio.run(main()) """ _response = await self._raw_client.get_by_id( score_id, request_options=request_options ) return _response.data