Skip to content

Commit 36f6eac

Browse files
author
langfuse-bot
committed
feat(api): update API spec from langfuse/langfuse fa072d0
1 parent 3008a53 commit 36f6eac

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

langfuse/api/reference.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3635,7 +3635,7 @@ Use the `fields` parameter to control which observation fields are returned:
36353635
- `basic` - name, level, statusMessage, version, environment, bookmarked, public, userId, sessionId
36363636
- `time` - completionStartTime, createdAt, updatedAt
36373637
- `io` - input, output
3638-
- `metadata` - metadata
3638+
- `metadata` - metadata (truncated to 200 chars by default, use `expandMetadata` to get full values)
36393639
- `model` - providedModelName, internalModelId, modelParameters
36403640
- `usage` - usageDetails, costDetails, totalCost
36413641
- `prompt` - promptId, promptName, promptVersion
@@ -3699,6 +3699,19 @@ Example: "basic,usage,model"
36993699
<dl>
37003700
<dd>
37013701

3702+
**expand_metadata:** `typing.Optional[str]`
3703+
3704+
Comma-separated list of metadata keys to return non-truncated.
3705+
By default, metadata values over 200 characters are truncated.
3706+
Use this parameter to retrieve full values for specific keys.
3707+
Example: "key1,key2"
3708+
3709+
</dd>
3710+
</dl>
3711+
3712+
<dl>
3713+
<dd>
3714+
37023715
**limit:** `typing.Optional[int]` — Number of items to return per page. Maximum 1000, default 50.
37033716

37043717
</dd>

langfuse/api/resources/observations_v_2/client.py

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ def get_many(
2626
self,
2727
*,
2828
fields: typing.Optional[str] = None,
29+
expand_metadata: typing.Optional[str] = None,
2930
limit: typing.Optional[int] = None,
3031
cursor: typing.Optional[str] = None,
3132
parse_io_as_json: typing.Optional[bool] = None,
@@ -56,7 +57,7 @@ def get_many(
5657
- `basic` - name, level, statusMessage, version, environment, bookmarked, public, userId, sessionId
5758
- `time` - completionStartTime, createdAt, updatedAt
5859
- `io` - input, output
59-
- `metadata` - metadata
60+
- `metadata` - metadata (truncated to 200 chars by default, use `expandMetadata` to get full values)
6061
- `model` - providedModelName, internalModelId, modelParameters
6162
- `usage` - usageDetails, costDetails, totalCost
6263
- `prompt` - promptId, promptName, promptVersion
@@ -76,6 +77,12 @@ def get_many(
7677
If not specified, `core` and `basic` field groups are returned.
7778
Example: "basic,usage,model"
7879
80+
expand_metadata : typing.Optional[str]
81+
Comma-separated list of metadata keys to return non-truncated.
82+
By default, metadata values over 200 characters are truncated.
83+
Use this parameter to retrieve full values for specific keys.
84+
Example: "key1,key2"
85+
7986
limit : typing.Optional[int]
8087
Number of items to return per page. Maximum 1000, default 50.
8188
@@ -234,6 +241,7 @@ def get_many(
234241
method="GET",
235242
params={
236243
"fields": fields,
244+
"expandMetadata": expand_metadata,
237245
"limit": limit,
238246
"cursor": cursor,
239247
"parseIoAsJson": parse_io_as_json,
@@ -292,6 +300,7 @@ async def get_many(
292300
self,
293301
*,
294302
fields: typing.Optional[str] = None,
303+
expand_metadata: typing.Optional[str] = None,
295304
limit: typing.Optional[int] = None,
296305
cursor: typing.Optional[str] = None,
297306
parse_io_as_json: typing.Optional[bool] = None,
@@ -322,7 +331,7 @@ async def get_many(
322331
- `basic` - name, level, statusMessage, version, environment, bookmarked, public, userId, sessionId
323332
- `time` - completionStartTime, createdAt, updatedAt
324333
- `io` - input, output
325-
- `metadata` - metadata
334+
- `metadata` - metadata (truncated to 200 chars by default, use `expandMetadata` to get full values)
326335
- `model` - providedModelName, internalModelId, modelParameters
327336
- `usage` - usageDetails, costDetails, totalCost
328337
- `prompt` - promptId, promptName, promptVersion
@@ -342,6 +351,12 @@ async def get_many(
342351
If not specified, `core` and `basic` field groups are returned.
343352
Example: "basic,usage,model"
344353
354+
expand_metadata : typing.Optional[str]
355+
Comma-separated list of metadata keys to return non-truncated.
356+
By default, metadata values over 200 characters are truncated.
357+
Use this parameter to retrieve full values for specific keys.
358+
Example: "key1,key2"
359+
345360
limit : typing.Optional[int]
346361
Number of items to return per page. Maximum 1000, default 50.
347362
@@ -508,6 +523,7 @@ async def main() -> None:
508523
method="GET",
509524
params={
510525
"fields": fields,
526+
"expandMetadata": expand_metadata,
511527
"limit": limit,
512528
"cursor": cursor,
513529
"parseIoAsJson": parse_io_as_json,

0 commit comments

Comments
 (0)