Skip to content

feat(api): update API spec from langfuse/langfuse cf53f2e #829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
langfuse-bot wants to merge 1 commit into from
Closed

feat(api): update API spec from langfuse/langfuse cf53f2e #829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...s/core/src/api/api/resources/blobStorageIntegrations/types/BlobStorageExportFieldGroup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/

/**
* Field group for the OBSERVATIONS_V2 and LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS export.
* Field group selecting which observation columns are included in the export. Applies to all export sources; groups without a counterpart in the legacy data model (e.g. `trace_context`) are omitted from the legacy observations export.
*/
export type BlobStorageExportFieldGroup =
| "core"
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/api/api/resources/blobStorageIntegrations/types/BlobStorageExportSource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

/**
* What data the integration exports.
* - `LEGACY_TRACES_OBSERVATIONS`: traces, observations, and scores tables with a fixed column set. The `exportFieldGroups` field is not applicable.
* - `LEGACY_TRACES_OBSERVATIONS`: traces, observations, and scores tables. Observation columns are controlled by `exportFieldGroups`; field groups without a counterpart in this data model (e.g. `trace_context`) are omitted.
* - `OBSERVATIONS_V2`: same data model as the `/api/public/v2/observations` endpoint, plus scores. Columns are controlled by `exportFieldGroups`.
* - `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS`: both sets. For the `OBSERVATIONS_V2` portion, columns are controlled by `exportFieldGroups`.
* - `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS`: both sets. Observation columns of both portions are controlled by `exportFieldGroups`.
*
* **Note:** `OBSERVATIONS_V2` and the enriched-observations portion of `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS` rely on the enriched observations table (Langfuse Fast Preview / v4), which is currently available on Langfuse Cloud only. See https://langfuse.com/docs/v4.
*/
Expand Down
2 changes: 1 addition & 1 deletion ...ore/src/api/api/resources/blobStorageIntegrations/types/BlobStorageIntegrationResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export interface BlobStorageIntegrationResponse {
exportStartDate: string | null;
compressed: boolean;
exportSource: LangfuseAPI.BlobStorageExportSource;
/** Field groups included in each exported row for `OBSERVATIONS_V2` / `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS` sources. Always `null` when exportSource is `LEGACY_TRACES_OBSERVATIONS` (the field does not apply to that source; any legacy DB value is hidden from the public surface). */
/** Field groups included in each exported observation row. An empty list is treated as all groups during export. */
exportFieldGroups: LangfuseAPI.BlobStorageExportFieldGroup[] | null;
nextSyncAt: string | null;
lastSyncAt: string | null;
Expand Down
6 changes: 1 addition & 5 deletions ...rc/api/api/resources/blobStorageIntegrations/types/CreateBlobStorageIntegrationRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,7 @@ export interface CreateBlobStorageIntegrationRequest {
*/
exportSource?: LangfuseAPI.BlobStorageExportSource;
/**
* Field groups to include in each exported row.
*
* For exportSource `OBSERVATIONS_V2` or `LEGACY_TRACES_AND_ENRICHED_OBSERVATIONS`: must include `core` if provided. When omitted on create, the column default (all groups) applies. When omitted on update, the existing value is preserved.
*
* For exportSource `LEGACY_TRACES_OBSERVATIONS`: this field must be omitted or null. Sending an array (including an empty array) returns 400, because that source uses a fixed column set and does not honor field groups.
* Field groups to include in each exported observation row. Applies to all export sources; must include `core` if provided. When omitted on create, the column default (all groups) applies. When omitted on update, the existing value is preserved.
*
* `exportFieldGroups` requires `exportSource` to be provided in the same request.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/api/api/resources/datasetItems/types/CreateDatasetItemRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface CreateDatasetItemRequest {
metadata?: unknown;
sourceTraceId?: string;
sourceObservationId?: string;
/** Dataset items are upserted on their id. Id needs to be unique (project-level) and cannot be reused across datasets. */
/** Dataset items are upserted on their id. Id needs to be unique (project-level), cannot be reused across datasets, and must be at most 255 characters. */
id?: string;
/** Defaults to ACTIVE for newly created items */
status?: LangfuseAPI.DatasetStatus;
Expand Down
6 changes: 6 additions & 0 deletions packages/core/src/api/api/resources/scores/client/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ export class Scores {
}

/**
* **Deprecated.** Use `GET /api/public/v3/scores` instead. This endpoint
* is no longer available on Langfuse v4 and later.
*
* Get a list of scores (supports both trace and session scores)
*
* @param {LangfuseAPI.GetScoresRequest} request
Expand Down Expand Up @@ -301,6 +304,9 @@ export class Scores {
}

/**
* **Deprecated.** Use `GET /api/public/v3/scores` with the `id` filter
* instead. This endpoint is no longer available on Langfuse v4 and later.
*
* Get a score (supports both trace and session scores)
*
* @param {string} scoreId - The unique langfuse identifier of a score
Expand Down
15 changes: 11 additions & 4 deletions packages/core/src/api/api/resources/scoresV3/client/Client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,22 @@ export class ScoresV3 {
/**
* Get a list of scores with a polymorphic `value` field (v3).
*
* This endpoint requires Langfuse v4 or later.
*
* The `value` field type depends on `dataType`:
* - `NUMERIC` → number
* - `BOOLEAN` → boolean
* - `CATEGORICAL`, `TEXT`, `CORRECTION` → string
*
* Use the `fields` parameter to include optional field groups beyond the
* default `core`. Unknown group names return HTTP 400.
* The response always includes the core fields: id, projectId, name,
* value, dataType, source, timestamp, environment, createdAt, updatedAt.
*
* Additional field groups can be requested via the `fields` parameter:
* - `details` — adds comment, configId, metadata
* - `subject` — adds the subject object describing the entity the score
* is attached to: kind (trace, observation, session, or experiment),
* id, and traceId for observation-level scores
* - `annotation` — adds authorUserId, queueId
*
* Unknown group names return HTTP 400.
*
* @param {LangfuseAPI.GetScoresV3Request} request
* @param {ScoresV3.RequestOptions} requestOptions - Request-specific configuration.
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/api/api/resources/scoresV3/client/requests/GetScoresV3Request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export interface GetScoresV3Request {
limit?: number;
/** URL-safe base64 (base64url) cursor for pagination. Use the cursor from the previous response to get the next page. Absent on the final page. */
cursor?: string;
/** Comma-separated field groups to include. Allowed: core, details, subject, annotation. Defaults to "core". Unknown names return HTTP 400. */
/** Comma-separated field groups to include in addition to the always-returned core fields. Allowed: details, subject, annotation — see the endpoint description for the fields each group adds. Unknown names return HTTP 400. */
fields?: string;
Comment on lines +14 to 15

@greptile-apps greptile-apps Bot Jun 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 core removed from allowed fields values — may break existing callers

The old JSDoc listed core as an allowed value (Allowed: core, details, subject, annotation); the new JSDoc removes it (Allowed: details, subject, annotation). Since the comment also says "Unknown names return HTTP 400", any SDK user who currently passes fields: "core" or fields: "core,details" will receive a 400 response after this spec update if the server-side has changed to match the new spec. This is a backwards-incompatible change for explicit callers and is not called out in the PR description.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: packages/core/src/api/api/resources/scoresV3/client/requests/GetScoresV3Request.ts
Line: 14-15

Comment:
**`core` removed from allowed `fields` values — may break existing callers**

The old JSDoc listed `core` as an allowed value (`Allowed: core, details, subject, annotation`); the new JSDoc removes it (`Allowed: details, subject, annotation`). Since the comment also says "Unknown names return HTTP 400", any SDK user who currently passes `fields: "core"` or `fields: "core,details"` will receive a `400` response after this spec update if the server-side has changed to match the new spec. This is a backwards-incompatible change for explicit callers and is not called out in the PR description.

How can I resolve this? If you propose a fix, please make it concise.

/** Comma-separated list of score IDs to filter by (OR within, AND across filters). */
id?: string;
Expand Down