@langfuse/core 5.9.0 → 5.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -10
- package/dist/index.cjs +4650 -1814
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2290 -597
- package/dist/index.d.ts +2290 -597
- package/dist/index.mjs +4639 -1809
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -4
package/dist/index.d.cts
CHANGED
|
@@ -393,23 +393,23 @@ interface GetAnnotationQueueItemsRequest {
|
|
|
393
393
|
limit?: number;
|
|
394
394
|
}
|
|
395
395
|
|
|
396
|
-
type index$
|
|
397
|
-
type index$
|
|
398
|
-
type index$
|
|
399
|
-
declare const index$
|
|
400
|
-
declare const index$
|
|
401
|
-
type index$
|
|
402
|
-
type index$
|
|
403
|
-
type index$
|
|
404
|
-
type index$
|
|
405
|
-
type index$
|
|
406
|
-
type index$
|
|
407
|
-
type index$
|
|
408
|
-
type index$
|
|
409
|
-
type index$
|
|
410
|
-
type index$
|
|
411
|
-
declare namespace index$
|
|
412
|
-
export { type index$
|
|
396
|
+
type index$D_AnnotationQueue = AnnotationQueue;
|
|
397
|
+
type index$D_AnnotationQueueAssignmentRequest = AnnotationQueueAssignmentRequest;
|
|
398
|
+
type index$D_AnnotationQueueItem = AnnotationQueueItem;
|
|
399
|
+
declare const index$D_AnnotationQueueObjectType: typeof AnnotationQueueObjectType;
|
|
400
|
+
declare const index$D_AnnotationQueueStatus: typeof AnnotationQueueStatus;
|
|
401
|
+
type index$D_CreateAnnotationQueueAssignmentResponse = CreateAnnotationQueueAssignmentResponse;
|
|
402
|
+
type index$D_CreateAnnotationQueueItemRequest = CreateAnnotationQueueItemRequest;
|
|
403
|
+
type index$D_CreateAnnotationQueueRequest = CreateAnnotationQueueRequest;
|
|
404
|
+
type index$D_DeleteAnnotationQueueAssignmentResponse = DeleteAnnotationQueueAssignmentResponse;
|
|
405
|
+
type index$D_DeleteAnnotationQueueItemResponse = DeleteAnnotationQueueItemResponse;
|
|
406
|
+
type index$D_GetAnnotationQueueItemsRequest = GetAnnotationQueueItemsRequest;
|
|
407
|
+
type index$D_GetAnnotationQueuesRequest = GetAnnotationQueuesRequest;
|
|
408
|
+
type index$D_PaginatedAnnotationQueueItems = PaginatedAnnotationQueueItems;
|
|
409
|
+
type index$D_PaginatedAnnotationQueues = PaginatedAnnotationQueues;
|
|
410
|
+
type index$D_UpdateAnnotationQueueItemRequest = UpdateAnnotationQueueItemRequest;
|
|
411
|
+
declare namespace index$D {
|
|
412
|
+
export { type index$D_AnnotationQueue as AnnotationQueue, type index$D_AnnotationQueueAssignmentRequest as AnnotationQueueAssignmentRequest, type index$D_AnnotationQueueItem as AnnotationQueueItem, index$D_AnnotationQueueObjectType as AnnotationQueueObjectType, index$D_AnnotationQueueStatus as AnnotationQueueStatus, type index$D_CreateAnnotationQueueAssignmentResponse as CreateAnnotationQueueAssignmentResponse, type index$D_CreateAnnotationQueueItemRequest as CreateAnnotationQueueItemRequest, type index$D_CreateAnnotationQueueRequest as CreateAnnotationQueueRequest, type index$D_DeleteAnnotationQueueAssignmentResponse as DeleteAnnotationQueueAssignmentResponse, type index$D_DeleteAnnotationQueueItemResponse as DeleteAnnotationQueueItemResponse, type index$D_GetAnnotationQueueItemsRequest as GetAnnotationQueueItemsRequest, type index$D_GetAnnotationQueuesRequest as GetAnnotationQueuesRequest, type index$D_PaginatedAnnotationQueueItems as PaginatedAnnotationQueueItems, type index$D_PaginatedAnnotationQueues as PaginatedAnnotationQueues, type index$D_UpdateAnnotationQueueItemRequest as UpdateAnnotationQueueItemRequest };
|
|
413
413
|
}
|
|
414
414
|
|
|
415
415
|
/**
|
|
@@ -425,11 +425,29 @@ declare const BlobStorageIntegrationType: {
|
|
|
425
425
|
/**
|
|
426
426
|
* This file was auto-generated by Fern from our API Definition.
|
|
427
427
|
*/
|
|
428
|
-
|
|
428
|
+
/**
|
|
429
|
+
* File format for exported data. `PARQUET` is a columnar binary format encoded and compressed by the storage engine; gzip compression does not apply to it. Note that the model-price columns (`input_price`, `output_price`, `total_price`) are not included in Parquet observation exports.
|
|
430
|
+
*/
|
|
431
|
+
type BlobStorageIntegrationFileType = "JSON" | "CSV" | "JSONL" | "PARQUET";
|
|
429
432
|
declare const BlobStorageIntegrationFileType: {
|
|
430
433
|
readonly Json: "JSON";
|
|
431
434
|
readonly Csv: "CSV";
|
|
432
435
|
readonly Jsonl: "JSONL";
|
|
436
|
+
readonly Parquet: "PARQUET";
|
|
437
|
+
};
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
441
|
+
*/
|
|
442
|
+
/**
|
|
443
|
+
* File type reported for an existing integration.
|
|
444
|
+
*/
|
|
445
|
+
type BlobStorageIntegrationFileTypeResponse = "JSON" | "CSV" | "JSONL" | "PARQUET";
|
|
446
|
+
declare const BlobStorageIntegrationFileTypeResponse: {
|
|
447
|
+
readonly Json: "JSON";
|
|
448
|
+
readonly Csv: "CSV";
|
|
449
|
+
readonly Jsonl: "JSONL";
|
|
450
|
+
readonly Parquet: "PARQUET";
|
|
433
451
|
};
|
|
434
452
|
|
|
435
453
|
/**
|
|
@@ -519,7 +537,7 @@ interface CreateBlobStorageIntegrationRequest {
|
|
|
519
537
|
forcePathStyle: boolean;
|
|
520
538
|
fileType: BlobStorageIntegrationFileType;
|
|
521
539
|
exportMode: BlobStorageExportMode;
|
|
522
|
-
/** Custom start date for exports (required when exportMode is FROM_CUSTOM_DATE) */
|
|
540
|
+
/** Custom start date for exports (required when exportMode is FROM_CUSTOM_DATE). Must not be in the future (27 h tolerance for timezone differences). */
|
|
523
541
|
exportStartDate?: string;
|
|
524
542
|
/** Enable gzip compression for exported files (.csv.gz, .json.gz, .jsonl.gz). Defaults to true. */
|
|
525
543
|
compressed?: boolean;
|
|
@@ -555,7 +573,7 @@ interface BlobStorageIntegrationResponse {
|
|
|
555
573
|
exportFrequency: BlobStorageExportFrequency;
|
|
556
574
|
enabled: boolean;
|
|
557
575
|
forcePathStyle: boolean;
|
|
558
|
-
fileType:
|
|
576
|
+
fileType: BlobStorageIntegrationFileTypeResponse;
|
|
559
577
|
exportMode: BlobStorageExportMode;
|
|
560
578
|
exportStartDate: string | null;
|
|
561
579
|
compressed: boolean;
|
|
@@ -585,17 +603,19 @@ interface BlobStorageIntegrationsResponse {
|
|
|
585
603
|
* Sync status of the blob storage integration:
|
|
586
604
|
* - `disabled` — integration is not enabled
|
|
587
605
|
* - `error` — last export failed (see `lastError` for details)
|
|
588
|
-
* - `
|
|
606
|
+
* - `running` — an export job is currently being processed
|
|
589
607
|
* - `queued` — next export is overdue (`nextSyncAt` is in the past) and waiting to be picked up by the worker
|
|
608
|
+
* - `idle` — enabled but has never exported yet and no export is queued
|
|
590
609
|
* - `up_to_date` — all available data has been exported; next export is scheduled for the future
|
|
591
610
|
*
|
|
592
611
|
* **ETL usage**: poll this endpoint and check for `up_to_date` status. Compare `lastSyncAt` against your
|
|
593
612
|
* ETL bookmark to determine if new data is available. Note that exports run with a 20-minute lag buffer,
|
|
594
613
|
* so `lastSyncAt` will always be at least 20 minutes behind real-time.
|
|
595
614
|
*/
|
|
596
|
-
type BlobStorageSyncStatus = "idle" | "queued" | "up_to_date" | "disabled" | "error";
|
|
615
|
+
type BlobStorageSyncStatus = "idle" | "running" | "queued" | "up_to_date" | "disabled" | "error";
|
|
597
616
|
declare const BlobStorageSyncStatus: {
|
|
598
617
|
readonly Idle: "idle";
|
|
618
|
+
readonly Running: "running";
|
|
599
619
|
readonly Queued: "queued";
|
|
600
620
|
readonly UpToDate: "up_to_date";
|
|
601
621
|
readonly Disabled: "disabled";
|
|
@@ -628,20 +648,21 @@ interface BlobStorageIntegrationDeletionResponse {
|
|
|
628
648
|
message: string;
|
|
629
649
|
}
|
|
630
650
|
|
|
631
|
-
declare const index$
|
|
632
|
-
declare const index$
|
|
633
|
-
declare const index$
|
|
634
|
-
declare const index$
|
|
635
|
-
type index$
|
|
636
|
-
declare const index$
|
|
637
|
-
|
|
638
|
-
type index$
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
651
|
+
declare const index$C_BlobStorageExportFieldGroup: typeof BlobStorageExportFieldGroup;
|
|
652
|
+
declare const index$C_BlobStorageExportFrequency: typeof BlobStorageExportFrequency;
|
|
653
|
+
declare const index$C_BlobStorageExportMode: typeof BlobStorageExportMode;
|
|
654
|
+
declare const index$C_BlobStorageExportSource: typeof BlobStorageExportSource;
|
|
655
|
+
type index$C_BlobStorageIntegrationDeletionResponse = BlobStorageIntegrationDeletionResponse;
|
|
656
|
+
declare const index$C_BlobStorageIntegrationFileType: typeof BlobStorageIntegrationFileType;
|
|
657
|
+
declare const index$C_BlobStorageIntegrationFileTypeResponse: typeof BlobStorageIntegrationFileTypeResponse;
|
|
658
|
+
type index$C_BlobStorageIntegrationResponse = BlobStorageIntegrationResponse;
|
|
659
|
+
type index$C_BlobStorageIntegrationStatusResponse = BlobStorageIntegrationStatusResponse;
|
|
660
|
+
declare const index$C_BlobStorageIntegrationType: typeof BlobStorageIntegrationType;
|
|
661
|
+
type index$C_BlobStorageIntegrationsResponse = BlobStorageIntegrationsResponse;
|
|
662
|
+
declare const index$C_BlobStorageSyncStatus: typeof BlobStorageSyncStatus;
|
|
663
|
+
type index$C_CreateBlobStorageIntegrationRequest = CreateBlobStorageIntegrationRequest;
|
|
664
|
+
declare namespace index$C {
|
|
665
|
+
export { index$C_BlobStorageExportFieldGroup as BlobStorageExportFieldGroup, index$C_BlobStorageExportFrequency as BlobStorageExportFrequency, index$C_BlobStorageExportMode as BlobStorageExportMode, index$C_BlobStorageExportSource as BlobStorageExportSource, type index$C_BlobStorageIntegrationDeletionResponse as BlobStorageIntegrationDeletionResponse, index$C_BlobStorageIntegrationFileType as BlobStorageIntegrationFileType, index$C_BlobStorageIntegrationFileTypeResponse as BlobStorageIntegrationFileTypeResponse, type index$C_BlobStorageIntegrationResponse as BlobStorageIntegrationResponse, type index$C_BlobStorageIntegrationStatusResponse as BlobStorageIntegrationStatusResponse, index$C_BlobStorageIntegrationType as BlobStorageIntegrationType, type index$C_BlobStorageIntegrationsResponse as BlobStorageIntegrationsResponse, index$C_BlobStorageSyncStatus as BlobStorageSyncStatus, type index$C_CreateBlobStorageIntegrationRequest as CreateBlobStorageIntegrationRequest };
|
|
645
666
|
}
|
|
646
667
|
|
|
647
668
|
/**
|
|
@@ -697,12 +718,29 @@ interface GetCommentsRequest {
|
|
|
697
718
|
authorUserId?: string;
|
|
698
719
|
}
|
|
699
720
|
|
|
700
|
-
type index$
|
|
701
|
-
type index$
|
|
702
|
-
type index$
|
|
703
|
-
type index$
|
|
704
|
-
declare namespace index$
|
|
705
|
-
export type { index$
|
|
721
|
+
type index$B_CreateCommentRequest = CreateCommentRequest;
|
|
722
|
+
type index$B_CreateCommentResponse = CreateCommentResponse;
|
|
723
|
+
type index$B_GetCommentsRequest = GetCommentsRequest;
|
|
724
|
+
type index$B_GetCommentsResponse = GetCommentsResponse;
|
|
725
|
+
declare namespace index$B {
|
|
726
|
+
export type { index$B_CreateCommentRequest as CreateCommentRequest, index$B_CreateCommentResponse as CreateCommentResponse, index$B_GetCommentsRequest as GetCommentsRequest, index$B_GetCommentsResponse as GetCommentsResponse };
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
/**
|
|
730
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
731
|
+
*/
|
|
732
|
+
/**
|
|
733
|
+
* Migration signal returned by deprecated endpoints. Optional fields are omitted when they have no value.
|
|
734
|
+
*/
|
|
735
|
+
interface Deprecation {
|
|
736
|
+
/** Human- and agent-readable summary of the deprecation and its replacement. */
|
|
737
|
+
message: string;
|
|
738
|
+
/** The replacement endpoint, e.g. "GET /api/public/v2/observations". Omitted when the endpoint is being removed without a direct replacement. */
|
|
739
|
+
replacement?: string;
|
|
740
|
+
/** Link to the migration documentation (markdown), when available. */
|
|
741
|
+
docsUrl?: string;
|
|
742
|
+
/** ISO date after which the endpoint may stop working, when a removal date is committed. */
|
|
743
|
+
sunsetAt?: string;
|
|
706
744
|
}
|
|
707
745
|
|
|
708
746
|
/**
|
|
@@ -769,6 +807,7 @@ interface TraceWithFullDetails extends Trace$1 {
|
|
|
769
807
|
observations: ObservationsView[];
|
|
770
808
|
/** List of scores */
|
|
771
809
|
scores: ScoreV1$1[];
|
|
810
|
+
_deprecation?: Deprecation;
|
|
772
811
|
}
|
|
773
812
|
|
|
774
813
|
/**
|
|
@@ -788,6 +827,7 @@ interface Session {
|
|
|
788
827
|
|
|
789
828
|
interface SessionWithTraces extends Session {
|
|
790
829
|
traces: Trace$1[];
|
|
830
|
+
_deprecation?: Deprecation;
|
|
791
831
|
}
|
|
792
832
|
|
|
793
833
|
/**
|
|
@@ -868,6 +908,14 @@ interface ObservationsView extends Observation {
|
|
|
868
908
|
timeToFirstToken: number | null;
|
|
869
909
|
}
|
|
870
910
|
|
|
911
|
+
/**
|
|
912
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
913
|
+
*/
|
|
914
|
+
|
|
915
|
+
interface ObservationsViewSingle extends ObservationsView {
|
|
916
|
+
_deprecation?: Deprecation;
|
|
917
|
+
}
|
|
918
|
+
|
|
871
919
|
/**
|
|
872
920
|
* This file was auto-generated by Fern from our API Definition.
|
|
873
921
|
*/
|
|
@@ -887,10 +935,18 @@ interface ObservationV2 {
|
|
|
887
935
|
endTime: string | null;
|
|
888
936
|
/** The project ID this observation belongs to */
|
|
889
937
|
projectId: string;
|
|
890
|
-
/**
|
|
938
|
+
/**
|
|
939
|
+
* The physical parent observation ID, if present.
|
|
940
|
+
* Observations marked as app roots by the SDK may retain a non-null parent ID.
|
|
941
|
+
*/
|
|
891
942
|
parentObservationId: string | null;
|
|
892
943
|
/** The type of the observation (e.g. GENERATION, SPAN, EVENT) */
|
|
893
944
|
type: string;
|
|
945
|
+
/**
|
|
946
|
+
* Whether this observation is a logical root.
|
|
947
|
+
* This is true for observations without a physical parent and observations marked as app roots by the SDK.
|
|
948
|
+
*/
|
|
949
|
+
isRootObservation?: boolean;
|
|
894
950
|
/** The name of the observation */
|
|
895
951
|
name?: string | null;
|
|
896
952
|
/** The level of the observation */
|
|
@@ -1223,21 +1279,24 @@ Score.Numeric
|
|
|
1223
1279
|
* Score with TEXT data type */
|
|
1224
1280
|
| Score.Text;
|
|
1225
1281
|
declare namespace Score {
|
|
1226
|
-
interface Numeric extends NumericScore {
|
|
1282
|
+
interface Numeric extends NumericScore, _Base {
|
|
1227
1283
|
dataType: "NUMERIC";
|
|
1228
1284
|
}
|
|
1229
|
-
interface Categorical extends CategoricalScore {
|
|
1285
|
+
interface Categorical extends CategoricalScore, _Base {
|
|
1230
1286
|
dataType: "CATEGORICAL";
|
|
1231
1287
|
}
|
|
1232
|
-
interface Boolean extends BooleanScore {
|
|
1288
|
+
interface Boolean extends BooleanScore, _Base {
|
|
1233
1289
|
dataType: "BOOLEAN";
|
|
1234
1290
|
}
|
|
1235
|
-
interface Correction extends CorrectionScore {
|
|
1291
|
+
interface Correction extends CorrectionScore, _Base {
|
|
1236
1292
|
dataType: "CORRECTION";
|
|
1237
1293
|
}
|
|
1238
|
-
interface Text extends TextScore {
|
|
1294
|
+
interface Text extends TextScore, _Base {
|
|
1239
1295
|
dataType: "TEXT";
|
|
1240
1296
|
}
|
|
1297
|
+
interface _Base {
|
|
1298
|
+
_deprecation?: Deprecation;
|
|
1299
|
+
}
|
|
1241
1300
|
}
|
|
1242
1301
|
|
|
1243
1302
|
/**
|
|
@@ -1392,6 +1451,7 @@ interface DatasetRun {
|
|
|
1392
1451
|
|
|
1393
1452
|
interface DatasetRunWithItems extends DatasetRun {
|
|
1394
1453
|
datasetRunItems: DatasetRunItem[];
|
|
1454
|
+
_deprecation?: Deprecation;
|
|
1395
1455
|
}
|
|
1396
1456
|
|
|
1397
1457
|
/**
|
|
@@ -1880,54 +1940,56 @@ declare class MethodNotAllowedError$1 extends LangfuseAPIError {
|
|
|
1880
1940
|
constructor(body?: unknown, rawResponse?: RawResponse);
|
|
1881
1941
|
}
|
|
1882
1942
|
|
|
1883
|
-
type index$
|
|
1884
|
-
type index$
|
|
1885
|
-
type index$
|
|
1886
|
-
type index$
|
|
1887
|
-
type index$
|
|
1888
|
-
type index$
|
|
1889
|
-
type index$
|
|
1890
|
-
declare const index$
|
|
1891
|
-
type index$
|
|
1892
|
-
type index$
|
|
1893
|
-
type index$
|
|
1894
|
-
type index$
|
|
1895
|
-
type index$
|
|
1896
|
-
type index$
|
|
1897
|
-
declare const index$
|
|
1898
|
-
type index$
|
|
1899
|
-
type index$
|
|
1900
|
-
type index$
|
|
1901
|
-
type index$
|
|
1902
|
-
declare const index$
|
|
1903
|
-
type index$
|
|
1904
|
-
type index$
|
|
1905
|
-
type index$
|
|
1906
|
-
|
|
1907
|
-
|
|
1908
|
-
type index$
|
|
1909
|
-
type index$
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
type index$
|
|
1913
|
-
type index$
|
|
1914
|
-
type index$
|
|
1915
|
-
type index$
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
declare const index$
|
|
1920
|
-
|
|
1921
|
-
declare const index$
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
type index$
|
|
1925
|
-
type index$
|
|
1926
|
-
type index$
|
|
1927
|
-
type index$
|
|
1928
|
-
type index$
|
|
1929
|
-
|
|
1930
|
-
|
|
1943
|
+
type index$A_BaseScore = BaseScore;
|
|
1944
|
+
type index$A_BaseScoreV1 = BaseScoreV1;
|
|
1945
|
+
type index$A_BooleanScore = BooleanScore;
|
|
1946
|
+
type index$A_BooleanScoreV1 = BooleanScoreV1;
|
|
1947
|
+
type index$A_CategoricalScore = CategoricalScore;
|
|
1948
|
+
type index$A_CategoricalScoreV1 = CategoricalScoreV1;
|
|
1949
|
+
type index$A_Comment = Comment;
|
|
1950
|
+
declare const index$A_CommentObjectType: typeof CommentObjectType;
|
|
1951
|
+
type index$A_ConfigCategory = ConfigCategory;
|
|
1952
|
+
type index$A_CorrectionScore = CorrectionScore;
|
|
1953
|
+
type index$A_CreateScoreValue = CreateScoreValue;
|
|
1954
|
+
type index$A_Dataset = Dataset;
|
|
1955
|
+
type index$A_DatasetItem = DatasetItem;
|
|
1956
|
+
type index$A_DatasetItemMediaReference = DatasetItemMediaReference;
|
|
1957
|
+
declare const index$A_DatasetItemMediaReferenceField: typeof DatasetItemMediaReferenceField;
|
|
1958
|
+
type index$A_DatasetItemMediaReferenceMedia = DatasetItemMediaReferenceMedia;
|
|
1959
|
+
type index$A_DatasetRun = DatasetRun;
|
|
1960
|
+
type index$A_DatasetRunItem = DatasetRunItem;
|
|
1961
|
+
type index$A_DatasetRunWithItems = DatasetRunWithItems;
|
|
1962
|
+
declare const index$A_DatasetStatus: typeof DatasetStatus;
|
|
1963
|
+
type index$A_Deprecation = Deprecation;
|
|
1964
|
+
type index$A_MapValue = MapValue;
|
|
1965
|
+
type index$A_Model = Model;
|
|
1966
|
+
type index$A_ModelPrice = ModelPrice;
|
|
1967
|
+
declare const index$A_ModelUsageUnit: typeof ModelUsageUnit;
|
|
1968
|
+
type index$A_NumericScore = NumericScore;
|
|
1969
|
+
type index$A_NumericScoreV1 = NumericScoreV1;
|
|
1970
|
+
type index$A_Observation = Observation;
|
|
1971
|
+
declare const index$A_ObservationLevel: typeof ObservationLevel;
|
|
1972
|
+
type index$A_ObservationV2 = ObservationV2;
|
|
1973
|
+
type index$A_ObservationsView = ObservationsView;
|
|
1974
|
+
type index$A_ObservationsViewSingle = ObservationsViewSingle;
|
|
1975
|
+
type index$A_PricingTier = PricingTier;
|
|
1976
|
+
type index$A_PricingTierCondition = PricingTierCondition;
|
|
1977
|
+
type index$A_PricingTierInput = PricingTierInput;
|
|
1978
|
+
declare const index$A_PricingTierOperator: typeof PricingTierOperator;
|
|
1979
|
+
declare const index$A_Score: typeof Score;
|
|
1980
|
+
type index$A_ScoreConfig = ScoreConfig;
|
|
1981
|
+
declare const index$A_ScoreConfigDataType: typeof ScoreConfigDataType;
|
|
1982
|
+
declare const index$A_ScoreDataType: typeof ScoreDataType;
|
|
1983
|
+
declare const index$A_ScoreSource: typeof ScoreSource;
|
|
1984
|
+
type index$A_Session = Session;
|
|
1985
|
+
type index$A_SessionWithTraces = SessionWithTraces;
|
|
1986
|
+
type index$A_TextScore = TextScore;
|
|
1987
|
+
type index$A_TextScoreV1 = TextScoreV1;
|
|
1988
|
+
type index$A_TraceWithDetails = TraceWithDetails;
|
|
1989
|
+
type index$A_TraceWithFullDetails = TraceWithFullDetails;
|
|
1990
|
+
type index$A_Usage = Usage;
|
|
1991
|
+
declare namespace index$A {
|
|
1992
|
+
export { AccessDeniedError$1 as AccessDeniedError, type index$A_BaseScore as BaseScore, type index$A_BaseScoreV1 as BaseScoreV1, type index$A_BooleanScore as BooleanScore, type index$A_BooleanScoreV1 as BooleanScoreV1, type index$A_CategoricalScore as CategoricalScore, type index$A_CategoricalScoreV1 as CategoricalScoreV1, type index$A_Comment as Comment, index$A_CommentObjectType as CommentObjectType, type index$A_ConfigCategory as ConfigCategory, type index$A_CorrectionScore as CorrectionScore, type index$A_CreateScoreValue as CreateScoreValue, type index$A_Dataset as Dataset, type index$A_DatasetItem as DatasetItem, type index$A_DatasetItemMediaReference as DatasetItemMediaReference, index$A_DatasetItemMediaReferenceField as DatasetItemMediaReferenceField, type index$A_DatasetItemMediaReferenceMedia as DatasetItemMediaReferenceMedia, type index$A_DatasetRun as DatasetRun, type index$A_DatasetRunItem as DatasetRunItem, type index$A_DatasetRunWithItems as DatasetRunWithItems, index$A_DatasetStatus as DatasetStatus, type index$A_Deprecation as Deprecation, Error$1 as Error, type index$A_MapValue as MapValue, MethodNotAllowedError$1 as MethodNotAllowedError, type index$A_Model as Model, type index$A_ModelPrice as ModelPrice, index$A_ModelUsageUnit as ModelUsageUnit, NotFoundError$1 as NotFoundError, type index$A_NumericScore as NumericScore, type index$A_NumericScoreV1 as NumericScoreV1, type index$A_Observation as Observation, index$A_ObservationLevel as ObservationLevel, type index$A_ObservationV2 as ObservationV2, type index$A_ObservationsView as ObservationsView, type index$A_ObservationsViewSingle as ObservationsViewSingle, type index$A_PricingTier as PricingTier, type index$A_PricingTierCondition as PricingTierCondition, type index$A_PricingTierInput as PricingTierInput, index$A_PricingTierOperator as PricingTierOperator, index$A_Score as Score, type index$A_ScoreConfig as ScoreConfig, index$A_ScoreConfigDataType as ScoreConfigDataType, index$A_ScoreDataType as ScoreDataType, index$A_ScoreSource as ScoreSource, ScoreV1$1 as ScoreV1, type index$A_Session as Session, type index$A_SessionWithTraces as SessionWithTraces, type index$A_TextScore as TextScore, type index$A_TextScoreV1 as TextScoreV1, type Trace$1 as Trace, type index$A_TraceWithDetails as TraceWithDetails, type index$A_TraceWithFullDetails as TraceWithFullDetails, UnauthorizedError$1 as UnauthorizedError, type index$A_Usage as Usage };
|
|
1931
1993
|
}
|
|
1932
1994
|
|
|
1933
1995
|
/**
|
|
@@ -1987,12 +2049,12 @@ interface GetDatasetItemsRequest {
|
|
|
1987
2049
|
limit?: number;
|
|
1988
2050
|
}
|
|
1989
2051
|
|
|
1990
|
-
type index$
|
|
1991
|
-
type index$
|
|
1992
|
-
type index$
|
|
1993
|
-
type index$
|
|
1994
|
-
declare namespace index$
|
|
1995
|
-
export type { index$
|
|
2052
|
+
type index$z_CreateDatasetItemRequest = CreateDatasetItemRequest;
|
|
2053
|
+
type index$z_DeleteDatasetItemResponse = DeleteDatasetItemResponse;
|
|
2054
|
+
type index$z_GetDatasetItemsRequest = GetDatasetItemsRequest;
|
|
2055
|
+
type index$z_PaginatedDatasetItems = PaginatedDatasetItems;
|
|
2056
|
+
declare namespace index$z {
|
|
2057
|
+
export type { index$z_CreateDatasetItemRequest as CreateDatasetItemRequest, index$z_DeleteDatasetItemResponse as DeleteDatasetItemResponse, index$z_GetDatasetItemsRequest as GetDatasetItemsRequest, index$z_PaginatedDatasetItems as PaginatedDatasetItems };
|
|
1996
2058
|
}
|
|
1997
2059
|
|
|
1998
2060
|
/**
|
|
@@ -2026,6 +2088,7 @@ interface CreateDatasetRunItemRequest {
|
|
|
2026
2088
|
interface PaginatedDatasetRunItems {
|
|
2027
2089
|
data: DatasetRunItem[];
|
|
2028
2090
|
meta: MetaResponse;
|
|
2091
|
+
_deprecation?: Deprecation;
|
|
2029
2092
|
}
|
|
2030
2093
|
|
|
2031
2094
|
/**
|
|
@@ -2047,11 +2110,11 @@ interface ListDatasetRunItemsRequest {
|
|
|
2047
2110
|
limit?: number;
|
|
2048
2111
|
}
|
|
2049
2112
|
|
|
2050
|
-
type index$
|
|
2051
|
-
type index$
|
|
2052
|
-
type index$
|
|
2053
|
-
declare namespace index$
|
|
2054
|
-
export type { index$
|
|
2113
|
+
type index$y_CreateDatasetRunItemRequest = CreateDatasetRunItemRequest;
|
|
2114
|
+
type index$y_ListDatasetRunItemsRequest = ListDatasetRunItemsRequest;
|
|
2115
|
+
type index$y_PaginatedDatasetRunItems = PaginatedDatasetRunItems;
|
|
2116
|
+
declare namespace index$y {
|
|
2117
|
+
export type { index$y_CreateDatasetRunItemRequest as CreateDatasetRunItemRequest, index$y_ListDatasetRunItemsRequest as ListDatasetRunItemsRequest, index$y_PaginatedDatasetRunItems as PaginatedDatasetRunItems };
|
|
2055
2118
|
}
|
|
2056
2119
|
|
|
2057
2120
|
/**
|
|
@@ -2083,6 +2146,7 @@ interface CreateDatasetRequest {
|
|
|
2083
2146
|
interface PaginatedDatasetRuns {
|
|
2084
2147
|
data: DatasetRun[];
|
|
2085
2148
|
meta: MetaResponse;
|
|
2149
|
+
_deprecation?: Deprecation;
|
|
2086
2150
|
}
|
|
2087
2151
|
|
|
2088
2152
|
/**
|
|
@@ -2120,14 +2184,252 @@ interface GetDatasetRunsRequest {
|
|
|
2120
2184
|
limit?: number;
|
|
2121
2185
|
}
|
|
2122
2186
|
|
|
2123
|
-
type index$
|
|
2124
|
-
type index$
|
|
2125
|
-
type index$
|
|
2126
|
-
type index$
|
|
2127
|
-
type index$
|
|
2128
|
-
type index$
|
|
2129
|
-
declare namespace index$
|
|
2130
|
-
export type { index$
|
|
2187
|
+
type index$x_CreateDatasetRequest = CreateDatasetRequest;
|
|
2188
|
+
type index$x_DeleteDatasetRunResponse = DeleteDatasetRunResponse;
|
|
2189
|
+
type index$x_GetDatasetRunsRequest = GetDatasetRunsRequest;
|
|
2190
|
+
type index$x_GetDatasetsRequest = GetDatasetsRequest;
|
|
2191
|
+
type index$x_PaginatedDatasetRuns = PaginatedDatasetRuns;
|
|
2192
|
+
type index$x_PaginatedDatasets = PaginatedDatasets;
|
|
2193
|
+
declare namespace index$x {
|
|
2194
|
+
export type { index$x_CreateDatasetRequest as CreateDatasetRequest, index$x_DeleteDatasetRunResponse as DeleteDatasetRunResponse, index$x_GetDatasetRunsRequest as GetDatasetRunsRequest, index$x_GetDatasetsRequest as GetDatasetsRequest, index$x_PaginatedDatasetRuns as PaginatedDatasetRuns, index$x_PaginatedDatasets as PaginatedDatasets };
|
|
2195
|
+
}
|
|
2196
|
+
|
|
2197
|
+
/**
|
|
2198
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2199
|
+
*/
|
|
2200
|
+
|
|
2201
|
+
interface ExperimentsResponse {
|
|
2202
|
+
data: Experiment[];
|
|
2203
|
+
meta: ExperimentsResponseMeta;
|
|
2204
|
+
}
|
|
2205
|
+
|
|
2206
|
+
/**
|
|
2207
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2208
|
+
*/
|
|
2209
|
+
interface ExperimentsResponseMeta {
|
|
2210
|
+
/** Versioned base64url cursor for retrieving the next page. Absent when there are no more results. */
|
|
2211
|
+
cursor?: string;
|
|
2212
|
+
}
|
|
2213
|
+
|
|
2214
|
+
/**
|
|
2215
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2216
|
+
*/
|
|
2217
|
+
|
|
2218
|
+
interface Experiment {
|
|
2219
|
+
id: string;
|
|
2220
|
+
name: string;
|
|
2221
|
+
description: string | null;
|
|
2222
|
+
/**
|
|
2223
|
+
* Start of the experiment, i.e. the earliest event within the
|
|
2224
|
+
* requested time range. Clipped to `fromStartTime` when the
|
|
2225
|
+
* experiment started before the requested range.
|
|
2226
|
+
*/
|
|
2227
|
+
startTime: string;
|
|
2228
|
+
/**
|
|
2229
|
+
* End of the experiment, i.e. the latest event end within the
|
|
2230
|
+
* requested time range.
|
|
2231
|
+
*/
|
|
2232
|
+
endTime: string;
|
|
2233
|
+
/** Number of experiment items within the requested time range. */
|
|
2234
|
+
itemCount: number;
|
|
2235
|
+
/** Null when the experiment is not associated with a dataset. */
|
|
2236
|
+
datasetId: string | null;
|
|
2237
|
+
/** Included only when `fields=metadata` is requested. */
|
|
2238
|
+
metadata?: Record<string, unknown> | null;
|
|
2239
|
+
/** Included only when `fields=scores` is requested. Contains scores directly attached to the experiment. */
|
|
2240
|
+
scores?: ScoreV3[];
|
|
2241
|
+
}
|
|
2242
|
+
|
|
2243
|
+
/**
|
|
2244
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2245
|
+
*/
|
|
2246
|
+
|
|
2247
|
+
interface ExperimentItemsResponse {
|
|
2248
|
+
data: ExperimentItem[];
|
|
2249
|
+
meta: ExperimentsResponseMeta;
|
|
2250
|
+
}
|
|
2251
|
+
|
|
2252
|
+
/**
|
|
2253
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2254
|
+
*/
|
|
2255
|
+
|
|
2256
|
+
interface ExperimentItem {
|
|
2257
|
+
id: string;
|
|
2258
|
+
traceId: string;
|
|
2259
|
+
startTime: string;
|
|
2260
|
+
endTime: string | null;
|
|
2261
|
+
level: ObservationLevel;
|
|
2262
|
+
environment: string;
|
|
2263
|
+
experimentId: string;
|
|
2264
|
+
experimentName: string;
|
|
2265
|
+
experimentItemId: string;
|
|
2266
|
+
/** Included when `fields=dataset` is requested. */
|
|
2267
|
+
experimentDatasetId?: string | null;
|
|
2268
|
+
/** Included when `fields=dataset` is requested. */
|
|
2269
|
+
experimentItemVersion?: string | null;
|
|
2270
|
+
/** Included when `fields=io` is requested. */
|
|
2271
|
+
input?: unknown;
|
|
2272
|
+
/** Included when `fields=io` is requested. */
|
|
2273
|
+
output?: unknown;
|
|
2274
|
+
/** Included when `fields=io` is requested. */
|
|
2275
|
+
expectedOutput?: unknown;
|
|
2276
|
+
/** Included when `fields=metadata` is requested. */
|
|
2277
|
+
metadata?: Record<string, unknown> | null;
|
|
2278
|
+
/** Included when `fields=itemMetadata` is requested. */
|
|
2279
|
+
experimentItemMetadata?: Record<string, unknown> | null;
|
|
2280
|
+
/** Included when `fields=experimentMetadata` is requested. */
|
|
2281
|
+
experimentMetadata?: Record<string, unknown> | null;
|
|
2282
|
+
/** Included when `fields=experimentMetadata` is requested. */
|
|
2283
|
+
experimentDescription?: string | null;
|
|
2284
|
+
/** Included only when `fields=scores` is requested. Contains item and trace scores only; experiment-level scores are returned by the experiments endpoint. */
|
|
2285
|
+
scores?: ScoreV3[];
|
|
2286
|
+
}
|
|
2287
|
+
|
|
2288
|
+
/**
|
|
2289
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2290
|
+
*/
|
|
2291
|
+
/**
|
|
2292
|
+
* @example
|
|
2293
|
+
* {
|
|
2294
|
+
* fromStartTime: "2024-01-15T09:30:00Z"
|
|
2295
|
+
* }
|
|
2296
|
+
*/
|
|
2297
|
+
interface ListExperimentsRequest {
|
|
2298
|
+
/**
|
|
2299
|
+
* Comma-separated list of field groups to include. Available groups:
|
|
2300
|
+
* `core`, `metadata`, `scores`. If omitted, `core` is returned.
|
|
2301
|
+
*/
|
|
2302
|
+
fields?: string;
|
|
2303
|
+
/** Number of experiments to return per page. Maximum 100, default 50. */
|
|
2304
|
+
limit?: number;
|
|
2305
|
+
/** Number of scores to return per experiment when `fields=scores` is requested. Maximum 50, default 50. */
|
|
2306
|
+
scoreLimit?: number;
|
|
2307
|
+
/** Versioned base64url cursor from the previous response page. */
|
|
2308
|
+
cursor?: string;
|
|
2309
|
+
/** Retrieve only experiments on or after this datetime. */
|
|
2310
|
+
fromStartTime: string;
|
|
2311
|
+
/** Retrieve only experiments before this datetime. */
|
|
2312
|
+
toStartTime?: string;
|
|
2313
|
+
/** Comma-separated list of experiment IDs. */
|
|
2314
|
+
id?: string;
|
|
2315
|
+
/** Comma-separated list of experiment names. */
|
|
2316
|
+
name?: string;
|
|
2317
|
+
/** Comma-separated list of dataset IDs. */
|
|
2318
|
+
datasetId?: string;
|
|
2319
|
+
/**
|
|
2320
|
+
* JSON string containing an array of structured filter conditions.
|
|
2321
|
+
* Supported columns are `id`, `name`, and `datasetId`.
|
|
2322
|
+
*/
|
|
2323
|
+
filter?: string;
|
|
2324
|
+
}
|
|
2325
|
+
|
|
2326
|
+
/**
|
|
2327
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2328
|
+
*/
|
|
2329
|
+
/**
|
|
2330
|
+
* @example
|
|
2331
|
+
* {
|
|
2332
|
+
* fromStartTime: "2024-01-15T09:30:00Z"
|
|
2333
|
+
* }
|
|
2334
|
+
*/
|
|
2335
|
+
interface ListExperimentItemsRequest {
|
|
2336
|
+
/**
|
|
2337
|
+
* Comma-separated list of field groups to include. Available groups:
|
|
2338
|
+
* `core`, `dataset`, `io`, `metadata`, `itemMetadata`,
|
|
2339
|
+
* `experimentMetadata`, `scores`. If omitted, `core,dataset` is
|
|
2340
|
+
* returned.
|
|
2341
|
+
*/
|
|
2342
|
+
fields?: string;
|
|
2343
|
+
/** Number of experiment items to return per page. Maximum 100, default 50. */
|
|
2344
|
+
limit?: number;
|
|
2345
|
+
/** Number of scores to return per experiment item when `fields=scores` is requested. Maximum 50, default 50. */
|
|
2346
|
+
scoreLimit?: number;
|
|
2347
|
+
/** Versioned base64url cursor from the previous response page. */
|
|
2348
|
+
cursor?: string;
|
|
2349
|
+
/** Retrieve only experiment items started on or after this datetime. */
|
|
2350
|
+
fromStartTime: string;
|
|
2351
|
+
/** Retrieve only experiment items started before this datetime. */
|
|
2352
|
+
toStartTime?: string;
|
|
2353
|
+
/** Comma-separated list of experiment IDs. */
|
|
2354
|
+
experimentId?: string;
|
|
2355
|
+
/** Comma-separated list of experiment names. */
|
|
2356
|
+
experimentName?: string;
|
|
2357
|
+
/** Comma-separated list of experiment item IDs. */
|
|
2358
|
+
experimentItemId?: string;
|
|
2359
|
+
/** Comma-separated list of dataset IDs. */
|
|
2360
|
+
datasetId?: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* JSON string containing an array of structured filter conditions.
|
|
2363
|
+
* Supported columns are `experimentId`, `experimentName`,
|
|
2364
|
+
* `experimentItemId`, and `datasetId`.
|
|
2365
|
+
*/
|
|
2366
|
+
filter?: string;
|
|
2367
|
+
}
|
|
2368
|
+
|
|
2369
|
+
type index$w_Experiment = Experiment;
|
|
2370
|
+
type index$w_ExperimentItem = ExperimentItem;
|
|
2371
|
+
type index$w_ExperimentItemsResponse = ExperimentItemsResponse;
|
|
2372
|
+
type index$w_ExperimentsResponse = ExperimentsResponse;
|
|
2373
|
+
type index$w_ExperimentsResponseMeta = ExperimentsResponseMeta;
|
|
2374
|
+
type index$w_ListExperimentItemsRequest = ListExperimentItemsRequest;
|
|
2375
|
+
type index$w_ListExperimentsRequest = ListExperimentsRequest;
|
|
2376
|
+
declare namespace index$w {
|
|
2377
|
+
export type { index$w_Experiment as Experiment, index$w_ExperimentItem as ExperimentItem, index$w_ExperimentItemsResponse as ExperimentItemsResponse, index$w_ExperimentsResponse as ExperimentsResponse, index$w_ExperimentsResponseMeta as ExperimentsResponseMeta, index$w_ListExperimentItemsRequest as ListExperimentItemsRequest, index$w_ListExperimentsRequest as ListExperimentsRequest };
|
|
2378
|
+
}
|
|
2379
|
+
|
|
2380
|
+
/**
|
|
2381
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2382
|
+
*/
|
|
2383
|
+
type FeedbackTargetType = "skill" | "mcp-tool" | "cli" | "docs" | "public-api" | "other";
|
|
2384
|
+
declare const FeedbackTargetType: {
|
|
2385
|
+
readonly Skill: "skill";
|
|
2386
|
+
readonly McpTool: "mcp-tool";
|
|
2387
|
+
readonly Cli: "cli";
|
|
2388
|
+
readonly Docs: "docs";
|
|
2389
|
+
readonly PublicApi: "public-api";
|
|
2390
|
+
readonly Other: "other";
|
|
2391
|
+
};
|
|
2392
|
+
|
|
2393
|
+
/**
|
|
2394
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2395
|
+
*/
|
|
2396
|
+
|
|
2397
|
+
interface SubmitFeedbackRequest {
|
|
2398
|
+
/** Category of the thing the feedback is about. */
|
|
2399
|
+
targetType: FeedbackTargetType;
|
|
2400
|
+
/** The specific instance within targetType: the skill name, MCP tool name, CLI command, API endpoint path, or docs page path (e.g. 'queryMetrics', '/docs/mcp'). An identifier, not a sentence. Must be between 1 and 200 characters. */
|
|
2401
|
+
target: string;
|
|
2402
|
+
/** Concise feedback text approved by the user. Must be between 1 and 3000 characters. */
|
|
2403
|
+
feedback: string;
|
|
2404
|
+
/** Optional user-approved goal or use case they were trying to achieve. Must be between 1 and 1500 characters when provided. Do not include secrets, customer data, trace payloads, or broad unrelated context. */
|
|
2405
|
+
goal?: string;
|
|
2406
|
+
/** Optional HTTP(S) reference URL. Langfuse stores it as text for triage and does not fetch it. */
|
|
2407
|
+
referenceUrl?: string;
|
|
2408
|
+
}
|
|
2409
|
+
|
|
2410
|
+
/**
|
|
2411
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2412
|
+
*/
|
|
2413
|
+
interface SubmitFeedbackResponse {
|
|
2414
|
+
/** Correlation ID for the submitted feedback. */
|
|
2415
|
+
id: string;
|
|
2416
|
+
}
|
|
2417
|
+
|
|
2418
|
+
/**
|
|
2419
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2420
|
+
*/
|
|
2421
|
+
|
|
2422
|
+
declare class FeedbackNotConfiguredError extends LangfuseAPIError {
|
|
2423
|
+
constructor(rawResponse?: RawResponse);
|
|
2424
|
+
}
|
|
2425
|
+
|
|
2426
|
+
type index$v_FeedbackNotConfiguredError = FeedbackNotConfiguredError;
|
|
2427
|
+
declare const index$v_FeedbackNotConfiguredError: typeof FeedbackNotConfiguredError;
|
|
2428
|
+
declare const index$v_FeedbackTargetType: typeof FeedbackTargetType;
|
|
2429
|
+
type index$v_SubmitFeedbackRequest = SubmitFeedbackRequest;
|
|
2430
|
+
type index$v_SubmitFeedbackResponse = SubmitFeedbackResponse;
|
|
2431
|
+
declare namespace index$v {
|
|
2432
|
+
export { index$v_FeedbackNotConfiguredError as FeedbackNotConfiguredError, index$v_FeedbackTargetType as FeedbackTargetType, type index$v_SubmitFeedbackRequest as SubmitFeedbackRequest, type index$v_SubmitFeedbackResponse as SubmitFeedbackResponse };
|
|
2131
2433
|
}
|
|
2132
2434
|
|
|
2133
2435
|
/**
|
|
@@ -2154,11 +2456,11 @@ declare class ServiceUnavailableError extends LangfuseAPIError {
|
|
|
2154
2456
|
constructor(rawResponse?: RawResponse);
|
|
2155
2457
|
}
|
|
2156
2458
|
|
|
2157
|
-
type index$
|
|
2158
|
-
type index$
|
|
2159
|
-
declare const index$
|
|
2160
|
-
declare namespace index$
|
|
2161
|
-
export { type index$
|
|
2459
|
+
type index$u_HealthResponse = HealthResponse;
|
|
2460
|
+
type index$u_ServiceUnavailableError = ServiceUnavailableError;
|
|
2461
|
+
declare const index$u_ServiceUnavailableError: typeof ServiceUnavailableError;
|
|
2462
|
+
declare namespace index$u {
|
|
2463
|
+
export { type index$u_HealthResponse as HealthResponse, index$u_ServiceUnavailableError as ServiceUnavailableError };
|
|
2162
2464
|
}
|
|
2163
2465
|
|
|
2164
2466
|
/**
|
|
@@ -2713,46 +3015,47 @@ interface IngestionRequest {
|
|
|
2713
3015
|
metadata?: unknown;
|
|
2714
3016
|
}
|
|
2715
3017
|
|
|
2716
|
-
type index$
|
|
2717
|
-
type index$
|
|
2718
|
-
type index$
|
|
2719
|
-
type index$
|
|
2720
|
-
type index$
|
|
2721
|
-
type index$
|
|
2722
|
-
type index$
|
|
2723
|
-
type index$
|
|
2724
|
-
type index$
|
|
2725
|
-
declare const index$
|
|
2726
|
-
type index$
|
|
2727
|
-
type index$
|
|
2728
|
-
type index$
|
|
2729
|
-
type index$
|
|
2730
|
-
type index$
|
|
2731
|
-
declare const index$
|
|
2732
|
-
type index$
|
|
2733
|
-
type index$
|
|
2734
|
-
type index$
|
|
2735
|
-
type index$
|
|
2736
|
-
type index$
|
|
2737
|
-
type index$
|
|
2738
|
-
type index$
|
|
2739
|
-
type index$
|
|
2740
|
-
type index$
|
|
2741
|
-
type index$
|
|
2742
|
-
type index$
|
|
2743
|
-
type index$
|
|
2744
|
-
type index$
|
|
2745
|
-
type index$
|
|
2746
|
-
type index$
|
|
2747
|
-
type index$
|
|
2748
|
-
type index$
|
|
2749
|
-
declare namespace index$
|
|
2750
|
-
export { type index$
|
|
3018
|
+
type index$t_BaseEvent = BaseEvent;
|
|
3019
|
+
type index$t_CreateEventBody = CreateEventBody;
|
|
3020
|
+
type index$t_CreateEventEvent = CreateEventEvent;
|
|
3021
|
+
type index$t_CreateGenerationBody = CreateGenerationBody;
|
|
3022
|
+
type index$t_CreateGenerationEvent = CreateGenerationEvent;
|
|
3023
|
+
type index$t_CreateObservationEvent = CreateObservationEvent;
|
|
3024
|
+
type index$t_CreateSpanBody = CreateSpanBody;
|
|
3025
|
+
type index$t_CreateSpanEvent = CreateSpanEvent;
|
|
3026
|
+
type index$t_IngestionError = IngestionError;
|
|
3027
|
+
declare const index$t_IngestionEvent: typeof IngestionEvent;
|
|
3028
|
+
type index$t_IngestionRequest = IngestionRequest;
|
|
3029
|
+
type index$t_IngestionResponse = IngestionResponse;
|
|
3030
|
+
type index$t_IngestionSuccess = IngestionSuccess;
|
|
3031
|
+
type index$t_IngestionUsage = IngestionUsage;
|
|
3032
|
+
type index$t_ObservationBody = ObservationBody;
|
|
3033
|
+
declare const index$t_ObservationType: typeof ObservationType;
|
|
3034
|
+
type index$t_OpenAiCompletionUsageSchema = OpenAiCompletionUsageSchema;
|
|
3035
|
+
type index$t_OpenAiResponseUsageSchema = OpenAiResponseUsageSchema;
|
|
3036
|
+
type index$t_OpenAiUsage = OpenAiUsage;
|
|
3037
|
+
type index$t_OptionalObservationBody = OptionalObservationBody;
|
|
3038
|
+
type index$t_ScoreBody = ScoreBody;
|
|
3039
|
+
type index$t_ScoreEvent = ScoreEvent;
|
|
3040
|
+
type index$t_SdkLogBody = SdkLogBody;
|
|
3041
|
+
type index$t_SdkLogEvent = SdkLogEvent;
|
|
3042
|
+
type index$t_TraceBody = TraceBody;
|
|
3043
|
+
type index$t_TraceEvent = TraceEvent;
|
|
3044
|
+
type index$t_UpdateEventBody = UpdateEventBody;
|
|
3045
|
+
type index$t_UpdateGenerationBody = UpdateGenerationBody;
|
|
3046
|
+
type index$t_UpdateGenerationEvent = UpdateGenerationEvent;
|
|
3047
|
+
type index$t_UpdateObservationEvent = UpdateObservationEvent;
|
|
3048
|
+
type index$t_UpdateSpanBody = UpdateSpanBody;
|
|
3049
|
+
type index$t_UpdateSpanEvent = UpdateSpanEvent;
|
|
3050
|
+
type index$t_UsageDetails = UsageDetails;
|
|
3051
|
+
declare namespace index$t {
|
|
3052
|
+
export { type index$t_BaseEvent as BaseEvent, type index$t_CreateEventBody as CreateEventBody, type index$t_CreateEventEvent as CreateEventEvent, type index$t_CreateGenerationBody as CreateGenerationBody, type index$t_CreateGenerationEvent as CreateGenerationEvent, type index$t_CreateObservationEvent as CreateObservationEvent, type index$t_CreateSpanBody as CreateSpanBody, type index$t_CreateSpanEvent as CreateSpanEvent, type index$t_IngestionError as IngestionError, index$t_IngestionEvent as IngestionEvent, type index$t_IngestionRequest as IngestionRequest, type index$t_IngestionResponse as IngestionResponse, type index$t_IngestionSuccess as IngestionSuccess, type index$t_IngestionUsage as IngestionUsage, type index$t_ObservationBody as ObservationBody, index$t_ObservationType as ObservationType, type index$t_OpenAiCompletionUsageSchema as OpenAiCompletionUsageSchema, type index$t_OpenAiResponseUsageSchema as OpenAiResponseUsageSchema, type index$t_OpenAiUsage as OpenAiUsage, type index$t_OptionalObservationBody as OptionalObservationBody, type index$t_ScoreBody as ScoreBody, type index$t_ScoreEvent as ScoreEvent, type index$t_SdkLogBody as SdkLogBody, type index$t_SdkLogEvent as SdkLogEvent, type index$t_TraceBody as TraceBody, type index$t_TraceEvent as TraceEvent, type index$t_UpdateEventBody as UpdateEventBody, type index$t_UpdateGenerationBody as UpdateGenerationBody, type index$t_UpdateGenerationEvent as UpdateGenerationEvent, type index$t_UpdateObservationEvent as UpdateObservationEvent, type index$t_UpdateSpanBody as UpdateSpanBody, type index$t_UpdateSpanEvent as UpdateSpanEvent, type index$t_UsageDetails as UsageDetails };
|
|
2751
3053
|
}
|
|
2752
3054
|
|
|
2753
3055
|
/**
|
|
2754
3056
|
* This file was auto-generated by Fern from our API Definition.
|
|
2755
3057
|
*/
|
|
3058
|
+
|
|
2756
3059
|
interface MetricsResponse {
|
|
2757
3060
|
/**
|
|
2758
3061
|
* The metrics data. Each item in the list contains the metric values and dimensions requested in the query.
|
|
@@ -2760,6 +3063,7 @@ interface MetricsResponse {
|
|
|
2760
3063
|
* Histograms will return an array with [lower, upper, height] tuples.
|
|
2761
3064
|
*/
|
|
2762
3065
|
data: Record<string, unknown>[];
|
|
3066
|
+
_deprecation?: Deprecation;
|
|
2763
3067
|
}
|
|
2764
3068
|
|
|
2765
3069
|
/**
|
|
@@ -2776,7 +3080,7 @@ interface GetMetricsRequest {
|
|
|
2776
3080
|
* JSON string containing the query parameters with the following structure:
|
|
2777
3081
|
* ```json
|
|
2778
3082
|
* {
|
|
2779
|
-
* "view": string, // Required. One of "traces", "observations", "scores-numeric", "scores-categorical"
|
|
3083
|
+
* "view": string, // Required. One of "traces", "observations", "scores-numeric", "scores-boolean", "scores-categorical"
|
|
2780
3084
|
* "dimensions": [ // Optional. Default: []
|
|
2781
3085
|
* {
|
|
2782
3086
|
* "field": string // Field to group by, e.g. "name", "userId", "sessionId"
|
|
@@ -2818,10 +3122,10 @@ interface GetMetricsRequest {
|
|
|
2818
3122
|
query: string;
|
|
2819
3123
|
}
|
|
2820
3124
|
|
|
2821
|
-
type index$
|
|
2822
|
-
type index$
|
|
2823
|
-
declare namespace index$
|
|
2824
|
-
export type { index$
|
|
3125
|
+
type index$s_GetMetricsRequest = GetMetricsRequest;
|
|
3126
|
+
type index$s_MetricsResponse = MetricsResponse;
|
|
3127
|
+
declare namespace index$s {
|
|
3128
|
+
export type { index$s_GetMetricsRequest as GetMetricsRequest, index$s_MetricsResponse as MetricsResponse };
|
|
2825
3129
|
}
|
|
2826
3130
|
|
|
2827
3131
|
/**
|
|
@@ -2840,6 +3144,7 @@ interface Observations$1 {
|
|
|
2840
3144
|
interface ObservationsViews {
|
|
2841
3145
|
data: ObservationsView[];
|
|
2842
3146
|
meta: MetaResponse;
|
|
3147
|
+
_deprecation?: Deprecation;
|
|
2843
3148
|
}
|
|
2844
3149
|
|
|
2845
3150
|
/**
|
|
@@ -2968,10 +3273,10 @@ interface GetObservationsRequest {
|
|
|
2968
3273
|
filter?: string;
|
|
2969
3274
|
}
|
|
2970
3275
|
|
|
2971
|
-
type index$
|
|
2972
|
-
type index$
|
|
2973
|
-
declare namespace index$
|
|
2974
|
-
export type { index$
|
|
3276
|
+
type index$r_GetObservationsRequest = GetObservationsRequest;
|
|
3277
|
+
type index$r_ObservationsViews = ObservationsViews;
|
|
3278
|
+
declare namespace index$r {
|
|
3279
|
+
export type { index$r_GetObservationsRequest as GetObservationsRequest, Observations$1 as Observations, index$r_ObservationsViews as ObservationsViews };
|
|
2975
3280
|
}
|
|
2976
3281
|
|
|
2977
3282
|
/**
|
|
@@ -3053,7 +3358,7 @@ declare namespace index$p {
|
|
|
3053
3358
|
* dataType: LangfuseAPI.ScoreDataType.Numeric,
|
|
3054
3359
|
* configId: "9203-4567-89ab-cdef",
|
|
3055
3360
|
* traceId: "cdef-1234-5678-90ab",
|
|
3056
|
-
* source: LangfuseAPI.
|
|
3361
|
+
* source: LangfuseAPI.CreateScoreSource.Annotation,
|
|
3057
3362
|
* queueId: "aq-1234-5678-90ab-cdef"
|
|
3058
3363
|
* }
|
|
3059
3364
|
*/
|
|
@@ -3080,6 +3385,14 @@ interface CreateScoreRequest {
|
|
|
3080
3385
|
source?: CreateScoreSource;
|
|
3081
3386
|
}
|
|
3082
3387
|
|
|
3388
|
+
/**
|
|
3389
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3390
|
+
*/
|
|
3391
|
+
interface CreateScoreResponse {
|
|
3392
|
+
/** The id of the created object in Langfuse */
|
|
3393
|
+
id: string;
|
|
3394
|
+
}
|
|
3395
|
+
|
|
3083
3396
|
/**
|
|
3084
3397
|
* This file was auto-generated by Fern from our API Definition.
|
|
3085
3398
|
*/
|
|
@@ -3094,30 +3407,22 @@ declare const CreateScoreSource: {
|
|
|
3094
3407
|
readonly Annotation: "ANNOTATION";
|
|
3095
3408
|
};
|
|
3096
3409
|
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
|
|
3100
|
-
|
|
3101
|
-
|
|
3102
|
-
id: string;
|
|
3103
|
-
}
|
|
3104
|
-
|
|
3105
|
-
type index$o_CreateScoreRequest = CreateScoreRequest;
|
|
3106
|
-
type index$o_CreateScoreResponse = CreateScoreResponse;
|
|
3107
|
-
declare const index$o_CreateScoreSource: typeof CreateScoreSource;
|
|
3108
|
-
declare namespace index$o {
|
|
3109
|
-
export { type index$o_CreateScoreRequest as CreateScoreRequest, type index$o_CreateScoreResponse as CreateScoreResponse, index$o_CreateScoreSource as CreateScoreSource };
|
|
3410
|
+
type index$q_CreateScoreRequest = CreateScoreRequest;
|
|
3411
|
+
type index$q_CreateScoreResponse = CreateScoreResponse;
|
|
3412
|
+
declare const index$q_CreateScoreSource: typeof CreateScoreSource;
|
|
3413
|
+
declare namespace index$q {
|
|
3414
|
+
export { type index$q_CreateScoreRequest as CreateScoreRequest, type index$q_CreateScoreResponse as CreateScoreResponse, index$q_CreateScoreSource as CreateScoreSource };
|
|
3110
3415
|
}
|
|
3111
3416
|
|
|
3112
|
-
type index$
|
|
3113
|
-
type index$
|
|
3114
|
-
declare const index$
|
|
3115
|
-
type index$
|
|
3116
|
-
type index$
|
|
3117
|
-
type index$
|
|
3118
|
-
type index$
|
|
3119
|
-
declare namespace index$
|
|
3120
|
-
export { type index$
|
|
3417
|
+
type index$p_CreateScoreRequest = CreateScoreRequest;
|
|
3418
|
+
type index$p_CreateScoreResponse = CreateScoreResponse;
|
|
3419
|
+
declare const index$p_CreateScoreSource: typeof CreateScoreSource;
|
|
3420
|
+
type index$p_GetMetricsRequest = GetMetricsRequest;
|
|
3421
|
+
type index$p_GetObservationsRequest = GetObservationsRequest;
|
|
3422
|
+
type index$p_MetricsResponse = MetricsResponse;
|
|
3423
|
+
type index$p_ObservationsViews = ObservationsViews;
|
|
3424
|
+
declare namespace index$p {
|
|
3425
|
+
export { type index$p_CreateScoreRequest as CreateScoreRequest, type index$p_CreateScoreResponse as CreateScoreResponse, index$p_CreateScoreSource as CreateScoreSource, type index$p_GetMetricsRequest as GetMetricsRequest, type index$p_GetObservationsRequest as GetObservationsRequest, type index$p_MetricsResponse as MetricsResponse, type Observations$1 as Observations, type index$p_ObservationsViews as ObservationsViews, index$s as metricsV1, index$r as observationsV1, index$q as scoreV1 };
|
|
3121
3426
|
}
|
|
3122
3427
|
|
|
3123
3428
|
/**
|
|
@@ -3217,14 +3522,14 @@ interface GetLlmConnectionsRequest {
|
|
|
3217
3522
|
limit?: number;
|
|
3218
3523
|
}
|
|
3219
3524
|
|
|
3220
|
-
type index$
|
|
3221
|
-
type index$
|
|
3222
|
-
declare const index$
|
|
3223
|
-
type index$
|
|
3224
|
-
type index$
|
|
3225
|
-
type index$
|
|
3226
|
-
declare namespace index$
|
|
3227
|
-
export { type index$
|
|
3525
|
+
type index$o_DeleteLlmConnectionResponse = DeleteLlmConnectionResponse;
|
|
3526
|
+
type index$o_GetLlmConnectionsRequest = GetLlmConnectionsRequest;
|
|
3527
|
+
declare const index$o_LlmAdapter: typeof LlmAdapter;
|
|
3528
|
+
type index$o_LlmConnection = LlmConnection;
|
|
3529
|
+
type index$o_PaginatedLlmConnections = PaginatedLlmConnections;
|
|
3530
|
+
type index$o_UpsertLlmConnectionRequest = UpsertLlmConnectionRequest;
|
|
3531
|
+
declare namespace index$o {
|
|
3532
|
+
export { type index$o_DeleteLlmConnectionResponse as DeleteLlmConnectionResponse, type index$o_GetLlmConnectionsRequest as GetLlmConnectionsRequest, index$o_LlmAdapter as LlmAdapter, type index$o_LlmConnection as LlmConnection, type index$o_PaginatedLlmConnections as PaginatedLlmConnections, type index$o_UpsertLlmConnectionRequest as UpsertLlmConnectionRequest };
|
|
3228
3533
|
}
|
|
3229
3534
|
|
|
3230
3535
|
/**
|
|
@@ -3356,13 +3661,13 @@ declare const MediaContentType: {
|
|
|
3356
3661
|
readonly ApplicationX7ZCompressed: "application/x-7z-compressed";
|
|
3357
3662
|
};
|
|
3358
3663
|
|
|
3359
|
-
type index$
|
|
3360
|
-
type index$
|
|
3361
|
-
type index$
|
|
3362
|
-
declare const index$
|
|
3363
|
-
type index$
|
|
3364
|
-
declare namespace index$
|
|
3365
|
-
export { type index$
|
|
3664
|
+
type index$n_GetMediaResponse = GetMediaResponse;
|
|
3665
|
+
type index$n_GetMediaUploadUrlRequest = GetMediaUploadUrlRequest;
|
|
3666
|
+
type index$n_GetMediaUploadUrlResponse = GetMediaUploadUrlResponse;
|
|
3667
|
+
declare const index$n_MediaContentType: typeof MediaContentType;
|
|
3668
|
+
type index$n_PatchMediaBody = PatchMediaBody;
|
|
3669
|
+
declare namespace index$n {
|
|
3670
|
+
export { type index$n_GetMediaResponse as GetMediaResponse, type index$n_GetMediaUploadUrlRequest as GetMediaUploadUrlRequest, type index$n_GetMediaUploadUrlResponse as GetMediaUploadUrlResponse, index$n_MediaContentType as MediaContentType, type index$n_PatchMediaBody as PatchMediaBody };
|
|
3366
3671
|
}
|
|
3367
3672
|
|
|
3368
3673
|
/**
|
|
@@ -3391,7 +3696,7 @@ interface GetMetricsV2Request {
|
|
|
3391
3696
|
* JSON string containing the query parameters with the following structure:
|
|
3392
3697
|
* ```json
|
|
3393
3698
|
* {
|
|
3394
|
-
* "view": string, // Required. One of "observations", "scores-numeric", "scores-categorical"
|
|
3699
|
+
* "view": string, // Required. One of "observations", "scores-numeric", "scores-boolean", "scores-categorical"
|
|
3395
3700
|
* "dimensions": [ // Optional. Default: []
|
|
3396
3701
|
* {
|
|
3397
3702
|
* "field": string // Field to group by (see available dimensions above)
|
|
@@ -3441,10 +3746,10 @@ interface GetMetricsV2Request {
|
|
|
3441
3746
|
query: string;
|
|
3442
3747
|
}
|
|
3443
3748
|
|
|
3444
|
-
type index$
|
|
3445
|
-
type index$
|
|
3446
|
-
declare namespace index$
|
|
3447
|
-
export type { index$
|
|
3749
|
+
type index$m_GetMetricsV2Request = GetMetricsV2Request;
|
|
3750
|
+
type index$m_MetricsV2Response = MetricsV2Response;
|
|
3751
|
+
declare namespace index$m {
|
|
3752
|
+
export type { index$m_GetMetricsV2Request as GetMetricsV2Request, index$m_MetricsV2Response as MetricsV2Response };
|
|
3448
3753
|
}
|
|
3449
3754
|
|
|
3450
3755
|
/**
|
|
@@ -3516,11 +3821,11 @@ interface GetModelsRequest {
|
|
|
3516
3821
|
limit?: number;
|
|
3517
3822
|
}
|
|
3518
3823
|
|
|
3519
|
-
type index$
|
|
3520
|
-
type index$
|
|
3521
|
-
type index$
|
|
3522
|
-
declare namespace index$
|
|
3523
|
-
export type { index$
|
|
3824
|
+
type index$l_CreateModelRequest = CreateModelRequest;
|
|
3825
|
+
type index$l_GetModelsRequest = GetModelsRequest;
|
|
3826
|
+
type index$l_PaginatedModels = PaginatedModels;
|
|
3827
|
+
declare namespace index$l {
|
|
3828
|
+
export type { index$l_CreateModelRequest as CreateModelRequest, index$l_GetModelsRequest as GetModelsRequest, index$l_PaginatedModels as PaginatedModels };
|
|
3524
3829
|
}
|
|
3525
3830
|
|
|
3526
3831
|
/**
|
|
@@ -3590,7 +3895,17 @@ interface GetObservationsV2Request {
|
|
|
3590
3895
|
traceId?: string;
|
|
3591
3896
|
/** Optional filter for observations with a specific level (e.g. "DEBUG", "DEFAULT", "WARNING", "ERROR"). */
|
|
3592
3897
|
level?: ObservationLevel;
|
|
3898
|
+
/**
|
|
3899
|
+
* Filter by the physical parent observation ID.
|
|
3900
|
+
* An empty value matches only observations without a physical parent. Use `isRootObservation` to include observations marked as app roots by the SDK, which may retain a non-null `parentObservationId`.
|
|
3901
|
+
*/
|
|
3593
3902
|
parentObservationId?: string;
|
|
3903
|
+
/**
|
|
3904
|
+
* Filter by whether an observation is a logical root.
|
|
3905
|
+
* Root observations include observations without a physical parent and observations marked as app roots by the SDK.
|
|
3906
|
+
* An app-root observation may have `isRootObservation=true` and a non-null `parentObservationId`.
|
|
3907
|
+
*/
|
|
3908
|
+
isRootObservation?: boolean;
|
|
3594
3909
|
/** Optional filter for observations where the environment is one of the provided values. */
|
|
3595
3910
|
environment?: string | string[];
|
|
3596
3911
|
/** Retrieve only observations with a start_time on or after this datetime (ISO 8601). */
|
|
@@ -3641,6 +3956,7 @@ interface GetObservationsV2Request {
|
|
|
3641
3956
|
* - `version` (string) - Version tag
|
|
3642
3957
|
* - `userId` (string) - User ID
|
|
3643
3958
|
* - `sessionId` (string) - Session ID
|
|
3959
|
+
* - `isRootObservation` (boolean) - Whether the observation is a logical root. Observations marked as app roots by the SDK may retain a non-null parentObservationId.
|
|
3644
3960
|
*
|
|
3645
3961
|
* ### Trace-Related Fields
|
|
3646
3962
|
* - `traceName` (string) - Name of the parent trace
|
|
@@ -3701,6 +4017,12 @@ interface GetObservationsV2Request {
|
|
|
3701
4017
|
* "column": "output",
|
|
3702
4018
|
* "operator": "matches",
|
|
3703
4019
|
* "value": "needle"
|
|
4020
|
+
* },
|
|
4021
|
+
* {
|
|
4022
|
+
* "type": "boolean",
|
|
4023
|
+
* "column": "isRootObservation",
|
|
4024
|
+
* "operator": "=",
|
|
4025
|
+
* "value": true
|
|
3704
4026
|
* }
|
|
3705
4027
|
* ]
|
|
3706
4028
|
* ```
|
|
@@ -3708,11 +4030,11 @@ interface GetObservationsV2Request {
|
|
|
3708
4030
|
filter?: string;
|
|
3709
4031
|
}
|
|
3710
4032
|
|
|
3711
|
-
type index$
|
|
3712
|
-
type index$
|
|
3713
|
-
type index$
|
|
3714
|
-
declare namespace index$
|
|
3715
|
-
export type { index$
|
|
4033
|
+
type index$k_GetObservationsV2Request = GetObservationsV2Request;
|
|
4034
|
+
type index$k_ObservationsV2Meta = ObservationsV2Meta;
|
|
4035
|
+
type index$k_ObservationsV2Response = ObservationsV2Response;
|
|
4036
|
+
declare namespace index$k {
|
|
4037
|
+
export type { index$k_GetObservationsV2Request as GetObservationsV2Request, index$k_ObservationsV2Meta as ObservationsV2Meta, index$k_ObservationsV2Response as ObservationsV2Response };
|
|
3716
4038
|
}
|
|
3717
4039
|
|
|
3718
4040
|
/**
|
|
@@ -3889,17 +4211,17 @@ interface OtelTraceRequest {
|
|
|
3889
4211
|
resourceSpans: OtelResourceSpan[];
|
|
3890
4212
|
}
|
|
3891
4213
|
|
|
3892
|
-
type index$
|
|
3893
|
-
type index$
|
|
3894
|
-
type index$
|
|
3895
|
-
type index$
|
|
3896
|
-
type index$
|
|
3897
|
-
type index$
|
|
3898
|
-
type index$
|
|
3899
|
-
type index$
|
|
3900
|
-
type index$
|
|
3901
|
-
declare namespace index$
|
|
3902
|
-
export type { index$
|
|
4214
|
+
type index$j_OtelAttribute = OtelAttribute;
|
|
4215
|
+
type index$j_OtelAttributeValue = OtelAttributeValue;
|
|
4216
|
+
type index$j_OtelResource = OtelResource;
|
|
4217
|
+
type index$j_OtelResourceSpan = OtelResourceSpan;
|
|
4218
|
+
type index$j_OtelScope = OtelScope;
|
|
4219
|
+
type index$j_OtelScopeSpan = OtelScopeSpan;
|
|
4220
|
+
type index$j_OtelSpan = OtelSpan;
|
|
4221
|
+
type index$j_OtelTraceRequest = OtelTraceRequest;
|
|
4222
|
+
type index$j_OtelTraceResponse = OtelTraceResponse;
|
|
4223
|
+
declare namespace index$j {
|
|
4224
|
+
export type { index$j_OtelAttribute as OtelAttribute, index$j_OtelAttributeValue as OtelAttributeValue, index$j_OtelResource as OtelResource, index$j_OtelResourceSpan as OtelResourceSpan, index$j_OtelScope as OtelScope, index$j_OtelScopeSpan as OtelScopeSpan, index$j_OtelSpan as OtelSpan, index$j_OtelTraceRequest as OtelTraceRequest, index$j_OtelTraceResponse as OtelTraceResponse };
|
|
3903
4225
|
}
|
|
3904
4226
|
|
|
3905
4227
|
/**
|
|
@@ -3996,18 +4318,18 @@ interface OrganizationApiKeysResponse {
|
|
|
3996
4318
|
apiKeys: OrganizationApiKey[];
|
|
3997
4319
|
}
|
|
3998
4320
|
|
|
3999
|
-
type index$
|
|
4000
|
-
type index$
|
|
4001
|
-
type index$
|
|
4002
|
-
type index$
|
|
4003
|
-
declare const index$
|
|
4004
|
-
type index$
|
|
4005
|
-
type index$
|
|
4006
|
-
type index$
|
|
4007
|
-
type index$
|
|
4008
|
-
type index$
|
|
4009
|
-
declare namespace index$
|
|
4010
|
-
export { type index$
|
|
4321
|
+
type index$i_DeleteMembershipRequest = DeleteMembershipRequest;
|
|
4322
|
+
type index$i_MembershipDeletionResponse = MembershipDeletionResponse;
|
|
4323
|
+
type index$i_MembershipRequest = MembershipRequest;
|
|
4324
|
+
type index$i_MembershipResponse = MembershipResponse;
|
|
4325
|
+
declare const index$i_MembershipRole: typeof MembershipRole;
|
|
4326
|
+
type index$i_MembershipsResponse = MembershipsResponse;
|
|
4327
|
+
type index$i_OrganizationApiKey = OrganizationApiKey;
|
|
4328
|
+
type index$i_OrganizationApiKeysResponse = OrganizationApiKeysResponse;
|
|
4329
|
+
type index$i_OrganizationProject = OrganizationProject;
|
|
4330
|
+
type index$i_OrganizationProjectsResponse = OrganizationProjectsResponse;
|
|
4331
|
+
declare namespace index$i {
|
|
4332
|
+
export { type index$i_DeleteMembershipRequest as DeleteMembershipRequest, type index$i_MembershipDeletionResponse as MembershipDeletionResponse, type index$i_MembershipRequest as MembershipRequest, type index$i_MembershipResponse as MembershipResponse, index$i_MembershipRole as MembershipRole, type index$i_MembershipsResponse as MembershipsResponse, type index$i_OrganizationApiKey as OrganizationApiKey, type index$i_OrganizationApiKeysResponse as OrganizationApiKeysResponse, type index$i_OrganizationProject as OrganizationProject, type index$i_OrganizationProjectsResponse as OrganizationProjectsResponse };
|
|
4011
4333
|
}
|
|
4012
4334
|
|
|
4013
4335
|
/**
|
|
@@ -4166,18 +4488,18 @@ interface CreateApiKeyRequest {
|
|
|
4166
4488
|
secretKey?: string;
|
|
4167
4489
|
}
|
|
4168
4490
|
|
|
4169
|
-
type index$
|
|
4170
|
-
type index$
|
|
4171
|
-
type index$
|
|
4172
|
-
type index$
|
|
4173
|
-
type index$
|
|
4174
|
-
type index$
|
|
4175
|
-
type index$
|
|
4176
|
-
type index$
|
|
4177
|
-
type index$
|
|
4178
|
-
type index$
|
|
4179
|
-
declare namespace index$
|
|
4180
|
-
export type { index$
|
|
4491
|
+
type index$h_ApiKeyDeletionResponse = ApiKeyDeletionResponse;
|
|
4492
|
+
type index$h_ApiKeyList = ApiKeyList;
|
|
4493
|
+
type index$h_ApiKeyResponse = ApiKeyResponse;
|
|
4494
|
+
type index$h_ApiKeySummary = ApiKeySummary;
|
|
4495
|
+
type index$h_CreateApiKeyRequest = CreateApiKeyRequest;
|
|
4496
|
+
type index$h_CreateProjectRequest = CreateProjectRequest;
|
|
4497
|
+
type index$h_Organization = Organization;
|
|
4498
|
+
type index$h_Project = Project;
|
|
4499
|
+
type index$h_ProjectDeletionResponse = ProjectDeletionResponse;
|
|
4500
|
+
type index$h_UpdateProjectRequest = UpdateProjectRequest;
|
|
4501
|
+
declare namespace index$h {
|
|
4502
|
+
export type { index$h_ApiKeyDeletionResponse as ApiKeyDeletionResponse, index$h_ApiKeyList as ApiKeyList, index$h_ApiKeyResponse as ApiKeyResponse, index$h_ApiKeySummary as ApiKeySummary, index$h_CreateApiKeyRequest as CreateApiKeyRequest, index$h_CreateProjectRequest as CreateProjectRequest, index$h_Organization as Organization, index$h_Project as Project, index$h_ProjectDeletionResponse as ProjectDeletionResponse, Projects$1 as Projects, index$h_UpdateProjectRequest as UpdateProjectRequest };
|
|
4181
4503
|
}
|
|
4182
4504
|
|
|
4183
4505
|
/**
|
|
@@ -4409,28 +4731,28 @@ interface DeletePromptRequest {
|
|
|
4409
4731
|
version?: number;
|
|
4410
4732
|
}
|
|
4411
4733
|
|
|
4412
|
-
type index$
|
|
4413
|
-
type index$
|
|
4414
|
-
declare const index$
|
|
4415
|
-
type index$
|
|
4416
|
-
type index$
|
|
4417
|
-
type index$
|
|
4418
|
-
declare const index$
|
|
4419
|
-
type index$
|
|
4420
|
-
type index$
|
|
4421
|
-
declare const index$
|
|
4422
|
-
type index$
|
|
4423
|
-
type index$
|
|
4424
|
-
type index$
|
|
4425
|
-
type index$
|
|
4426
|
-
declare const index$
|
|
4427
|
-
declare const index$
|
|
4428
|
-
type index$
|
|
4429
|
-
type index$
|
|
4430
|
-
declare const index$
|
|
4431
|
-
type index$
|
|
4432
|
-
declare namespace index$
|
|
4433
|
-
export { type index$
|
|
4734
|
+
type index$g_BasePrompt = BasePrompt;
|
|
4735
|
+
type index$g_ChatMessage = ChatMessage;
|
|
4736
|
+
declare const index$g_ChatMessageType: typeof ChatMessageType;
|
|
4737
|
+
type index$g_ChatMessageWithPlaceholders = ChatMessageWithPlaceholders;
|
|
4738
|
+
type index$g_ChatPrompt = ChatPrompt;
|
|
4739
|
+
type index$g_CreateChatPromptRequest = CreateChatPromptRequest;
|
|
4740
|
+
declare const index$g_CreateChatPromptType: typeof CreateChatPromptType;
|
|
4741
|
+
type index$g_CreatePromptRequest = CreatePromptRequest;
|
|
4742
|
+
type index$g_CreateTextPromptRequest = CreateTextPromptRequest;
|
|
4743
|
+
declare const index$g_CreateTextPromptType: typeof CreateTextPromptType;
|
|
4744
|
+
type index$g_DeletePromptRequest = DeletePromptRequest;
|
|
4745
|
+
type index$g_GetPromptRequest = GetPromptRequest;
|
|
4746
|
+
type index$g_ListPromptsMetaRequest = ListPromptsMetaRequest;
|
|
4747
|
+
type index$g_PlaceholderMessage = PlaceholderMessage;
|
|
4748
|
+
declare const index$g_PlaceholderMessageType: typeof PlaceholderMessageType;
|
|
4749
|
+
declare const index$g_Prompt: typeof Prompt;
|
|
4750
|
+
type index$g_PromptMeta = PromptMeta;
|
|
4751
|
+
type index$g_PromptMetaListResponse = PromptMetaListResponse;
|
|
4752
|
+
declare const index$g_PromptType: typeof PromptType;
|
|
4753
|
+
type index$g_TextPrompt = TextPrompt;
|
|
4754
|
+
declare namespace index$g {
|
|
4755
|
+
export { type index$g_BasePrompt as BasePrompt, type index$g_ChatMessage as ChatMessage, index$g_ChatMessageType as ChatMessageType, type index$g_ChatMessageWithPlaceholders as ChatMessageWithPlaceholders, type index$g_ChatPrompt as ChatPrompt, type index$g_CreateChatPromptRequest as CreateChatPromptRequest, index$g_CreateChatPromptType as CreateChatPromptType, type index$g_CreatePromptRequest as CreatePromptRequest, type index$g_CreateTextPromptRequest as CreateTextPromptRequest, index$g_CreateTextPromptType as CreateTextPromptType, type index$g_DeletePromptRequest as DeletePromptRequest, type index$g_GetPromptRequest as GetPromptRequest, type index$g_ListPromptsMetaRequest as ListPromptsMetaRequest, type index$g_PlaceholderMessage as PlaceholderMessage, index$g_PlaceholderMessageType as PlaceholderMessageType, index$g_Prompt as Prompt, type index$g_PromptMeta as PromptMeta, type index$g_PromptMetaListResponse as PromptMetaListResponse, index$g_PromptType as PromptType, type index$g_TextPrompt as TextPrompt };
|
|
4434
4756
|
}
|
|
4435
4757
|
|
|
4436
4758
|
/**
|
|
@@ -4652,27 +4974,27 @@ interface CreateUserRequest {
|
|
|
4652
4974
|
password?: string;
|
|
4653
4975
|
}
|
|
4654
4976
|
|
|
4655
|
-
type index$
|
|
4656
|
-
type index$
|
|
4657
|
-
type index$
|
|
4658
|
-
type index$
|
|
4659
|
-
type index$
|
|
4660
|
-
type index$
|
|
4661
|
-
type index$
|
|
4662
|
-
type index$
|
|
4663
|
-
type index$
|
|
4664
|
-
type index$
|
|
4665
|
-
type index$
|
|
4666
|
-
type index$
|
|
4667
|
-
type index$
|
|
4668
|
-
type index$
|
|
4669
|
-
type index$
|
|
4670
|
-
type index$
|
|
4671
|
-
type index$
|
|
4672
|
-
type index$
|
|
4673
|
-
type index$
|
|
4674
|
-
declare namespace index$
|
|
4675
|
-
export type { index$
|
|
4977
|
+
type index$f_AuthenticationScheme = AuthenticationScheme;
|
|
4978
|
+
type index$f_BulkConfig = BulkConfig;
|
|
4979
|
+
type index$f_CreateUserRequest = CreateUserRequest;
|
|
4980
|
+
type index$f_EmptyResponse = EmptyResponse;
|
|
4981
|
+
type index$f_FilterConfig = FilterConfig;
|
|
4982
|
+
type index$f_ListUsersRequest = ListUsersRequest;
|
|
4983
|
+
type index$f_ResourceMeta = ResourceMeta;
|
|
4984
|
+
type index$f_ResourceType = ResourceType;
|
|
4985
|
+
type index$f_ResourceTypesResponse = ResourceTypesResponse;
|
|
4986
|
+
type index$f_SchemaExtension = SchemaExtension;
|
|
4987
|
+
type index$f_SchemaResource = SchemaResource;
|
|
4988
|
+
type index$f_SchemasResponse = SchemasResponse;
|
|
4989
|
+
type index$f_ScimEmail = ScimEmail;
|
|
4990
|
+
type index$f_ScimFeatureSupport = ScimFeatureSupport;
|
|
4991
|
+
type index$f_ScimName = ScimName;
|
|
4992
|
+
type index$f_ScimUser = ScimUser;
|
|
4993
|
+
type index$f_ScimUsersListResponse = ScimUsersListResponse;
|
|
4994
|
+
type index$f_ServiceProviderConfig = ServiceProviderConfig;
|
|
4995
|
+
type index$f_UserMeta = UserMeta;
|
|
4996
|
+
declare namespace index$f {
|
|
4997
|
+
export type { index$f_AuthenticationScheme as AuthenticationScheme, index$f_BulkConfig as BulkConfig, index$f_CreateUserRequest as CreateUserRequest, index$f_EmptyResponse as EmptyResponse, index$f_FilterConfig as FilterConfig, index$f_ListUsersRequest as ListUsersRequest, index$f_ResourceMeta as ResourceMeta, index$f_ResourceType as ResourceType, index$f_ResourceTypesResponse as ResourceTypesResponse, index$f_SchemaExtension as SchemaExtension, index$f_SchemaResource as SchemaResource, index$f_SchemasResponse as SchemasResponse, index$f_ScimEmail as ScimEmail, index$f_ScimFeatureSupport as ScimFeatureSupport, index$f_ScimName as ScimName, index$f_ScimUser as ScimUser, index$f_ScimUsersListResponse as ScimUsersListResponse, index$f_ServiceProviderConfig as ServiceProviderConfig, index$f_UserMeta as UserMeta };
|
|
4676
4998
|
}
|
|
4677
4999
|
|
|
4678
5000
|
/**
|
|
@@ -4735,11 +5057,11 @@ interface GetScoreConfigsRequest {
|
|
|
4735
5057
|
limit?: number;
|
|
4736
5058
|
}
|
|
4737
5059
|
|
|
4738
|
-
type index$
|
|
4739
|
-
type index$
|
|
4740
|
-
type index$
|
|
4741
|
-
declare namespace index$
|
|
4742
|
-
export type { index$
|
|
5060
|
+
type index$e_CreateScoreConfigRequest = CreateScoreConfigRequest;
|
|
5061
|
+
type index$e_GetScoreConfigsRequest = GetScoreConfigsRequest;
|
|
5062
|
+
type index$e_UpdateScoreConfigRequest = UpdateScoreConfigRequest;
|
|
5063
|
+
declare namespace index$e {
|
|
5064
|
+
export type { index$e_CreateScoreConfigRequest as CreateScoreConfigRequest, index$e_GetScoreConfigsRequest as GetScoreConfigsRequest, ScoreConfigs$1 as ScoreConfigs, index$e_UpdateScoreConfigRequest as UpdateScoreConfigRequest };
|
|
4743
5065
|
}
|
|
4744
5066
|
|
|
4745
5067
|
/**
|
|
@@ -4990,23 +5312,23 @@ interface GetScoresV3Request {
|
|
|
4990
5312
|
toTimestamp?: string;
|
|
4991
5313
|
}
|
|
4992
5314
|
|
|
4993
|
-
type index$
|
|
4994
|
-
type index$
|
|
4995
|
-
type index$
|
|
4996
|
-
type index$
|
|
4997
|
-
type index$
|
|
4998
|
-
type index$
|
|
4999
|
-
type index$
|
|
5000
|
-
type index$
|
|
5001
|
-
type index$
|
|
5002
|
-
type index$
|
|
5003
|
-
type index$
|
|
5004
|
-
type index$
|
|
5005
|
-
declare const index$
|
|
5006
|
-
declare const index$
|
|
5007
|
-
type index$
|
|
5008
|
-
declare namespace index$
|
|
5009
|
-
export { type index$
|
|
5315
|
+
type index$d_BaseScoreV3 = BaseScoreV3;
|
|
5316
|
+
type index$d_BooleanScoreV3 = BooleanScoreV3;
|
|
5317
|
+
type index$d_CategoricalScoreV3 = CategoricalScoreV3;
|
|
5318
|
+
type index$d_CorrectionScoreV3 = CorrectionScoreV3;
|
|
5319
|
+
type index$d_GetScoresV3Meta = GetScoresV3Meta;
|
|
5320
|
+
type index$d_GetScoresV3Request = GetScoresV3Request;
|
|
5321
|
+
type index$d_GetScoresV3Response = GetScoresV3Response;
|
|
5322
|
+
type index$d_NumericScoreV3 = NumericScoreV3;
|
|
5323
|
+
type index$d_ScoreSubjectExperimentV3 = ScoreSubjectExperimentV3;
|
|
5324
|
+
type index$d_ScoreSubjectObservationV3 = ScoreSubjectObservationV3;
|
|
5325
|
+
type index$d_ScoreSubjectSessionV3 = ScoreSubjectSessionV3;
|
|
5326
|
+
type index$d_ScoreSubjectTraceV3 = ScoreSubjectTraceV3;
|
|
5327
|
+
declare const index$d_ScoreSubjectV3: typeof ScoreSubjectV3;
|
|
5328
|
+
declare const index$d_ScoreV3: typeof ScoreV3;
|
|
5329
|
+
type index$d_TextScoreV3 = TextScoreV3;
|
|
5330
|
+
declare namespace index$d {
|
|
5331
|
+
export { type index$d_BaseScoreV3 as BaseScoreV3, type index$d_BooleanScoreV3 as BooleanScoreV3, type index$d_CategoricalScoreV3 as CategoricalScoreV3, type index$d_CorrectionScoreV3 as CorrectionScoreV3, type index$d_GetScoresV3Meta as GetScoresV3Meta, type index$d_GetScoresV3Request as GetScoresV3Request, type index$d_GetScoresV3Response as GetScoresV3Response, type index$d_NumericScoreV3 as NumericScoreV3, type index$d_ScoreSubjectExperimentV3 as ScoreSubjectExperimentV3, type index$d_ScoreSubjectObservationV3 as ScoreSubjectObservationV3, type index$d_ScoreSubjectSessionV3 as ScoreSubjectSessionV3, type index$d_ScoreSubjectTraceV3 as ScoreSubjectTraceV3, index$d_ScoreSubjectV3 as ScoreSubjectV3, index$d_ScoreV3 as ScoreV3, type index$d_TextScoreV3 as TextScoreV3 };
|
|
5010
5332
|
}
|
|
5011
5333
|
|
|
5012
5334
|
/**
|
|
@@ -5093,6 +5415,7 @@ declare namespace GetScoresResponseData {
|
|
|
5093
5415
|
interface GetScoresResponse {
|
|
5094
5416
|
data: GetScoresResponseData[];
|
|
5095
5417
|
meta: MetaResponse;
|
|
5418
|
+
_deprecation?: Deprecation;
|
|
5096
5419
|
}
|
|
5097
5420
|
|
|
5098
5421
|
/**
|
|
@@ -5148,17 +5471,20 @@ interface GetScoresRequest {
|
|
|
5148
5471
|
filter?: string;
|
|
5149
5472
|
}
|
|
5150
5473
|
|
|
5151
|
-
type index$
|
|
5152
|
-
type index$
|
|
5153
|
-
declare const index$
|
|
5154
|
-
type index$
|
|
5155
|
-
type index$
|
|
5156
|
-
|
|
5157
|
-
type index$
|
|
5158
|
-
type index$
|
|
5159
|
-
type index$
|
|
5160
|
-
|
|
5161
|
-
|
|
5474
|
+
type index$c_CreateScoreRequest = CreateScoreRequest;
|
|
5475
|
+
type index$c_CreateScoreResponse = CreateScoreResponse;
|
|
5476
|
+
declare const index$c_CreateScoreSource: typeof CreateScoreSource;
|
|
5477
|
+
type index$c_GetScoresRequest = GetScoresRequest;
|
|
5478
|
+
type index$c_GetScoresResponse = GetScoresResponse;
|
|
5479
|
+
declare const index$c_GetScoresResponseData: typeof GetScoresResponseData;
|
|
5480
|
+
type index$c_GetScoresResponseDataBoolean = GetScoresResponseDataBoolean;
|
|
5481
|
+
type index$c_GetScoresResponseDataCategorical = GetScoresResponseDataCategorical;
|
|
5482
|
+
type index$c_GetScoresResponseDataCorrection = GetScoresResponseDataCorrection;
|
|
5483
|
+
type index$c_GetScoresResponseDataNumeric = GetScoresResponseDataNumeric;
|
|
5484
|
+
type index$c_GetScoresResponseDataText = GetScoresResponseDataText;
|
|
5485
|
+
type index$c_GetScoresResponseTraceData = GetScoresResponseTraceData;
|
|
5486
|
+
declare namespace index$c {
|
|
5487
|
+
export { type index$c_CreateScoreRequest as CreateScoreRequest, type index$c_CreateScoreResponse as CreateScoreResponse, index$c_CreateScoreSource as CreateScoreSource, type index$c_GetScoresRequest as GetScoresRequest, type index$c_GetScoresResponse as GetScoresResponse, index$c_GetScoresResponseData as GetScoresResponseData, type index$c_GetScoresResponseDataBoolean as GetScoresResponseDataBoolean, type index$c_GetScoresResponseDataCategorical as GetScoresResponseDataCategorical, type index$c_GetScoresResponseDataCorrection as GetScoresResponseDataCorrection, type index$c_GetScoresResponseDataNumeric as GetScoresResponseDataNumeric, type index$c_GetScoresResponseDataText as GetScoresResponseDataText, type index$c_GetScoresResponseTraceData as GetScoresResponseTraceData };
|
|
5162
5488
|
}
|
|
5163
5489
|
|
|
5164
5490
|
/**
|
|
@@ -5168,6 +5494,7 @@ declare namespace index$a {
|
|
|
5168
5494
|
interface PaginatedSessions {
|
|
5169
5495
|
data: Session[];
|
|
5170
5496
|
meta: MetaResponse;
|
|
5497
|
+
_deprecation?: Deprecation;
|
|
5171
5498
|
}
|
|
5172
5499
|
|
|
5173
5500
|
/**
|
|
@@ -5190,10 +5517,10 @@ interface GetSessionsRequest {
|
|
|
5190
5517
|
environment?: string | string[];
|
|
5191
5518
|
}
|
|
5192
5519
|
|
|
5193
|
-
type index$
|
|
5194
|
-
type index$
|
|
5195
|
-
declare namespace index$
|
|
5196
|
-
export type { index$
|
|
5520
|
+
type index$b_GetSessionsRequest = GetSessionsRequest;
|
|
5521
|
+
type index$b_PaginatedSessions = PaginatedSessions;
|
|
5522
|
+
declare namespace index$b {
|
|
5523
|
+
export type { index$b_GetSessionsRequest as GetSessionsRequest, index$b_PaginatedSessions as PaginatedSessions };
|
|
5197
5524
|
}
|
|
5198
5525
|
|
|
5199
5526
|
/**
|
|
@@ -5203,6 +5530,7 @@ declare namespace index$9 {
|
|
|
5203
5530
|
interface Traces {
|
|
5204
5531
|
data: TraceWithDetails[];
|
|
5205
5532
|
meta: MetaResponse;
|
|
5533
|
+
_deprecation?: Deprecation;
|
|
5206
5534
|
}
|
|
5207
5535
|
|
|
5208
5536
|
/**
|
|
@@ -5270,7 +5598,7 @@ interface GetTracesRequest {
|
|
|
5270
5598
|
* ```json
|
|
5271
5599
|
* [
|
|
5272
5600
|
* {
|
|
5273
|
-
* "type": string, // Required. One of: "datetime", "string", "number", "stringOptions", "categoryOptions", "arrayOptions", "stringObject", "numberObject", "boolean", "null"
|
|
5601
|
+
* "type": string, // Required. One of: "datetime", "string", "number", "stringOptions", "categoryOptions", "arrayOptions", "stringObject", "numberObject", "booleanObject", "boolean", "null"
|
|
5274
5602
|
* "column": string, // Required. Column to filter on (see available columns below)
|
|
5275
5603
|
* "operator": string, // Required. Operator based on type:
|
|
5276
5604
|
* // - datetime: ">", "<", ">=", "<="
|
|
@@ -5281,10 +5609,11 @@ interface GetTracesRequest {
|
|
|
5281
5609
|
* // - number: "=", ">", "<", ">=", "<="
|
|
5282
5610
|
* // - stringObject: "=", "contains", "does not contain", "starts with", "ends with"
|
|
5283
5611
|
* // - numberObject: "=", ">", "<", ">=", "<="
|
|
5612
|
+
* // - booleanObject: "=", "<>"
|
|
5284
5613
|
* // - boolean: "=", "<>"
|
|
5285
5614
|
* // - null: "is null", "is not null"
|
|
5286
5615
|
* "value": any, // Required (except for null type). Value to compare against. Type depends on filter type
|
|
5287
|
-
* "key": string // Required only for stringObject, numberObject, and categoryOptions types when filtering on nested fields like metadata
|
|
5616
|
+
* "key": string // Required only for stringObject, numberObject, booleanObject, and categoryOptions types when filtering on nested fields like metadata or score names
|
|
5288
5617
|
* }
|
|
5289
5618
|
* ]
|
|
5290
5619
|
* ```
|
|
@@ -5327,6 +5656,7 @@ interface GetTracesRequest {
|
|
|
5327
5656
|
* ### Scores (requires join with scores table)
|
|
5328
5657
|
* - `scores_avg` (number) - Average of numeric scores (alias: `scores`)
|
|
5329
5658
|
* - `score_categories` (categoryOptions) - Categorical score values
|
|
5659
|
+
* - `score_booleans` (booleanObject) - Boolean score values. Use `key` for the score name and a boolean `value`, e.g. `{"type": "booleanObject", "column": "score_booleans", "key": "is_correct", "operator": "=", "value": true}`. The `<>` operator also matches traces without a score of that name.
|
|
5330
5660
|
*
|
|
5331
5661
|
* ## Filter Examples
|
|
5332
5662
|
* ```json
|
|
@@ -5386,14 +5716,14 @@ interface DeleteTracesRequest {
|
|
|
5386
5716
|
traceIds: string[];
|
|
5387
5717
|
}
|
|
5388
5718
|
|
|
5389
|
-
type index$
|
|
5390
|
-
type index$
|
|
5391
|
-
type index$
|
|
5392
|
-
type index$
|
|
5393
|
-
type index$
|
|
5394
|
-
type index$
|
|
5395
|
-
declare namespace index$
|
|
5396
|
-
export type { index$
|
|
5719
|
+
type index$a_DeleteTraceResponse = DeleteTraceResponse;
|
|
5720
|
+
type index$a_DeleteTracesRequest = DeleteTracesRequest;
|
|
5721
|
+
type index$a_GetTraceRequest = GetTraceRequest;
|
|
5722
|
+
type index$a_GetTracesRequest = GetTracesRequest;
|
|
5723
|
+
type index$a_Sort = Sort;
|
|
5724
|
+
type index$a_Traces = Traces;
|
|
5725
|
+
declare namespace index$a {
|
|
5726
|
+
export type { index$a_DeleteTraceResponse as DeleteTraceResponse, index$a_DeleteTracesRequest as DeleteTracesRequest, index$a_GetTraceRequest as GetTraceRequest, index$a_GetTracesRequest as GetTracesRequest, index$a_Sort as Sort, index$a_Traces as Traces };
|
|
5397
5727
|
}
|
|
5398
5728
|
|
|
5399
5729
|
/**
|
|
@@ -5445,7 +5775,7 @@ declare const EvaluatorScope: {
|
|
|
5445
5775
|
*
|
|
5446
5776
|
* Choose the target first, because it changes both the valid filter columns and the valid variable-mapping sources:
|
|
5447
5777
|
* - `observation` evaluates live-ingested observations such as generations, spans, and events.
|
|
5448
|
-
* It supports mapping from `input`, `output`, and `
|
|
5778
|
+
* It supports mapping from `input`, `output`, `metadata`, and `tool_calls`.
|
|
5449
5779
|
* - `experiment` evaluates live experiment executions and can additionally map `expected_output` and `experiment_item_metadata`.
|
|
5450
5780
|
* It currently supports filtering by `datasetId`.
|
|
5451
5781
|
* Discover valid dataset IDs with `GET /api/public/v2/datasets`, then use the returned dataset `id` values in your filter.
|
|
@@ -5482,21 +5812,23 @@ declare const EvaluationRuleStatus: {
|
|
|
5482
5812
|
* Use these values when mapping evaluator prompt variables to live data.
|
|
5483
5813
|
*
|
|
5484
5814
|
* Target-specific rules:
|
|
5485
|
-
* - `target=observation` supports `input`, `output`, and `
|
|
5486
|
-
* - `target=experiment` supports `input`, `output`, `metadata`, `expected_output`, and `experiment_item_metadata`
|
|
5815
|
+
* - `target=observation` supports `input`, `output`, `metadata`, and `tool_calls`
|
|
5816
|
+
* - `target=experiment` supports `input`, `output`, `metadata`, `tool_calls`, `expected_output`, and `experiment_item_metadata`
|
|
5487
5817
|
*
|
|
5488
5818
|
* Source semantics:
|
|
5489
5819
|
* - `input`: the observation or experiment input payload
|
|
5490
5820
|
* - `output`: the observation or experiment output payload
|
|
5491
5821
|
* - `metadata`: the metadata object for the target. Combine with `jsonPath` when you need one nested field instead of the whole object.
|
|
5822
|
+
* - `tool_calls`: the tool calls recorded on the observation, as an array of `{id, name, arguments, type, index}` objects in the order the model emitted them. Combine with `jsonPath` (for example `$[*].name`) to select parts of each call.
|
|
5492
5823
|
* - `expected_output`: the experiment item's expected output. Only valid for `target=experiment`.
|
|
5493
5824
|
* - `experiment_item_metadata`: the experiment item's metadata object. Only valid for `target=experiment`.
|
|
5494
5825
|
*/
|
|
5495
|
-
type EvaluationRuleMappingSource = "input" | "output" | "metadata" | "expected_output" | "experiment_item_metadata";
|
|
5826
|
+
type EvaluationRuleMappingSource = "input" | "output" | "metadata" | "tool_calls" | "expected_output" | "experiment_item_metadata";
|
|
5496
5827
|
declare const EvaluationRuleMappingSource: {
|
|
5497
5828
|
readonly Input: "input";
|
|
5498
5829
|
readonly Output: "output";
|
|
5499
5830
|
readonly Metadata: "metadata";
|
|
5831
|
+
readonly ToolCalls: "tool_calls";
|
|
5500
5832
|
readonly ExpectedOutput: "expected_output";
|
|
5501
5833
|
readonly ExperimentItemMetadata: "experiment_item_metadata";
|
|
5502
5834
|
};
|
|
@@ -5955,8 +6287,8 @@ interface EvaluationRuleMapping {
|
|
|
5955
6287
|
* Source field that should populate the prompt variable.
|
|
5956
6288
|
*
|
|
5957
6289
|
* Quick reference:
|
|
5958
|
-
* - `target=observation`: `input`, `output`, `metadata`
|
|
5959
|
-
* - `target=experiment`: `input`, `output`, `metadata`, `expected_output`, `experiment_item_metadata`
|
|
6290
|
+
* - `target=observation`: `input`, `output`, `metadata`, `tool_calls`
|
|
6291
|
+
* - `target=experiment`: `input`, `output`, `metadata`, `tool_calls`, `expected_output`, `experiment_item_metadata`
|
|
5960
6292
|
*/
|
|
5961
6293
|
source: EvaluationRuleMappingSource;
|
|
5962
6294
|
/**
|
|
@@ -6092,61 +6424,531 @@ declare namespace EvaluationRuleFilter {
|
|
|
6092
6424
|
}
|
|
6093
6425
|
}
|
|
6094
6426
|
|
|
6095
|
-
type index$
|
|
6096
|
-
type index$
|
|
6097
|
-
type index$
|
|
6098
|
-
declare const index$
|
|
6099
|
-
type index$
|
|
6100
|
-
declare const index$
|
|
6101
|
-
declare const index$
|
|
6102
|
-
declare const index$
|
|
6103
|
-
type index$
|
|
6104
|
-
declare const index$
|
|
6105
|
-
declare const index$
|
|
6106
|
-
declare const index$
|
|
6107
|
-
declare const index$
|
|
6108
|
-
declare const index$
|
|
6109
|
-
declare const index$
|
|
6110
|
-
declare const index$
|
|
6111
|
-
type index$
|
|
6112
|
-
declare const index$
|
|
6113
|
-
declare const index$
|
|
6114
|
-
type index$
|
|
6115
|
-
declare const index$
|
|
6116
|
-
declare const index$
|
|
6117
|
-
type index$
|
|
6118
|
-
type index$
|
|
6119
|
-
type index$
|
|
6120
|
-
type index$
|
|
6121
|
-
type index$
|
|
6122
|
-
type index$
|
|
6123
|
-
declare const index$
|
|
6124
|
-
type index$
|
|
6125
|
-
type index$
|
|
6126
|
-
type index$
|
|
6127
|
-
type index$
|
|
6128
|
-
declare namespace index$
|
|
6129
|
-
export { type index$
|
|
6427
|
+
type index$9_ArrayOptionsEvaluationRuleFilter = ArrayOptionsEvaluationRuleFilter;
|
|
6428
|
+
type index$9_BooleanEvaluationRuleFilter = BooleanEvaluationRuleFilter;
|
|
6429
|
+
type index$9_CategoryOptionsEvaluationRuleFilter = CategoryOptionsEvaluationRuleFilter;
|
|
6430
|
+
declare const index$9_CodeEvaluatorSourceCodeLanguage: typeof CodeEvaluatorSourceCodeLanguage;
|
|
6431
|
+
type index$9_DateTimeEvaluationRuleFilter = DateTimeEvaluationRuleFilter;
|
|
6432
|
+
declare const index$9_EvaluationRuleArrayOptionsFilterOperator: typeof EvaluationRuleArrayOptionsFilterOperator;
|
|
6433
|
+
declare const index$9_EvaluationRuleBooleanFilterOperator: typeof EvaluationRuleBooleanFilterOperator;
|
|
6434
|
+
declare const index$9_EvaluationRuleFilter: typeof EvaluationRuleFilter;
|
|
6435
|
+
type index$9_EvaluationRuleMapping = EvaluationRuleMapping;
|
|
6436
|
+
declare const index$9_EvaluationRuleMappingSource: typeof EvaluationRuleMappingSource;
|
|
6437
|
+
declare const index$9_EvaluationRuleNullFilterOperator: typeof EvaluationRuleNullFilterOperator;
|
|
6438
|
+
declare const index$9_EvaluationRuleNumberFilterOperator: typeof EvaluationRuleNumberFilterOperator;
|
|
6439
|
+
declare const index$9_EvaluationRuleOptionsFilterOperator: typeof EvaluationRuleOptionsFilterOperator;
|
|
6440
|
+
declare const index$9_EvaluationRuleStatus: typeof EvaluationRuleStatus;
|
|
6441
|
+
declare const index$9_EvaluationRuleStringFilterOperator: typeof EvaluationRuleStringFilterOperator;
|
|
6442
|
+
declare const index$9_EvaluationRuleTarget: typeof EvaluationRuleTarget;
|
|
6443
|
+
type index$9_EvaluatorModelConfig = EvaluatorModelConfig;
|
|
6444
|
+
declare const index$9_EvaluatorOutputDataType: typeof EvaluatorOutputDataType;
|
|
6445
|
+
declare const index$9_EvaluatorOutputDefinition: typeof EvaluatorOutputDefinition;
|
|
6446
|
+
type index$9_EvaluatorOutputFieldDefinition = EvaluatorOutputFieldDefinition;
|
|
6447
|
+
declare const index$9_EvaluatorScope: typeof EvaluatorScope;
|
|
6448
|
+
declare const index$9_EvaluatorType: typeof EvaluatorType;
|
|
6449
|
+
type index$9_NullEvaluationRuleFilter = NullEvaluationRuleFilter;
|
|
6450
|
+
type index$9_NumberEvaluationRuleFilter = NumberEvaluationRuleFilter;
|
|
6451
|
+
type index$9_NumberObjectEvaluationRuleFilter = NumberObjectEvaluationRuleFilter;
|
|
6452
|
+
type index$9_PublicBooleanEvaluatorOutputDefinition = PublicBooleanEvaluatorOutputDefinition;
|
|
6453
|
+
type index$9_PublicCategoricalEvaluatorOutputDefinition = PublicCategoricalEvaluatorOutputDefinition;
|
|
6454
|
+
type index$9_PublicCategoricalEvaluatorOutputScoreDefinition = PublicCategoricalEvaluatorOutputScoreDefinition;
|
|
6455
|
+
declare const index$9_PublicEvaluatorOutputDefinition: typeof PublicEvaluatorOutputDefinition;
|
|
6456
|
+
type index$9_PublicNumericEvaluatorOutputDefinition = PublicNumericEvaluatorOutputDefinition;
|
|
6457
|
+
type index$9_StringEvaluationRuleFilter = StringEvaluationRuleFilter;
|
|
6458
|
+
type index$9_StringObjectEvaluationRuleFilter = StringObjectEvaluationRuleFilter;
|
|
6459
|
+
type index$9_StringOptionsEvaluationRuleFilter = StringOptionsEvaluationRuleFilter;
|
|
6460
|
+
declare namespace index$9 {
|
|
6461
|
+
export { type index$9_ArrayOptionsEvaluationRuleFilter as ArrayOptionsEvaluationRuleFilter, type index$9_BooleanEvaluationRuleFilter as BooleanEvaluationRuleFilter, type index$9_CategoryOptionsEvaluationRuleFilter as CategoryOptionsEvaluationRuleFilter, index$9_CodeEvaluatorSourceCodeLanguage as CodeEvaluatorSourceCodeLanguage, type index$9_DateTimeEvaluationRuleFilter as DateTimeEvaluationRuleFilter, index$9_EvaluationRuleArrayOptionsFilterOperator as EvaluationRuleArrayOptionsFilterOperator, index$9_EvaluationRuleBooleanFilterOperator as EvaluationRuleBooleanFilterOperator, index$9_EvaluationRuleFilter as EvaluationRuleFilter, type index$9_EvaluationRuleMapping as EvaluationRuleMapping, index$9_EvaluationRuleMappingSource as EvaluationRuleMappingSource, index$9_EvaluationRuleNullFilterOperator as EvaluationRuleNullFilterOperator, index$9_EvaluationRuleNumberFilterOperator as EvaluationRuleNumberFilterOperator, index$9_EvaluationRuleOptionsFilterOperator as EvaluationRuleOptionsFilterOperator, index$9_EvaluationRuleStatus as EvaluationRuleStatus, index$9_EvaluationRuleStringFilterOperator as EvaluationRuleStringFilterOperator, index$9_EvaluationRuleTarget as EvaluationRuleTarget, type index$9_EvaluatorModelConfig as EvaluatorModelConfig, index$9_EvaluatorOutputDataType as EvaluatorOutputDataType, index$9_EvaluatorOutputDefinition as EvaluatorOutputDefinition, type index$9_EvaluatorOutputFieldDefinition as EvaluatorOutputFieldDefinition, index$9_EvaluatorScope as EvaluatorScope, index$9_EvaluatorType as EvaluatorType, type index$9_NullEvaluationRuleFilter as NullEvaluationRuleFilter, type index$9_NumberEvaluationRuleFilter as NumberEvaluationRuleFilter, type index$9_NumberObjectEvaluationRuleFilter as NumberObjectEvaluationRuleFilter, type index$9_PublicBooleanEvaluatorOutputDefinition as PublicBooleanEvaluatorOutputDefinition, type index$9_PublicCategoricalEvaluatorOutputDefinition as PublicCategoricalEvaluatorOutputDefinition, type index$9_PublicCategoricalEvaluatorOutputScoreDefinition as PublicCategoricalEvaluatorOutputScoreDefinition, index$9_PublicEvaluatorOutputDefinition as PublicEvaluatorOutputDefinition, type index$9_PublicNumericEvaluatorOutputDefinition as PublicNumericEvaluatorOutputDefinition, type index$9_StringEvaluationRuleFilter as StringEvaluationRuleFilter, type index$9_StringObjectEvaluationRuleFilter as StringObjectEvaluationRuleFilter, type index$9_StringOptionsEvaluationRuleFilter as StringOptionsEvaluationRuleFilter };
|
|
6130
6462
|
}
|
|
6131
6463
|
|
|
6132
6464
|
/**
|
|
6133
6465
|
* This file was auto-generated by Fern from our API Definition.
|
|
6134
6466
|
*/
|
|
6467
|
+
type DashboardWidgetView = "observations" | "scores-numeric" | "scores-boolean" | "scores-categorical";
|
|
6468
|
+
declare const DashboardWidgetView: {
|
|
6469
|
+
readonly Observations: "observations";
|
|
6470
|
+
readonly ScoresNumeric: "scores-numeric";
|
|
6471
|
+
readonly ScoresBoolean: "scores-boolean";
|
|
6472
|
+
readonly ScoresCategorical: "scores-categorical";
|
|
6473
|
+
};
|
|
6474
|
+
|
|
6135
6475
|
/**
|
|
6136
|
-
*
|
|
6137
|
-
*
|
|
6138
|
-
* SDKs, CLIs, and agents should branch on `code` rather than parsing the human-readable `message`.
|
|
6139
|
-
* The HTTP status still indicates the broad error class, while `code` gives the specific failure reason.
|
|
6476
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6140
6477
|
*/
|
|
6141
|
-
|
|
6142
|
-
|
|
6143
|
-
|
|
6144
|
-
|
|
6145
|
-
|
|
6146
|
-
|
|
6147
|
-
readonly
|
|
6148
|
-
readonly
|
|
6149
|
-
readonly
|
|
6478
|
+
/**
|
|
6479
|
+
* Widget data view. Responses may include the legacy `traces` value for
|
|
6480
|
+
* widgets created before this API existed.
|
|
6481
|
+
*/
|
|
6482
|
+
type DashboardWidgetViewWithLegacy = "observations" | "scores-numeric" | "scores-boolean" | "scores-categorical" | "traces";
|
|
6483
|
+
declare const DashboardWidgetViewWithLegacy: {
|
|
6484
|
+
readonly Observations: "observations";
|
|
6485
|
+
readonly ScoresNumeric: "scores-numeric";
|
|
6486
|
+
readonly ScoresBoolean: "scores-boolean";
|
|
6487
|
+
readonly ScoresCategorical: "scores-categorical";
|
|
6488
|
+
readonly Traces: "traces";
|
|
6489
|
+
};
|
|
6490
|
+
|
|
6491
|
+
/**
|
|
6492
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6493
|
+
*/
|
|
6494
|
+
type DashboardWidgetChartType = "LINE_TIME_SERIES" | "AREA_TIME_SERIES" | "BAR_TIME_SERIES" | "HORIZONTAL_BAR" | "VERTICAL_BAR" | "PIE" | "NUMBER" | "HISTOGRAM" | "PIVOT_TABLE";
|
|
6495
|
+
declare const DashboardWidgetChartType: {
|
|
6496
|
+
readonly LineTimeSeries: "LINE_TIME_SERIES";
|
|
6497
|
+
readonly AreaTimeSeries: "AREA_TIME_SERIES";
|
|
6498
|
+
readonly BarTimeSeries: "BAR_TIME_SERIES";
|
|
6499
|
+
readonly HorizontalBar: "HORIZONTAL_BAR";
|
|
6500
|
+
readonly VerticalBar: "VERTICAL_BAR";
|
|
6501
|
+
readonly Pie: "PIE";
|
|
6502
|
+
readonly Number: "NUMBER";
|
|
6503
|
+
readonly Histogram: "HISTOGRAM";
|
|
6504
|
+
readonly PivotTable: "PIVOT_TABLE";
|
|
6505
|
+
};
|
|
6506
|
+
|
|
6507
|
+
/**
|
|
6508
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6509
|
+
*/
|
|
6510
|
+
type DashboardWidgetMetricAggregation = "sum" | "avg" | "count" | "max" | "min" | "p50" | "p75" | "p90" | "p95" | "p99" | "histogram" | "uniq";
|
|
6511
|
+
declare const DashboardWidgetMetricAggregation: {
|
|
6512
|
+
readonly Sum: "sum";
|
|
6513
|
+
readonly Avg: "avg";
|
|
6514
|
+
readonly Count: "count";
|
|
6515
|
+
readonly Max: "max";
|
|
6516
|
+
readonly Min: "min";
|
|
6517
|
+
readonly P50: "p50";
|
|
6518
|
+
readonly P75: "p75";
|
|
6519
|
+
readonly P90: "p90";
|
|
6520
|
+
readonly P95: "p95";
|
|
6521
|
+
readonly P99: "p99";
|
|
6522
|
+
readonly Histogram: "histogram";
|
|
6523
|
+
readonly Uniq: "uniq";
|
|
6524
|
+
};
|
|
6525
|
+
|
|
6526
|
+
/**
|
|
6527
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6528
|
+
*/
|
|
6529
|
+
interface DashboardWidgetDimension {
|
|
6530
|
+
field: string;
|
|
6531
|
+
}
|
|
6532
|
+
|
|
6533
|
+
/**
|
|
6534
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6535
|
+
*/
|
|
6536
|
+
|
|
6537
|
+
interface DashboardWidgetMetric {
|
|
6538
|
+
measure: string;
|
|
6539
|
+
agg: DashboardWidgetMetricAggregation;
|
|
6540
|
+
}
|
|
6541
|
+
|
|
6542
|
+
/**
|
|
6543
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6544
|
+
*/
|
|
6545
|
+
/**
|
|
6546
|
+
* A filter in Langfuse filter-state shape. The `value` shape and the
|
|
6547
|
+
* allowed operators depend on `type`:
|
|
6548
|
+
*
|
|
6549
|
+
* | `type` | `value` | operators |
|
|
6550
|
+
* |---|---|---|
|
|
6551
|
+
* | `string` | string | `=`, `contains`, `does not contain`, `starts with`, `ends with` |
|
|
6552
|
+
* | `number` | number | `=`, `>`, `<`, `>=`, `<=` |
|
|
6553
|
+
* | `datetime` | ISO datetime string | `>`, `<`, `>=`, `<=` |
|
|
6554
|
+
* | `boolean` | boolean | `=`, `<>` |
|
|
6555
|
+
* | `null` | `""` | `is null`, `is not null` |
|
|
6556
|
+
* | `stringOptions` | list of strings | `any of`, `none of` |
|
|
6557
|
+
* | `arrayOptions` | list of strings | `any of`, `none of`, `all of` |
|
|
6558
|
+
* | `categoryOptions` | list of strings (requires `key`) | `any of`, `none of` |
|
|
6559
|
+
* | `stringObject` | string (requires `key`, e.g. a metadata key) | same as `string` |
|
|
6560
|
+
* | `numberObject` | number (requires `key`, e.g. a score name) | same as `number` |
|
|
6561
|
+
* | `booleanObject` | boolean (requires `key`) | `=`, `<>` |
|
|
6562
|
+
*/
|
|
6563
|
+
interface DashboardWidgetFilter {
|
|
6564
|
+
column: string;
|
|
6565
|
+
operator: string;
|
|
6566
|
+
type: string;
|
|
6567
|
+
value?: unknown;
|
|
6568
|
+
key?: string;
|
|
6569
|
+
}
|
|
6570
|
+
|
|
6571
|
+
/**
|
|
6572
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6573
|
+
*/
|
|
6574
|
+
|
|
6575
|
+
/**
|
|
6576
|
+
* Chart-specific widget configuration.
|
|
6577
|
+
*
|
|
6578
|
+
* `type` must match the top-level `chartType`.
|
|
6579
|
+
* `row_limit` applies to total-value charts and pivot tables.
|
|
6580
|
+
* `bins` applies to histograms.
|
|
6581
|
+
* `defaultSort` applies to pivot tables.
|
|
6582
|
+
*/
|
|
6583
|
+
interface DashboardWidgetChartConfig {
|
|
6584
|
+
type: DashboardWidgetChartType;
|
|
6585
|
+
row_limit?: number;
|
|
6586
|
+
show_value_labels?: boolean;
|
|
6587
|
+
bins?: number;
|
|
6588
|
+
defaultSort?: DashboardWidgetDefaultSort;
|
|
6589
|
+
}
|
|
6590
|
+
|
|
6591
|
+
/**
|
|
6592
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6593
|
+
*/
|
|
6594
|
+
|
|
6595
|
+
interface DashboardWidgetDefaultSort {
|
|
6596
|
+
column: string;
|
|
6597
|
+
order: DashboardWidgetSortOrder;
|
|
6598
|
+
}
|
|
6599
|
+
|
|
6600
|
+
/**
|
|
6601
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6602
|
+
*/
|
|
6603
|
+
type DashboardWidgetSortOrder = "ASC" | "DESC";
|
|
6604
|
+
declare const DashboardWidgetSortOrder: {
|
|
6605
|
+
readonly Asc: "ASC";
|
|
6606
|
+
readonly Desc: "DESC";
|
|
6607
|
+
};
|
|
6608
|
+
|
|
6609
|
+
/**
|
|
6610
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6611
|
+
*/
|
|
6612
|
+
|
|
6613
|
+
/**
|
|
6614
|
+
* Input-side chart config. `type` is optional and defaults to the
|
|
6615
|
+
* widget's `chartType`; when given it must match.
|
|
6616
|
+
*/
|
|
6617
|
+
interface DashboardWidgetChartConfigInput {
|
|
6618
|
+
type?: DashboardWidgetChartType;
|
|
6619
|
+
row_limit?: number;
|
|
6620
|
+
show_value_labels?: boolean;
|
|
6621
|
+
bins?: number;
|
|
6622
|
+
defaultSort?: DashboardWidgetDefaultSort;
|
|
6623
|
+
}
|
|
6624
|
+
|
|
6625
|
+
/**
|
|
6626
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6627
|
+
*/
|
|
6628
|
+
|
|
6629
|
+
interface CreateDashboardWidgetRequest {
|
|
6630
|
+
name: string;
|
|
6631
|
+
/** Defaults to an empty string. */
|
|
6632
|
+
description?: string;
|
|
6633
|
+
view: DashboardWidgetView;
|
|
6634
|
+
dimensions: DashboardWidgetDimension[];
|
|
6635
|
+
metrics: DashboardWidgetMetric[];
|
|
6636
|
+
filters: DashboardWidgetFilter[];
|
|
6637
|
+
chartType: DashboardWidgetChartType;
|
|
6638
|
+
/** Defaults to the plain config for `chartType`. */
|
|
6639
|
+
chartConfig?: DashboardWidgetChartConfigInput;
|
|
6640
|
+
}
|
|
6641
|
+
|
|
6642
|
+
/**
|
|
6643
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6644
|
+
*/
|
|
6645
|
+
|
|
6646
|
+
interface UpdateDashboardWidgetRequest {
|
|
6647
|
+
name?: string;
|
|
6648
|
+
description?: string;
|
|
6649
|
+
view?: DashboardWidgetView;
|
|
6650
|
+
dimensions?: DashboardWidgetDimension[];
|
|
6651
|
+
metrics?: DashboardWidgetMetric[];
|
|
6652
|
+
filters?: DashboardWidgetFilter[];
|
|
6653
|
+
chartType?: DashboardWidgetChartType;
|
|
6654
|
+
chartConfig?: DashboardWidgetChartConfigInput;
|
|
6655
|
+
}
|
|
6656
|
+
|
|
6657
|
+
/**
|
|
6658
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6659
|
+
*/
|
|
6660
|
+
|
|
6661
|
+
interface DashboardWidgetList {
|
|
6662
|
+
data: DashboardWidget[];
|
|
6663
|
+
meta: MetaResponse;
|
|
6664
|
+
}
|
|
6665
|
+
|
|
6666
|
+
/**
|
|
6667
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6668
|
+
*/
|
|
6669
|
+
interface DeleteDashboardWidgetResponse {
|
|
6670
|
+
message: string;
|
|
6671
|
+
}
|
|
6672
|
+
|
|
6673
|
+
/**
|
|
6674
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6675
|
+
*/
|
|
6676
|
+
|
|
6677
|
+
interface DashboardWidget {
|
|
6678
|
+
id: string;
|
|
6679
|
+
createdAt: string;
|
|
6680
|
+
updatedAt: string;
|
|
6681
|
+
name: string;
|
|
6682
|
+
description: string;
|
|
6683
|
+
view: DashboardWidgetViewWithLegacy;
|
|
6684
|
+
dimensions: DashboardWidgetDimension[];
|
|
6685
|
+
metrics: DashboardWidgetMetric[];
|
|
6686
|
+
filters: DashboardWidgetFilter[];
|
|
6687
|
+
chartType: DashboardWidgetChartType;
|
|
6688
|
+
chartConfig: DashboardWidgetChartConfig;
|
|
6689
|
+
}
|
|
6690
|
+
|
|
6691
|
+
/**
|
|
6692
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6693
|
+
*/
|
|
6694
|
+
/**
|
|
6695
|
+
* @example
|
|
6696
|
+
* {}
|
|
6697
|
+
*/
|
|
6698
|
+
interface ListDashboardWidgetsRequest {
|
|
6699
|
+
/** 1-based page number. Defaults to `1`. */
|
|
6700
|
+
page?: number;
|
|
6701
|
+
/** Maximum number of items per page. Defaults to `50`. */
|
|
6702
|
+
limit?: number;
|
|
6703
|
+
}
|
|
6704
|
+
|
|
6705
|
+
type index$8_CreateDashboardWidgetRequest = CreateDashboardWidgetRequest;
|
|
6706
|
+
type index$8_DashboardWidget = DashboardWidget;
|
|
6707
|
+
type index$8_DashboardWidgetChartConfig = DashboardWidgetChartConfig;
|
|
6708
|
+
type index$8_DashboardWidgetChartConfigInput = DashboardWidgetChartConfigInput;
|
|
6709
|
+
declare const index$8_DashboardWidgetChartType: typeof DashboardWidgetChartType;
|
|
6710
|
+
type index$8_DashboardWidgetDefaultSort = DashboardWidgetDefaultSort;
|
|
6711
|
+
type index$8_DashboardWidgetDimension = DashboardWidgetDimension;
|
|
6712
|
+
type index$8_DashboardWidgetFilter = DashboardWidgetFilter;
|
|
6713
|
+
type index$8_DashboardWidgetList = DashboardWidgetList;
|
|
6714
|
+
type index$8_DashboardWidgetMetric = DashboardWidgetMetric;
|
|
6715
|
+
declare const index$8_DashboardWidgetMetricAggregation: typeof DashboardWidgetMetricAggregation;
|
|
6716
|
+
declare const index$8_DashboardWidgetSortOrder: typeof DashboardWidgetSortOrder;
|
|
6717
|
+
declare const index$8_DashboardWidgetView: typeof DashboardWidgetView;
|
|
6718
|
+
declare const index$8_DashboardWidgetViewWithLegacy: typeof DashboardWidgetViewWithLegacy;
|
|
6719
|
+
type index$8_DeleteDashboardWidgetResponse = DeleteDashboardWidgetResponse;
|
|
6720
|
+
type index$8_ListDashboardWidgetsRequest = ListDashboardWidgetsRequest;
|
|
6721
|
+
type index$8_UpdateDashboardWidgetRequest = UpdateDashboardWidgetRequest;
|
|
6722
|
+
declare namespace index$8 {
|
|
6723
|
+
export { type index$8_CreateDashboardWidgetRequest as CreateDashboardWidgetRequest, type index$8_DashboardWidget as DashboardWidget, type index$8_DashboardWidgetChartConfig as DashboardWidgetChartConfig, type index$8_DashboardWidgetChartConfigInput as DashboardWidgetChartConfigInput, index$8_DashboardWidgetChartType as DashboardWidgetChartType, type index$8_DashboardWidgetDefaultSort as DashboardWidgetDefaultSort, type index$8_DashboardWidgetDimension as DashboardWidgetDimension, type index$8_DashboardWidgetFilter as DashboardWidgetFilter, type index$8_DashboardWidgetList as DashboardWidgetList, type index$8_DashboardWidgetMetric as DashboardWidgetMetric, index$8_DashboardWidgetMetricAggregation as DashboardWidgetMetricAggregation, index$8_DashboardWidgetSortOrder as DashboardWidgetSortOrder, index$8_DashboardWidgetView as DashboardWidgetView, index$8_DashboardWidgetViewWithLegacy as DashboardWidgetViewWithLegacy, type index$8_DeleteDashboardWidgetResponse as DeleteDashboardWidgetResponse, type index$8_ListDashboardWidgetsRequest as ListDashboardWidgetsRequest, type index$8_UpdateDashboardWidgetRequest as UpdateDashboardWidgetRequest };
|
|
6724
|
+
}
|
|
6725
|
+
|
|
6726
|
+
/**
|
|
6727
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6728
|
+
*/
|
|
6729
|
+
|
|
6730
|
+
/**
|
|
6731
|
+
* A tile on the dashboard's 12-column grid. `x`/`y` are the tile's
|
|
6732
|
+
* top-left cell (0-based; `y` grows downward), `width`/`height` its size
|
|
6733
|
+
* in cells. The UI default tile is 6x6 (half width). Overlapping tiles
|
|
6734
|
+
* are not rejected; prefer appending below existing tiles (or omit the
|
|
6735
|
+
* position on create to let the server do it).
|
|
6736
|
+
*/
|
|
6737
|
+
type DashboardPlacement = DashboardPlacement.Widget | DashboardPlacement.Preset;
|
|
6738
|
+
declare namespace DashboardPlacement {
|
|
6739
|
+
interface Widget extends WidgetPlacement {
|
|
6740
|
+
type: "widget";
|
|
6741
|
+
}
|
|
6742
|
+
interface Preset extends PresetPlacement {
|
|
6743
|
+
type: "preset";
|
|
6744
|
+
}
|
|
6745
|
+
}
|
|
6746
|
+
|
|
6747
|
+
/**
|
|
6748
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6749
|
+
*/
|
|
6750
|
+
interface WidgetPlacement {
|
|
6751
|
+
id: string;
|
|
6752
|
+
widgetId: string;
|
|
6753
|
+
x: number;
|
|
6754
|
+
y: number;
|
|
6755
|
+
width: number;
|
|
6756
|
+
height: number;
|
|
6757
|
+
}
|
|
6758
|
+
|
|
6759
|
+
/**
|
|
6760
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6761
|
+
*/
|
|
6762
|
+
interface PresetPlacement {
|
|
6763
|
+
id: string;
|
|
6764
|
+
presetId: string;
|
|
6765
|
+
x: number;
|
|
6766
|
+
y: number;
|
|
6767
|
+
width: number;
|
|
6768
|
+
height: number;
|
|
6769
|
+
}
|
|
6770
|
+
|
|
6771
|
+
/**
|
|
6772
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6773
|
+
*/
|
|
6774
|
+
|
|
6775
|
+
type CreateDashboardPlacementRequest = CreateDashboardPlacementRequest.Widget | CreateDashboardPlacementRequest.Preset;
|
|
6776
|
+
declare namespace CreateDashboardPlacementRequest {
|
|
6777
|
+
interface Widget extends CreateWidgetPlacement {
|
|
6778
|
+
type: "widget";
|
|
6779
|
+
}
|
|
6780
|
+
interface Preset extends CreatePresetPlacement {
|
|
6781
|
+
type: "preset";
|
|
6782
|
+
}
|
|
6783
|
+
}
|
|
6784
|
+
|
|
6785
|
+
/**
|
|
6786
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6787
|
+
*/
|
|
6788
|
+
interface CreateWidgetPlacement {
|
|
6789
|
+
/** Server-generated when omitted. */
|
|
6790
|
+
id?: string;
|
|
6791
|
+
widgetId: string;
|
|
6792
|
+
/** Grid column (12-column grid). Defaults to `0`. */
|
|
6793
|
+
x?: number;
|
|
6794
|
+
/** Grid row. Defaults to the first row below all existing tiles. */
|
|
6795
|
+
y?: number;
|
|
6796
|
+
/** Width in grid columns. Defaults to `6`. */
|
|
6797
|
+
width?: number;
|
|
6798
|
+
/** Height in grid rows. Defaults to `6`. */
|
|
6799
|
+
height?: number;
|
|
6800
|
+
}
|
|
6801
|
+
|
|
6802
|
+
/**
|
|
6803
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6804
|
+
*/
|
|
6805
|
+
interface CreatePresetPlacement {
|
|
6806
|
+
/** Server-generated when omitted. */
|
|
6807
|
+
id?: string;
|
|
6808
|
+
presetId: string;
|
|
6809
|
+
/** Grid column (12-column grid). Defaults to `0`. */
|
|
6810
|
+
x?: number;
|
|
6811
|
+
/** Grid row. Defaults to the first row below all existing tiles. */
|
|
6812
|
+
y?: number;
|
|
6813
|
+
/** Width in grid columns. Defaults to `6`. */
|
|
6814
|
+
width?: number;
|
|
6815
|
+
/** Height in grid rows. Defaults to `6`. */
|
|
6816
|
+
height?: number;
|
|
6817
|
+
}
|
|
6818
|
+
|
|
6819
|
+
/**
|
|
6820
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6821
|
+
*/
|
|
6822
|
+
interface UpdateDashboardPlacementRequest {
|
|
6823
|
+
/** Grid column (12-column grid). */
|
|
6824
|
+
x?: number;
|
|
6825
|
+
/** Grid row. */
|
|
6826
|
+
y?: number;
|
|
6827
|
+
/** Width in grid columns. */
|
|
6828
|
+
width?: number;
|
|
6829
|
+
/** Height in grid rows. */
|
|
6830
|
+
height?: number;
|
|
6831
|
+
}
|
|
6832
|
+
|
|
6833
|
+
/**
|
|
6834
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6835
|
+
*/
|
|
6836
|
+
interface DeleteDashboardPlacementResponse {
|
|
6837
|
+
message: string;
|
|
6838
|
+
}
|
|
6839
|
+
|
|
6840
|
+
/**
|
|
6841
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6842
|
+
*/
|
|
6843
|
+
|
|
6844
|
+
interface DashboardDefinition {
|
|
6845
|
+
widgets: DashboardPlacement[];
|
|
6846
|
+
}
|
|
6847
|
+
|
|
6848
|
+
/**
|
|
6849
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6850
|
+
*/
|
|
6851
|
+
|
|
6852
|
+
interface Dashboard {
|
|
6853
|
+
id: string;
|
|
6854
|
+
createdAt: string;
|
|
6855
|
+
updatedAt: string;
|
|
6856
|
+
name: string;
|
|
6857
|
+
description: string;
|
|
6858
|
+
definition: DashboardDefinition;
|
|
6859
|
+
/** Dashboard-level filters applied to all widgets on the dashboard. */
|
|
6860
|
+
filters: DashboardWidgetFilter[];
|
|
6861
|
+
}
|
|
6862
|
+
|
|
6863
|
+
/**
|
|
6864
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6865
|
+
*/
|
|
6866
|
+
|
|
6867
|
+
interface DashboardList {
|
|
6868
|
+
data: Dashboard[];
|
|
6869
|
+
meta: MetaResponse;
|
|
6870
|
+
}
|
|
6871
|
+
|
|
6872
|
+
/**
|
|
6873
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6874
|
+
*/
|
|
6875
|
+
|
|
6876
|
+
interface CreateDashboardRequest {
|
|
6877
|
+
name: string;
|
|
6878
|
+
description?: string;
|
|
6879
|
+
definition?: DashboardDefinition;
|
|
6880
|
+
filters?: DashboardWidgetFilter[];
|
|
6881
|
+
}
|
|
6882
|
+
|
|
6883
|
+
/**
|
|
6884
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6885
|
+
*/
|
|
6886
|
+
|
|
6887
|
+
interface UpdateDashboardRequest {
|
|
6888
|
+
name?: string;
|
|
6889
|
+
description?: string;
|
|
6890
|
+
definition?: DashboardDefinition;
|
|
6891
|
+
filters?: DashboardWidgetFilter[];
|
|
6892
|
+
}
|
|
6893
|
+
|
|
6894
|
+
/**
|
|
6895
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6896
|
+
*/
|
|
6897
|
+
interface DeleteDashboardResponse {
|
|
6898
|
+
message: string;
|
|
6899
|
+
}
|
|
6900
|
+
|
|
6901
|
+
/**
|
|
6902
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6903
|
+
*/
|
|
6904
|
+
/**
|
|
6905
|
+
* @example
|
|
6906
|
+
* {}
|
|
6907
|
+
*/
|
|
6908
|
+
interface ListDashboardsRequest {
|
|
6909
|
+
/** 1-based page number. Defaults to `1`. */
|
|
6910
|
+
page?: number;
|
|
6911
|
+
/** Maximum number of items per page. Defaults to `50`. */
|
|
6912
|
+
limit?: number;
|
|
6913
|
+
}
|
|
6914
|
+
|
|
6915
|
+
declare const index$7_CreateDashboardPlacementRequest: typeof CreateDashboardPlacementRequest;
|
|
6916
|
+
type index$7_CreateDashboardRequest = CreateDashboardRequest;
|
|
6917
|
+
type index$7_CreatePresetPlacement = CreatePresetPlacement;
|
|
6918
|
+
type index$7_CreateWidgetPlacement = CreateWidgetPlacement;
|
|
6919
|
+
type index$7_Dashboard = Dashboard;
|
|
6920
|
+
type index$7_DashboardDefinition = DashboardDefinition;
|
|
6921
|
+
type index$7_DashboardList = DashboardList;
|
|
6922
|
+
declare const index$7_DashboardPlacement: typeof DashboardPlacement;
|
|
6923
|
+
type index$7_DeleteDashboardPlacementResponse = DeleteDashboardPlacementResponse;
|
|
6924
|
+
type index$7_DeleteDashboardResponse = DeleteDashboardResponse;
|
|
6925
|
+
type index$7_ListDashboardsRequest = ListDashboardsRequest;
|
|
6926
|
+
type index$7_PresetPlacement = PresetPlacement;
|
|
6927
|
+
type index$7_UpdateDashboardPlacementRequest = UpdateDashboardPlacementRequest;
|
|
6928
|
+
type index$7_UpdateDashboardRequest = UpdateDashboardRequest;
|
|
6929
|
+
type index$7_WidgetPlacement = WidgetPlacement;
|
|
6930
|
+
declare namespace index$7 {
|
|
6931
|
+
export { index$7_CreateDashboardPlacementRequest as CreateDashboardPlacementRequest, type index$7_CreateDashboardRequest as CreateDashboardRequest, type index$7_CreatePresetPlacement as CreatePresetPlacement, type index$7_CreateWidgetPlacement as CreateWidgetPlacement, type index$7_Dashboard as Dashboard, type index$7_DashboardDefinition as DashboardDefinition, type index$7_DashboardList as DashboardList, index$7_DashboardPlacement as DashboardPlacement, type index$7_DeleteDashboardPlacementResponse as DeleteDashboardPlacementResponse, type index$7_DeleteDashboardResponse as DeleteDashboardResponse, type index$7_ListDashboardsRequest as ListDashboardsRequest, type index$7_PresetPlacement as PresetPlacement, type index$7_UpdateDashboardPlacementRequest as UpdateDashboardPlacementRequest, type index$7_UpdateDashboardRequest as UpdateDashboardRequest, type index$7_WidgetPlacement as WidgetPlacement };
|
|
6932
|
+
}
|
|
6933
|
+
|
|
6934
|
+
/**
|
|
6935
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6936
|
+
*/
|
|
6937
|
+
/**
|
|
6938
|
+
* Machine-readable error code returned by the unstable evaluators API.
|
|
6939
|
+
*
|
|
6940
|
+
* SDKs, CLIs, and agents should branch on `code` rather than parsing the human-readable `message`.
|
|
6941
|
+
* The HTTP status still indicates the broad error class, while `code` gives the specific failure reason.
|
|
6942
|
+
*/
|
|
6943
|
+
type PublicApiErrorCode = "authentication_failed" | "access_denied" | "invalid_request" | "invalid_query" | "invalid_body" | "invalid_filter_value" | "invalid_json_path" | "invalid_variable_mapping" | "missing_variable_mapping" | "duplicate_variable_mapping" | "resource_not_found" | "name_conflict" | "evaluator_preflight_failed" | "conflict" | "unprocessable_content" | "rate_limited" | "method_not_allowed" | "internal_error";
|
|
6944
|
+
declare const PublicApiErrorCode: {
|
|
6945
|
+
readonly AuthenticationFailed: "authentication_failed";
|
|
6946
|
+
readonly AccessDenied: "access_denied";
|
|
6947
|
+
readonly InvalidRequest: "invalid_request";
|
|
6948
|
+
readonly InvalidQuery: "invalid_query";
|
|
6949
|
+
readonly InvalidBody: "invalid_body";
|
|
6950
|
+
readonly InvalidFilterValue: "invalid_filter_value";
|
|
6951
|
+
readonly InvalidJsonPath: "invalid_json_path";
|
|
6150
6952
|
readonly InvalidVariableMapping: "invalid_variable_mapping";
|
|
6151
6953
|
readonly MissingVariableMapping: "missing_variable_mapping";
|
|
6152
6954
|
readonly DuplicateVariableMapping: "duplicate_variable_mapping";
|
|
@@ -6449,7 +7251,47 @@ declare namespace index$6 {
|
|
|
6449
7251
|
* - `enabled` is the desired on/off setting from the client
|
|
6450
7252
|
* - `status` is the effective runtime state after Langfuse applies validation and blocking rules
|
|
6451
7253
|
* - `enabled=true` with `status=paused` means the rule should run, but Langfuse has paused it until the underlying problem is fixed
|
|
6452
|
-
|
|
7254
|
+
*/
|
|
7255
|
+
interface EvaluationRuleBase {
|
|
7256
|
+
/** Stable evaluation rule identifier. */
|
|
7257
|
+
id: string;
|
|
7258
|
+
/** Human-readable deployment name. This is independent from the evaluator name. */
|
|
7259
|
+
name: string;
|
|
7260
|
+
/**
|
|
7261
|
+
* Evaluator currently used by this rule.
|
|
7262
|
+
*
|
|
7263
|
+
* `name` and `scope` identify the evaluator family conceptually.
|
|
7264
|
+
* `id` is the currently active evaluator version in that family.
|
|
7265
|
+
* If you create a newer project version with the same evaluator name later, existing evaluation rules are moved to it automatically.
|
|
7266
|
+
*/
|
|
7267
|
+
evaluator: EvaluationRuleEvaluator;
|
|
7268
|
+
/** Desired enabled state configured by the client. */
|
|
7269
|
+
enabled: boolean;
|
|
7270
|
+
/** Effective runtime status after Langfuse applies validation and blocking rules. */
|
|
7271
|
+
status: EvaluationRuleStatus;
|
|
7272
|
+
/** Machine-readable reason when `status=paused`, otherwise `null`. */
|
|
7273
|
+
pausedReason: string | null;
|
|
7274
|
+
/** Human-readable explanation when `status=paused`, otherwise `null`. */
|
|
7275
|
+
pausedMessage: string | null;
|
|
7276
|
+
/**
|
|
7277
|
+
* Fraction of matching target objects that should be evaluated.
|
|
7278
|
+
*
|
|
7279
|
+
* Must be greater than `0` and less than or equal to `1`.
|
|
7280
|
+
* - `1` means evaluate every matching target.
|
|
7281
|
+
* - `0.25` means evaluate approximately 25% of matching targets.
|
|
7282
|
+
*/
|
|
7283
|
+
sampling: number;
|
|
7284
|
+
/** Timestamp when the evaluation rule was created. */
|
|
7285
|
+
createdAt: string;
|
|
7286
|
+
/** Timestamp when the evaluation rule was last updated. */
|
|
7287
|
+
updatedAt: string;
|
|
7288
|
+
}
|
|
7289
|
+
|
|
7290
|
+
/**
|
|
7291
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
7292
|
+
*/
|
|
7293
|
+
|
|
7294
|
+
/**
|
|
6453
7295
|
* @example
|
|
6454
7296
|
* {
|
|
6455
7297
|
* id: "erule_123",
|
|
@@ -6483,47 +7325,45 @@ declare namespace index$6 {
|
|
|
6483
7325
|
* updatedAt: "2026-03-30T09:20:00.000Z"
|
|
6484
7326
|
* }
|
|
6485
7327
|
*/
|
|
6486
|
-
interface EvaluationRule {
|
|
6487
|
-
/** Stable evaluation rule identifier. */
|
|
6488
|
-
id: string;
|
|
6489
|
-
/** Human-readable deployment name. This is independent from the evaluator name. */
|
|
6490
|
-
name: string;
|
|
6491
|
-
/**
|
|
6492
|
-
* Evaluator currently used by this rule.
|
|
6493
|
-
*
|
|
6494
|
-
* `name` and `scope` identify the evaluator family conceptually.
|
|
6495
|
-
* `id` is the currently active evaluator version in that family.
|
|
6496
|
-
* If you create a newer project version with the same evaluator name later, existing evaluation rules are moved to it automatically.
|
|
6497
|
-
*/
|
|
6498
|
-
evaluator: EvaluationRuleEvaluator;
|
|
7328
|
+
interface EvaluationRule extends EvaluationRuleBase {
|
|
6499
7329
|
/** Target object type that should trigger scoring. */
|
|
6500
7330
|
target: EvaluationRuleTarget;
|
|
6501
|
-
/** Desired enabled state configured by the client. */
|
|
6502
|
-
enabled: boolean;
|
|
6503
|
-
/** Effective runtime status after Langfuse applies validation and blocking rules. */
|
|
6504
|
-
status: EvaluationRuleStatus;
|
|
6505
|
-
/** Machine-readable reason when `status=paused`, otherwise `null`. */
|
|
6506
|
-
pausedReason: string | null;
|
|
6507
|
-
/** Human-readable explanation when `status=paused`, otherwise `null`. */
|
|
6508
|
-
pausedMessage: string | null;
|
|
6509
|
-
/**
|
|
6510
|
-
* Fraction of matching target objects that should be evaluated.
|
|
6511
|
-
*
|
|
6512
|
-
* Must be greater than `0` and less than or equal to `1`.
|
|
6513
|
-
* - `1` means evaluate every matching target.
|
|
6514
|
-
* - `0.25` means evaluate approximately 25% of matching targets.
|
|
6515
|
-
*/
|
|
6516
|
-
sampling: number;
|
|
6517
7331
|
/** List of filter conditions used to decide whether a target should be evaluated. */
|
|
6518
7332
|
filter: EvaluationRuleFilter[];
|
|
6519
7333
|
/** Variable mappings used to populate evaluator runtime variables from the live target object. */
|
|
6520
7334
|
mapping: EvaluationRuleMapping[];
|
|
6521
|
-
/** Timestamp when the evaluation rule was created. */
|
|
6522
|
-
createdAt: string;
|
|
6523
|
-
/** Timestamp when the evaluation rule was last updated. */
|
|
6524
|
-
updatedAt: string;
|
|
6525
7335
|
}
|
|
6526
7336
|
|
|
7337
|
+
/**
|
|
7338
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
7339
|
+
*/
|
|
7340
|
+
|
|
7341
|
+
/**
|
|
7342
|
+
* Legacy trace- or dataset-level evaluation rule returned by list and get for migration.
|
|
7343
|
+
*
|
|
7344
|
+
* This resource is read-only through the unstable public API. Its mapping preserves the trace, dataset item, or named observation that each evaluator variable previously read from. Its filters use the persisted legacy filter format so migration clients can read the configuration without losing information.
|
|
7345
|
+
*/
|
|
7346
|
+
interface LegacyEvaluationRule extends EvaluationRuleBase {
|
|
7347
|
+
target: LegacyEvaluationRuleTarget;
|
|
7348
|
+
/** Delay in milliseconds before the legacy evaluation job runs. */
|
|
7349
|
+
delay: number;
|
|
7350
|
+
/** Whether the legacy rule evaluates newly ingested data, existing data, or both. */
|
|
7351
|
+
timeScope: EvaluationRuleTimeScope[];
|
|
7352
|
+
/** Stored filters used by the legacy trace or dataset rule. */
|
|
7353
|
+
filter: EvaluationRuleFilter[];
|
|
7354
|
+
/** Stored variable mappings, including the trace, dataset item, or named observation selected for each variable. */
|
|
7355
|
+
mapping: LegacyEvaluationRuleMapping[];
|
|
7356
|
+
}
|
|
7357
|
+
|
|
7358
|
+
/**
|
|
7359
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
7360
|
+
*/
|
|
7361
|
+
|
|
7362
|
+
/**
|
|
7363
|
+
* Evaluation rule returned by list and get, including read-only legacy trace and dataset rules.
|
|
7364
|
+
*/
|
|
7365
|
+
type ReadableEvaluationRule = EvaluationRule | LegacyEvaluationRule;
|
|
7366
|
+
|
|
6527
7367
|
/**
|
|
6528
7368
|
* This file was auto-generated by Fern from our API Definition.
|
|
6529
7369
|
*/
|
|
@@ -6533,7 +7373,7 @@ interface EvaluationRule {
|
|
|
6533
7373
|
*/
|
|
6534
7374
|
interface EvaluationRules$1 {
|
|
6535
7375
|
/** Evaluation rules in the current page. */
|
|
6536
|
-
data:
|
|
7376
|
+
data: ReadableEvaluationRule[];
|
|
6537
7377
|
/** Standard pagination metadata. */
|
|
6538
7378
|
meta: MetaResponse;
|
|
6539
7379
|
}
|
|
@@ -6738,6 +7578,63 @@ declare const LlmAsJudgeEvaluatorType: {
|
|
|
6738
7578
|
readonly LlmAsJudge: "llm_as_judge";
|
|
6739
7579
|
};
|
|
6740
7580
|
|
|
7581
|
+
/**
|
|
7582
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
7583
|
+
*/
|
|
7584
|
+
type EvaluationRuleTimeScope = "NEW" | "EXISTING";
|
|
7585
|
+
declare const EvaluationRuleTimeScope: {
|
|
7586
|
+
readonly New: "NEW";
|
|
7587
|
+
readonly Existing: "EXISTING";
|
|
7588
|
+
};
|
|
7589
|
+
|
|
7590
|
+
/**
|
|
7591
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
7592
|
+
*/
|
|
7593
|
+
type LegacyEvaluationRuleTarget = "trace" | "dataset";
|
|
7594
|
+
declare const LegacyEvaluationRuleTarget: {
|
|
7595
|
+
readonly Trace: "trace";
|
|
7596
|
+
readonly Dataset: "dataset";
|
|
7597
|
+
};
|
|
7598
|
+
|
|
7599
|
+
/**
|
|
7600
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
7601
|
+
*/
|
|
7602
|
+
|
|
7603
|
+
/**
|
|
7604
|
+
* Maps one evaluator variable to a trace, dataset item, or field on a named observation in a legacy rule.
|
|
7605
|
+
*/
|
|
7606
|
+
interface LegacyEvaluationRuleMapping {
|
|
7607
|
+
/** Evaluator prompt variable populated by this mapping. */
|
|
7608
|
+
variable: string;
|
|
7609
|
+
/** Trace, dataset item, or observation type from which the value is read. */
|
|
7610
|
+
langfuseObject: LegacyEvaluationObject;
|
|
7611
|
+
/** Observation name to match, or `null` when `langfuseObject` is `trace` or `dataset_item`. */
|
|
7612
|
+
objectName: string | null;
|
|
7613
|
+
/** Stored field selected from the trace, dataset item, or observation. */
|
|
7614
|
+
source: string;
|
|
7615
|
+
/** Optional JSONPath selector applied to the selected field. */
|
|
7616
|
+
jsonPath?: string;
|
|
7617
|
+
}
|
|
7618
|
+
|
|
7619
|
+
/**
|
|
7620
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
7621
|
+
*/
|
|
7622
|
+
type LegacyEvaluationObject = "trace" | "span" | "generation" | "event" | "agent" | "tool" | "chain" | "retriever" | "evaluator" | "embedding" | "guardrail" | "dataset_item";
|
|
7623
|
+
declare const LegacyEvaluationObject: {
|
|
7624
|
+
readonly Trace: "trace";
|
|
7625
|
+
readonly Span: "span";
|
|
7626
|
+
readonly Generation: "generation";
|
|
7627
|
+
readonly Event: "event";
|
|
7628
|
+
readonly Agent: "agent";
|
|
7629
|
+
readonly Tool: "tool";
|
|
7630
|
+
readonly Chain: "chain";
|
|
7631
|
+
readonly Retriever: "retriever";
|
|
7632
|
+
readonly Evaluator: "evaluator";
|
|
7633
|
+
readonly Embedding: "embedding";
|
|
7634
|
+
readonly Guardrail: "guardrail";
|
|
7635
|
+
readonly DatasetItem: "dataset_item";
|
|
7636
|
+
};
|
|
7637
|
+
|
|
6741
7638
|
/**
|
|
6742
7639
|
* This file was auto-generated by Fern from our API Definition.
|
|
6743
7640
|
*/
|
|
@@ -6779,14 +7676,21 @@ type index$5_CreateEvaluationRuleRequest = CreateEvaluationRuleRequest;
|
|
|
6779
7676
|
type index$5_CreateLlmAsJudgeEvaluationRuleRequest = CreateLlmAsJudgeEvaluationRuleRequest;
|
|
6780
7677
|
type index$5_DeleteEvaluationRuleResponse = DeleteEvaluationRuleResponse;
|
|
6781
7678
|
type index$5_EvaluationRule = EvaluationRule;
|
|
7679
|
+
type index$5_EvaluationRuleBase = EvaluationRuleBase;
|
|
6782
7680
|
type index$5_EvaluationRuleEvaluator = EvaluationRuleEvaluator;
|
|
6783
7681
|
type index$5_EvaluationRuleEvaluatorReference = EvaluationRuleEvaluatorReference;
|
|
7682
|
+
declare const index$5_EvaluationRuleTimeScope: typeof EvaluationRuleTimeScope;
|
|
7683
|
+
declare const index$5_LegacyEvaluationObject: typeof LegacyEvaluationObject;
|
|
7684
|
+
type index$5_LegacyEvaluationRule = LegacyEvaluationRule;
|
|
7685
|
+
type index$5_LegacyEvaluationRuleMapping = LegacyEvaluationRuleMapping;
|
|
7686
|
+
declare const index$5_LegacyEvaluationRuleTarget: typeof LegacyEvaluationRuleTarget;
|
|
6784
7687
|
type index$5_ListEvaluationRulesRequest = ListEvaluationRulesRequest;
|
|
6785
7688
|
type index$5_LlmAsJudgeEvaluationRuleEvaluatorReference = LlmAsJudgeEvaluationRuleEvaluatorReference;
|
|
6786
7689
|
declare const index$5_LlmAsJudgeEvaluatorType: typeof LlmAsJudgeEvaluatorType;
|
|
7690
|
+
type index$5_ReadableEvaluationRule = ReadableEvaluationRule;
|
|
6787
7691
|
type index$5_UpdateEvaluationRuleRequest = UpdateEvaluationRuleRequest;
|
|
6788
7692
|
declare namespace index$5 {
|
|
6789
|
-
export { type index$5_CodeEvaluationRuleEvaluatorReference as CodeEvaluationRuleEvaluatorReference, type index$5_CreateCodeEvaluationRuleRequest as CreateCodeEvaluationRuleRequest, type index$5_CreateEvaluationRuleRequest as CreateEvaluationRuleRequest, type index$5_CreateLlmAsJudgeEvaluationRuleRequest as CreateLlmAsJudgeEvaluationRuleRequest, type index$5_DeleteEvaluationRuleResponse as DeleteEvaluationRuleResponse, type index$5_EvaluationRule as EvaluationRule, type index$5_EvaluationRuleEvaluator as EvaluationRuleEvaluator, type index$5_EvaluationRuleEvaluatorReference as EvaluationRuleEvaluatorReference, type EvaluationRules$1 as EvaluationRules, type index$5_ListEvaluationRulesRequest as ListEvaluationRulesRequest, type index$5_LlmAsJudgeEvaluationRuleEvaluatorReference as LlmAsJudgeEvaluationRuleEvaluatorReference, index$5_LlmAsJudgeEvaluatorType as LlmAsJudgeEvaluatorType, type index$5_UpdateEvaluationRuleRequest as UpdateEvaluationRuleRequest };
|
|
7693
|
+
export { type index$5_CodeEvaluationRuleEvaluatorReference as CodeEvaluationRuleEvaluatorReference, type index$5_CreateCodeEvaluationRuleRequest as CreateCodeEvaluationRuleRequest, type index$5_CreateEvaluationRuleRequest as CreateEvaluationRuleRequest, type index$5_CreateLlmAsJudgeEvaluationRuleRequest as CreateLlmAsJudgeEvaluationRuleRequest, type index$5_DeleteEvaluationRuleResponse as DeleteEvaluationRuleResponse, type index$5_EvaluationRule as EvaluationRule, type index$5_EvaluationRuleBase as EvaluationRuleBase, type index$5_EvaluationRuleEvaluator as EvaluationRuleEvaluator, type index$5_EvaluationRuleEvaluatorReference as EvaluationRuleEvaluatorReference, index$5_EvaluationRuleTimeScope as EvaluationRuleTimeScope, type EvaluationRules$1 as EvaluationRules, index$5_LegacyEvaluationObject as LegacyEvaluationObject, type index$5_LegacyEvaluationRule as LegacyEvaluationRule, type index$5_LegacyEvaluationRuleMapping as LegacyEvaluationRuleMapping, index$5_LegacyEvaluationRuleTarget as LegacyEvaluationRuleTarget, type index$5_ListEvaluationRulesRequest as ListEvaluationRulesRequest, type index$5_LlmAsJudgeEvaluationRuleEvaluatorReference as LlmAsJudgeEvaluationRuleEvaluatorReference, index$5_LlmAsJudgeEvaluatorType as LlmAsJudgeEvaluatorType, type index$5_ReadableEvaluationRule as ReadableEvaluationRule, type index$5_UpdateEvaluationRuleRequest as UpdateEvaluationRuleRequest };
|
|
6790
7694
|
}
|
|
6791
7695
|
|
|
6792
7696
|
/**
|
|
@@ -6990,15 +7894,41 @@ type index$3_ConflictError = ConflictError;
|
|
|
6990
7894
|
declare const index$3_ConflictError: typeof ConflictError;
|
|
6991
7895
|
type index$3_CreateCodeEvaluationRuleRequest = CreateCodeEvaluationRuleRequest;
|
|
6992
7896
|
type index$3_CreateCodeEvaluatorRequest = CreateCodeEvaluatorRequest;
|
|
7897
|
+
declare const index$3_CreateDashboardPlacementRequest: typeof CreateDashboardPlacementRequest;
|
|
7898
|
+
type index$3_CreateDashboardRequest = CreateDashboardRequest;
|
|
7899
|
+
type index$3_CreateDashboardWidgetRequest = CreateDashboardWidgetRequest;
|
|
6993
7900
|
type index$3_CreateEvaluationRuleRequest = CreateEvaluationRuleRequest;
|
|
6994
7901
|
declare const index$3_CreateEvaluatorRequest: typeof CreateEvaluatorRequest;
|
|
6995
7902
|
type index$3_CreateLlmAsJudgeEvaluationRuleRequest = CreateLlmAsJudgeEvaluationRuleRequest;
|
|
6996
7903
|
type index$3_CreateLlmAsJudgeEvaluatorRequest = CreateLlmAsJudgeEvaluatorRequest;
|
|
7904
|
+
type index$3_CreatePresetPlacement = CreatePresetPlacement;
|
|
7905
|
+
type index$3_CreateWidgetPlacement = CreateWidgetPlacement;
|
|
7906
|
+
type index$3_Dashboard = Dashboard;
|
|
7907
|
+
type index$3_DashboardDefinition = DashboardDefinition;
|
|
7908
|
+
type index$3_DashboardList = DashboardList;
|
|
7909
|
+
declare const index$3_DashboardPlacement: typeof DashboardPlacement;
|
|
7910
|
+
type index$3_DashboardWidget = DashboardWidget;
|
|
7911
|
+
type index$3_DashboardWidgetChartConfig = DashboardWidgetChartConfig;
|
|
7912
|
+
type index$3_DashboardWidgetChartConfigInput = DashboardWidgetChartConfigInput;
|
|
7913
|
+
declare const index$3_DashboardWidgetChartType: typeof DashboardWidgetChartType;
|
|
7914
|
+
type index$3_DashboardWidgetDefaultSort = DashboardWidgetDefaultSort;
|
|
7915
|
+
type index$3_DashboardWidgetDimension = DashboardWidgetDimension;
|
|
7916
|
+
type index$3_DashboardWidgetFilter = DashboardWidgetFilter;
|
|
7917
|
+
type index$3_DashboardWidgetList = DashboardWidgetList;
|
|
7918
|
+
type index$3_DashboardWidgetMetric = DashboardWidgetMetric;
|
|
7919
|
+
declare const index$3_DashboardWidgetMetricAggregation: typeof DashboardWidgetMetricAggregation;
|
|
7920
|
+
declare const index$3_DashboardWidgetSortOrder: typeof DashboardWidgetSortOrder;
|
|
7921
|
+
declare const index$3_DashboardWidgetView: typeof DashboardWidgetView;
|
|
7922
|
+
declare const index$3_DashboardWidgetViewWithLegacy: typeof DashboardWidgetViewWithLegacy;
|
|
6997
7923
|
type index$3_DateTimeEvaluationRuleFilter = DateTimeEvaluationRuleFilter;
|
|
7924
|
+
type index$3_DeleteDashboardPlacementResponse = DeleteDashboardPlacementResponse;
|
|
7925
|
+
type index$3_DeleteDashboardResponse = DeleteDashboardResponse;
|
|
7926
|
+
type index$3_DeleteDashboardWidgetResponse = DeleteDashboardWidgetResponse;
|
|
6998
7927
|
type index$3_DeleteEvaluationRuleResponse = DeleteEvaluationRuleResponse;
|
|
6999
7928
|
type index$3_DeleteEvaluatorResponse = DeleteEvaluatorResponse;
|
|
7000
7929
|
type index$3_EvaluationRule = EvaluationRule;
|
|
7001
7930
|
declare const index$3_EvaluationRuleArrayOptionsFilterOperator: typeof EvaluationRuleArrayOptionsFilterOperator;
|
|
7931
|
+
type index$3_EvaluationRuleBase = EvaluationRuleBase;
|
|
7002
7932
|
declare const index$3_EvaluationRuleBooleanFilterOperator: typeof EvaluationRuleBooleanFilterOperator;
|
|
7003
7933
|
type index$3_EvaluationRuleEvaluator = EvaluationRuleEvaluator;
|
|
7004
7934
|
type index$3_EvaluationRuleEvaluatorReference = EvaluationRuleEvaluatorReference;
|
|
@@ -7011,6 +7941,7 @@ declare const index$3_EvaluationRuleOptionsFilterOperator: typeof EvaluationRule
|
|
|
7011
7941
|
declare const index$3_EvaluationRuleStatus: typeof EvaluationRuleStatus;
|
|
7012
7942
|
declare const index$3_EvaluationRuleStringFilterOperator: typeof EvaluationRuleStringFilterOperator;
|
|
7013
7943
|
declare const index$3_EvaluationRuleTarget: typeof EvaluationRuleTarget;
|
|
7944
|
+
declare const index$3_EvaluationRuleTimeScope: typeof EvaluationRuleTimeScope;
|
|
7014
7945
|
declare const index$3_Evaluator: typeof Evaluator;
|
|
7015
7946
|
type index$3_EvaluatorBase = EvaluatorBase;
|
|
7016
7947
|
type index$3_EvaluatorModelConfig = EvaluatorModelConfig;
|
|
@@ -7021,6 +7952,12 @@ declare const index$3_EvaluatorScope: typeof EvaluatorScope;
|
|
|
7021
7952
|
declare const index$3_EvaluatorType: typeof EvaluatorType;
|
|
7022
7953
|
type index$3_InternalServerError = InternalServerError;
|
|
7023
7954
|
declare const index$3_InternalServerError: typeof InternalServerError;
|
|
7955
|
+
declare const index$3_LegacyEvaluationObject: typeof LegacyEvaluationObject;
|
|
7956
|
+
type index$3_LegacyEvaluationRule = LegacyEvaluationRule;
|
|
7957
|
+
type index$3_LegacyEvaluationRuleMapping = LegacyEvaluationRuleMapping;
|
|
7958
|
+
declare const index$3_LegacyEvaluationRuleTarget: typeof LegacyEvaluationRuleTarget;
|
|
7959
|
+
type index$3_ListDashboardWidgetsRequest = ListDashboardWidgetsRequest;
|
|
7960
|
+
type index$3_ListDashboardsRequest = ListDashboardsRequest;
|
|
7024
7961
|
type index$3_ListEvaluationRulesRequest = ListEvaluationRulesRequest;
|
|
7025
7962
|
type index$3_ListEvaluatorsRequest = ListEvaluatorsRequest;
|
|
7026
7963
|
type index$3_LlmAsJudgeEvaluationRuleEvaluatorReference = LlmAsJudgeEvaluationRuleEvaluatorReference;
|
|
@@ -7033,6 +7970,7 @@ declare const index$3_NotFoundError: typeof NotFoundError;
|
|
|
7033
7970
|
type index$3_NullEvaluationRuleFilter = NullEvaluationRuleFilter;
|
|
7034
7971
|
type index$3_NumberEvaluationRuleFilter = NumberEvaluationRuleFilter;
|
|
7035
7972
|
type index$3_NumberObjectEvaluationRuleFilter = NumberObjectEvaluationRuleFilter;
|
|
7973
|
+
type index$3_PresetPlacement = PresetPlacement;
|
|
7036
7974
|
type index$3_PublicApiError = PublicApiError;
|
|
7037
7975
|
declare const index$3_PublicApiErrorCode: typeof PublicApiErrorCode;
|
|
7038
7976
|
type index$3_PublicApiErrorDetails = PublicApiErrorDetails;
|
|
@@ -7042,6 +7980,7 @@ type index$3_PublicCategoricalEvaluatorOutputDefinition = PublicCategoricalEvalu
|
|
|
7042
7980
|
type index$3_PublicCategoricalEvaluatorOutputScoreDefinition = PublicCategoricalEvaluatorOutputScoreDefinition;
|
|
7043
7981
|
declare const index$3_PublicEvaluatorOutputDefinition: typeof PublicEvaluatorOutputDefinition;
|
|
7044
7982
|
type index$3_PublicNumericEvaluatorOutputDefinition = PublicNumericEvaluatorOutputDefinition;
|
|
7983
|
+
type index$3_ReadableEvaluationRule = ReadableEvaluationRule;
|
|
7045
7984
|
type index$3_StringEvaluationRuleFilter = StringEvaluationRuleFilter;
|
|
7046
7985
|
type index$3_StringObjectEvaluationRuleFilter = StringObjectEvaluationRuleFilter;
|
|
7047
7986
|
type index$3_StringOptionsEvaluationRuleFilter = StringOptionsEvaluationRuleFilter;
|
|
@@ -7051,9 +7990,13 @@ type index$3_UnauthorizedError = UnauthorizedError;
|
|
|
7051
7990
|
declare const index$3_UnauthorizedError: typeof UnauthorizedError;
|
|
7052
7991
|
type index$3_UnprocessableContentError = UnprocessableContentError;
|
|
7053
7992
|
declare const index$3_UnprocessableContentError: typeof UnprocessableContentError;
|
|
7993
|
+
type index$3_UpdateDashboardPlacementRequest = UpdateDashboardPlacementRequest;
|
|
7994
|
+
type index$3_UpdateDashboardRequest = UpdateDashboardRequest;
|
|
7995
|
+
type index$3_UpdateDashboardWidgetRequest = UpdateDashboardWidgetRequest;
|
|
7054
7996
|
type index$3_UpdateEvaluationRuleRequest = UpdateEvaluationRuleRequest;
|
|
7997
|
+
type index$3_WidgetPlacement = WidgetPlacement;
|
|
7055
7998
|
declare namespace index$3 {
|
|
7056
|
-
export { index$3_AccessDeniedError as AccessDeniedError, type index$3_ArrayOptionsEvaluationRuleFilter as ArrayOptionsEvaluationRuleFilter, index$3_BadRequestError as BadRequestError, type index$3_BooleanEvaluationRuleFilter as BooleanEvaluationRuleFilter, type index$3_CategoryOptionsEvaluationRuleFilter as CategoryOptionsEvaluationRuleFilter, type index$3_CodeEvaluationRuleEvaluatorReference as CodeEvaluationRuleEvaluatorReference, type index$3_CodeEvaluator as CodeEvaluator, index$3_CodeEvaluatorSourceCodeLanguage as CodeEvaluatorSourceCodeLanguage, index$3_ConflictError as ConflictError, type index$3_CreateCodeEvaluationRuleRequest as CreateCodeEvaluationRuleRequest, type index$3_CreateCodeEvaluatorRequest as CreateCodeEvaluatorRequest, type index$3_CreateEvaluationRuleRequest as CreateEvaluationRuleRequest, index$3_CreateEvaluatorRequest as CreateEvaluatorRequest, type index$3_CreateLlmAsJudgeEvaluationRuleRequest as CreateLlmAsJudgeEvaluationRuleRequest, type index$3_CreateLlmAsJudgeEvaluatorRequest as CreateLlmAsJudgeEvaluatorRequest, type index$3_DateTimeEvaluationRuleFilter as DateTimeEvaluationRuleFilter, type index$3_DeleteEvaluationRuleResponse as DeleteEvaluationRuleResponse, type index$3_DeleteEvaluatorResponse as DeleteEvaluatorResponse, type index$3_EvaluationRule as EvaluationRule, index$3_EvaluationRuleArrayOptionsFilterOperator as EvaluationRuleArrayOptionsFilterOperator, index$3_EvaluationRuleBooleanFilterOperator as EvaluationRuleBooleanFilterOperator, type index$3_EvaluationRuleEvaluator as EvaluationRuleEvaluator, type index$3_EvaluationRuleEvaluatorReference as EvaluationRuleEvaluatorReference, index$3_EvaluationRuleFilter as EvaluationRuleFilter, type index$3_EvaluationRuleMapping as EvaluationRuleMapping, index$3_EvaluationRuleMappingSource as EvaluationRuleMappingSource, index$3_EvaluationRuleNullFilterOperator as EvaluationRuleNullFilterOperator, index$3_EvaluationRuleNumberFilterOperator as EvaluationRuleNumberFilterOperator, index$3_EvaluationRuleOptionsFilterOperator as EvaluationRuleOptionsFilterOperator, index$3_EvaluationRuleStatus as EvaluationRuleStatus, index$3_EvaluationRuleStringFilterOperator as EvaluationRuleStringFilterOperator, index$3_EvaluationRuleTarget as EvaluationRuleTarget, type EvaluationRules$1 as EvaluationRules, index$3_Evaluator as Evaluator, type index$3_EvaluatorBase as EvaluatorBase, type index$3_EvaluatorModelConfig as EvaluatorModelConfig, index$3_EvaluatorOutputDataType as EvaluatorOutputDataType, index$3_EvaluatorOutputDefinition as EvaluatorOutputDefinition, type index$3_EvaluatorOutputFieldDefinition as EvaluatorOutputFieldDefinition, index$3_EvaluatorScope as EvaluatorScope, index$3_EvaluatorType as EvaluatorType, type Evaluators$1 as Evaluators, index$3_InternalServerError as InternalServerError, type index$3_ListEvaluationRulesRequest as ListEvaluationRulesRequest, type index$3_ListEvaluatorsRequest as ListEvaluatorsRequest, type index$3_LlmAsJudgeEvaluationRuleEvaluatorReference as LlmAsJudgeEvaluationRuleEvaluatorReference, type index$3_LlmAsJudgeEvaluator as LlmAsJudgeEvaluator, index$3_LlmAsJudgeEvaluatorType as LlmAsJudgeEvaluatorType, index$3_MethodNotAllowedError as MethodNotAllowedError, index$3_NotFoundError as NotFoundError, type index$3_NullEvaluationRuleFilter as NullEvaluationRuleFilter, type index$3_NumberEvaluationRuleFilter as NumberEvaluationRuleFilter, type index$3_NumberObjectEvaluationRuleFilter as NumberObjectEvaluationRuleFilter, type index$3_PublicApiError as PublicApiError, index$3_PublicApiErrorCode as PublicApiErrorCode, type index$3_PublicApiErrorDetails as PublicApiErrorDetails, type index$3_PublicApiValidationIssue as PublicApiValidationIssue, type index$3_PublicBooleanEvaluatorOutputDefinition as PublicBooleanEvaluatorOutputDefinition, type index$3_PublicCategoricalEvaluatorOutputDefinition as PublicCategoricalEvaluatorOutputDefinition, type index$3_PublicCategoricalEvaluatorOutputScoreDefinition as PublicCategoricalEvaluatorOutputScoreDefinition, index$3_PublicEvaluatorOutputDefinition as PublicEvaluatorOutputDefinition, type index$3_PublicNumericEvaluatorOutputDefinition as PublicNumericEvaluatorOutputDefinition, type index$3_StringEvaluationRuleFilter as StringEvaluationRuleFilter, type index$3_StringObjectEvaluationRuleFilter as StringObjectEvaluationRuleFilter, type index$3_StringOptionsEvaluationRuleFilter as StringOptionsEvaluationRuleFilter, index$3_TooManyRequestsError as TooManyRequestsError, index$3_UnauthorizedError as UnauthorizedError, index$3_UnprocessableContentError as UnprocessableContentError, type index$3_UpdateEvaluationRuleRequest as UpdateEvaluationRuleRequest, index$
|
|
7999
|
+
export { index$3_AccessDeniedError as AccessDeniedError, type index$3_ArrayOptionsEvaluationRuleFilter as ArrayOptionsEvaluationRuleFilter, index$3_BadRequestError as BadRequestError, type index$3_BooleanEvaluationRuleFilter as BooleanEvaluationRuleFilter, type index$3_CategoryOptionsEvaluationRuleFilter as CategoryOptionsEvaluationRuleFilter, type index$3_CodeEvaluationRuleEvaluatorReference as CodeEvaluationRuleEvaluatorReference, type index$3_CodeEvaluator as CodeEvaluator, index$3_CodeEvaluatorSourceCodeLanguage as CodeEvaluatorSourceCodeLanguage, index$3_ConflictError as ConflictError, type index$3_CreateCodeEvaluationRuleRequest as CreateCodeEvaluationRuleRequest, type index$3_CreateCodeEvaluatorRequest as CreateCodeEvaluatorRequest, index$3_CreateDashboardPlacementRequest as CreateDashboardPlacementRequest, type index$3_CreateDashboardRequest as CreateDashboardRequest, type index$3_CreateDashboardWidgetRequest as CreateDashboardWidgetRequest, type index$3_CreateEvaluationRuleRequest as CreateEvaluationRuleRequest, index$3_CreateEvaluatorRequest as CreateEvaluatorRequest, type index$3_CreateLlmAsJudgeEvaluationRuleRequest as CreateLlmAsJudgeEvaluationRuleRequest, type index$3_CreateLlmAsJudgeEvaluatorRequest as CreateLlmAsJudgeEvaluatorRequest, type index$3_CreatePresetPlacement as CreatePresetPlacement, type index$3_CreateWidgetPlacement as CreateWidgetPlacement, type index$3_Dashboard as Dashboard, type index$3_DashboardDefinition as DashboardDefinition, type index$3_DashboardList as DashboardList, index$3_DashboardPlacement as DashboardPlacement, type index$3_DashboardWidget as DashboardWidget, type index$3_DashboardWidgetChartConfig as DashboardWidgetChartConfig, type index$3_DashboardWidgetChartConfigInput as DashboardWidgetChartConfigInput, index$3_DashboardWidgetChartType as DashboardWidgetChartType, type index$3_DashboardWidgetDefaultSort as DashboardWidgetDefaultSort, type index$3_DashboardWidgetDimension as DashboardWidgetDimension, type index$3_DashboardWidgetFilter as DashboardWidgetFilter, type index$3_DashboardWidgetList as DashboardWidgetList, type index$3_DashboardWidgetMetric as DashboardWidgetMetric, index$3_DashboardWidgetMetricAggregation as DashboardWidgetMetricAggregation, index$3_DashboardWidgetSortOrder as DashboardWidgetSortOrder, index$3_DashboardWidgetView as DashboardWidgetView, index$3_DashboardWidgetViewWithLegacy as DashboardWidgetViewWithLegacy, type index$3_DateTimeEvaluationRuleFilter as DateTimeEvaluationRuleFilter, type index$3_DeleteDashboardPlacementResponse as DeleteDashboardPlacementResponse, type index$3_DeleteDashboardResponse as DeleteDashboardResponse, type index$3_DeleteDashboardWidgetResponse as DeleteDashboardWidgetResponse, type index$3_DeleteEvaluationRuleResponse as DeleteEvaluationRuleResponse, type index$3_DeleteEvaluatorResponse as DeleteEvaluatorResponse, type index$3_EvaluationRule as EvaluationRule, index$3_EvaluationRuleArrayOptionsFilterOperator as EvaluationRuleArrayOptionsFilterOperator, type index$3_EvaluationRuleBase as EvaluationRuleBase, index$3_EvaluationRuleBooleanFilterOperator as EvaluationRuleBooleanFilterOperator, type index$3_EvaluationRuleEvaluator as EvaluationRuleEvaluator, type index$3_EvaluationRuleEvaluatorReference as EvaluationRuleEvaluatorReference, index$3_EvaluationRuleFilter as EvaluationRuleFilter, type index$3_EvaluationRuleMapping as EvaluationRuleMapping, index$3_EvaluationRuleMappingSource as EvaluationRuleMappingSource, index$3_EvaluationRuleNullFilterOperator as EvaluationRuleNullFilterOperator, index$3_EvaluationRuleNumberFilterOperator as EvaluationRuleNumberFilterOperator, index$3_EvaluationRuleOptionsFilterOperator as EvaluationRuleOptionsFilterOperator, index$3_EvaluationRuleStatus as EvaluationRuleStatus, index$3_EvaluationRuleStringFilterOperator as EvaluationRuleStringFilterOperator, index$3_EvaluationRuleTarget as EvaluationRuleTarget, index$3_EvaluationRuleTimeScope as EvaluationRuleTimeScope, type EvaluationRules$1 as EvaluationRules, index$3_Evaluator as Evaluator, type index$3_EvaluatorBase as EvaluatorBase, type index$3_EvaluatorModelConfig as EvaluatorModelConfig, index$3_EvaluatorOutputDataType as EvaluatorOutputDataType, index$3_EvaluatorOutputDefinition as EvaluatorOutputDefinition, type index$3_EvaluatorOutputFieldDefinition as EvaluatorOutputFieldDefinition, index$3_EvaluatorScope as EvaluatorScope, index$3_EvaluatorType as EvaluatorType, type Evaluators$1 as Evaluators, index$3_InternalServerError as InternalServerError, index$3_LegacyEvaluationObject as LegacyEvaluationObject, type index$3_LegacyEvaluationRule as LegacyEvaluationRule, type index$3_LegacyEvaluationRuleMapping as LegacyEvaluationRuleMapping, index$3_LegacyEvaluationRuleTarget as LegacyEvaluationRuleTarget, type index$3_ListDashboardWidgetsRequest as ListDashboardWidgetsRequest, type index$3_ListDashboardsRequest as ListDashboardsRequest, type index$3_ListEvaluationRulesRequest as ListEvaluationRulesRequest, type index$3_ListEvaluatorsRequest as ListEvaluatorsRequest, type index$3_LlmAsJudgeEvaluationRuleEvaluatorReference as LlmAsJudgeEvaluationRuleEvaluatorReference, type index$3_LlmAsJudgeEvaluator as LlmAsJudgeEvaluator, index$3_LlmAsJudgeEvaluatorType as LlmAsJudgeEvaluatorType, index$3_MethodNotAllowedError as MethodNotAllowedError, index$3_NotFoundError as NotFoundError, type index$3_NullEvaluationRuleFilter as NullEvaluationRuleFilter, type index$3_NumberEvaluationRuleFilter as NumberEvaluationRuleFilter, type index$3_NumberObjectEvaluationRuleFilter as NumberObjectEvaluationRuleFilter, type index$3_PresetPlacement as PresetPlacement, type index$3_PublicApiError as PublicApiError, index$3_PublicApiErrorCode as PublicApiErrorCode, type index$3_PublicApiErrorDetails as PublicApiErrorDetails, type index$3_PublicApiValidationIssue as PublicApiValidationIssue, type index$3_PublicBooleanEvaluatorOutputDefinition as PublicBooleanEvaluatorOutputDefinition, type index$3_PublicCategoricalEvaluatorOutputDefinition as PublicCategoricalEvaluatorOutputDefinition, type index$3_PublicCategoricalEvaluatorOutputScoreDefinition as PublicCategoricalEvaluatorOutputScoreDefinition, index$3_PublicEvaluatorOutputDefinition as PublicEvaluatorOutputDefinition, type index$3_PublicNumericEvaluatorOutputDefinition as PublicNumericEvaluatorOutputDefinition, type index$3_ReadableEvaluationRule as ReadableEvaluationRule, type index$3_StringEvaluationRuleFilter as StringEvaluationRuleFilter, type index$3_StringObjectEvaluationRuleFilter as StringObjectEvaluationRuleFilter, type index$3_StringOptionsEvaluationRuleFilter as StringOptionsEvaluationRuleFilter, index$3_TooManyRequestsError as TooManyRequestsError, index$3_UnauthorizedError as UnauthorizedError, index$3_UnprocessableContentError as UnprocessableContentError, type index$3_UpdateDashboardPlacementRequest as UpdateDashboardPlacementRequest, type index$3_UpdateDashboardRequest as UpdateDashboardRequest, type index$3_UpdateDashboardWidgetRequest as UpdateDashboardWidgetRequest, type index$3_UpdateEvaluationRuleRequest as UpdateEvaluationRuleRequest, type index$3_WidgetPlacement as WidgetPlacement, index$9 as commons, index$8 as dashboardWidgets, index$7 as dashboards, index$6 as errors, index$5 as evaluationRules, index$4 as evaluators };
|
|
7057
8000
|
}
|
|
7058
8001
|
|
|
7059
8002
|
/**
|
|
@@ -7938,6 +8881,162 @@ declare class Datasets {
|
|
|
7938
8881
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
7939
8882
|
}
|
|
7940
8883
|
|
|
8884
|
+
/**
|
|
8885
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
8886
|
+
*/
|
|
8887
|
+
|
|
8888
|
+
declare namespace Experiments {
|
|
8889
|
+
interface Options {
|
|
8890
|
+
environment: Supplier<string>;
|
|
8891
|
+
/** Specify a custom URL to connect the client to. */
|
|
8892
|
+
baseUrl?: Supplier<string>;
|
|
8893
|
+
username?: Supplier<string | undefined>;
|
|
8894
|
+
password?: Supplier<string | undefined>;
|
|
8895
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
8896
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
8897
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
8898
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
8899
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
8900
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
8901
|
+
/** Additional headers to include in requests. */
|
|
8902
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
8903
|
+
}
|
|
8904
|
+
interface RequestOptions {
|
|
8905
|
+
/** The maximum time to wait for a response in seconds. */
|
|
8906
|
+
timeoutInSeconds?: number;
|
|
8907
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
8908
|
+
maxRetries?: number;
|
|
8909
|
+
/** A hook to abort the request. */
|
|
8910
|
+
abortSignal?: AbortSignal;
|
|
8911
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
8912
|
+
xLangfuseSdkName?: string | undefined;
|
|
8913
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
8914
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
8915
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
8916
|
+
xLangfusePublicKey?: string | undefined;
|
|
8917
|
+
/** Additional query string parameters to include in the request. */
|
|
8918
|
+
queryParams?: Record<string, unknown>;
|
|
8919
|
+
/** Additional headers to include in the request. */
|
|
8920
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
8921
|
+
}
|
|
8922
|
+
}
|
|
8923
|
+
declare class Experiments {
|
|
8924
|
+
protected readonly _options: Experiments.Options;
|
|
8925
|
+
constructor(_options: Experiments.Options);
|
|
8926
|
+
/**
|
|
8927
|
+
* List experiments with cursor-based pagination. Results are ordered by
|
|
8928
|
+
* latest experiment activity descending.
|
|
8929
|
+
*
|
|
8930
|
+
* @param {LangfuseAPI.ListExperimentsRequest} request
|
|
8931
|
+
* @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
|
|
8932
|
+
*
|
|
8933
|
+
* @throws {@link LangfuseAPI.Error}
|
|
8934
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
8935
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
8936
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
8937
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
8938
|
+
*
|
|
8939
|
+
* @example
|
|
8940
|
+
* await client.experiments.list({
|
|
8941
|
+
* fromStartTime: "2024-01-15T09:30:00Z"
|
|
8942
|
+
* })
|
|
8943
|
+
*/
|
|
8944
|
+
list(request: ListExperimentsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentsResponse>;
|
|
8945
|
+
private __list;
|
|
8946
|
+
/**
|
|
8947
|
+
* List experiment items with cursor-based pagination. Use this endpoint
|
|
8948
|
+
* to export experiment item inputs, outputs, expected outputs, metadata,
|
|
8949
|
+
* and optionally item/trace scores. Results are ordered by time
|
|
8950
|
+
* descending.
|
|
8951
|
+
*
|
|
8952
|
+
* @param {LangfuseAPI.ListExperimentItemsRequest} request
|
|
8953
|
+
* @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
|
|
8954
|
+
*
|
|
8955
|
+
* @throws {@link LangfuseAPI.Error}
|
|
8956
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
8957
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
8958
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
8959
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
8960
|
+
*
|
|
8961
|
+
* @example
|
|
8962
|
+
* await client.experiments.listItems({
|
|
8963
|
+
* fromStartTime: "2024-01-15T09:30:00Z"
|
|
8964
|
+
* })
|
|
8965
|
+
*/
|
|
8966
|
+
listItems(request: ListExperimentItemsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentItemsResponse>;
|
|
8967
|
+
private __listItems;
|
|
8968
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
8969
|
+
}
|
|
8970
|
+
|
|
8971
|
+
/**
|
|
8972
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
8973
|
+
*/
|
|
8974
|
+
|
|
8975
|
+
declare namespace Feedback {
|
|
8976
|
+
interface Options {
|
|
8977
|
+
environment: Supplier<string>;
|
|
8978
|
+
/** Specify a custom URL to connect the client to. */
|
|
8979
|
+
baseUrl?: Supplier<string>;
|
|
8980
|
+
username?: Supplier<string | undefined>;
|
|
8981
|
+
password?: Supplier<string | undefined>;
|
|
8982
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
8983
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
8984
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
8985
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
8986
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
8987
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
8988
|
+
/** Additional headers to include in requests. */
|
|
8989
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
8990
|
+
}
|
|
8991
|
+
interface RequestOptions {
|
|
8992
|
+
/** The maximum time to wait for a response in seconds. */
|
|
8993
|
+
timeoutInSeconds?: number;
|
|
8994
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
8995
|
+
maxRetries?: number;
|
|
8996
|
+
/** A hook to abort the request. */
|
|
8997
|
+
abortSignal?: AbortSignal;
|
|
8998
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
8999
|
+
xLangfuseSdkName?: string | undefined;
|
|
9000
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
9001
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
9002
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
9003
|
+
xLangfusePublicKey?: string | undefined;
|
|
9004
|
+
/** Additional query string parameters to include in the request. */
|
|
9005
|
+
queryParams?: Record<string, unknown>;
|
|
9006
|
+
/** Additional headers to include in the request. */
|
|
9007
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
9008
|
+
}
|
|
9009
|
+
}
|
|
9010
|
+
declare class Feedback {
|
|
9011
|
+
protected readonly _options: Feedback.Options;
|
|
9012
|
+
constructor(_options: Feedback.Options);
|
|
9013
|
+
/**
|
|
9014
|
+
* Submit explicit user-approved feedback about Langfuse skills, MCP tools, CLI, docs, or public API. Do not include secrets, credentials, customer data, trace payloads, or unrelated use-case details.
|
|
9015
|
+
*
|
|
9016
|
+
* @param {LangfuseAPI.SubmitFeedbackRequest} request
|
|
9017
|
+
* @param {Feedback.RequestOptions} requestOptions - Request-specific configuration.
|
|
9018
|
+
*
|
|
9019
|
+
* @throws {@link LangfuseAPI.FeedbackNotConfiguredError}
|
|
9020
|
+
* @throws {@link LangfuseAPI.Error}
|
|
9021
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
9022
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
9023
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
9024
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
9025
|
+
*
|
|
9026
|
+
* @example
|
|
9027
|
+
* await client.feedback.submit({
|
|
9028
|
+
* targetType: "skill",
|
|
9029
|
+
* target: "target",
|
|
9030
|
+
* feedback: "feedback",
|
|
9031
|
+
* goal: undefined,
|
|
9032
|
+
* referenceUrl: undefined
|
|
9033
|
+
* })
|
|
9034
|
+
*/
|
|
9035
|
+
submit(request: SubmitFeedbackRequest, requestOptions?: Feedback.RequestOptions): HttpResponsePromise<SubmitFeedbackResponse>;
|
|
9036
|
+
private __submit;
|
|
9037
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
9038
|
+
}
|
|
9039
|
+
|
|
7941
9040
|
/**
|
|
7942
9041
|
* This file was auto-generated by Fern from our API Definition.
|
|
7943
9042
|
*/
|
|
@@ -8253,7 +9352,7 @@ declare class ObservationsV1 {
|
|
|
8253
9352
|
* @example
|
|
8254
9353
|
* await client.legacy.observationsV1.get("observationId")
|
|
8255
9354
|
*/
|
|
8256
|
-
get(observationId: string, requestOptions?: ObservationsV1.RequestOptions): HttpResponsePromise<
|
|
9355
|
+
get(observationId: string, requestOptions?: ObservationsV1.RequestOptions): HttpResponsePromise<ObservationsViewSingle>;
|
|
8257
9356
|
private __get;
|
|
8258
9357
|
/**
|
|
8259
9358
|
* Get a list of observations.
|
|
@@ -8322,7 +9421,14 @@ declare class ScoreV1 {
|
|
|
8322
9421
|
/**
|
|
8323
9422
|
* Create a score (supports both trace and session scores)
|
|
8324
9423
|
*
|
|
8325
|
-
* @
|
|
9424
|
+
* @deprecated Use `client.scores.create()` instead.
|
|
9425
|
+
* Compatibility alias managed by scripts/patch-generated-score-create-alias.mjs
|
|
9426
|
+
*/
|
|
9427
|
+
create(request: CreateScoreRequest, requestOptions?: ScoreV1.RequestOptions): HttpResponsePromise<CreateScoreResponse>;
|
|
9428
|
+
/**
|
|
9429
|
+
* Delete a score (supports both trace and session scores)
|
|
9430
|
+
*
|
|
9431
|
+
* @param {string} scoreId - The unique langfuse identifier of a score
|
|
8326
9432
|
* @param {ScoreV1.RequestOptions} requestOptions - Request-specific configuration.
|
|
8327
9433
|
*
|
|
8328
9434
|
* @throws {@link LangfuseAPI.Error}
|
|
@@ -8332,39 +9438,7 @@ declare class ScoreV1 {
|
|
|
8332
9438
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
8333
9439
|
*
|
|
8334
9440
|
* @example
|
|
8335
|
-
* await client.legacy.scoreV1.
|
|
8336
|
-
* id: undefined,
|
|
8337
|
-
* traceId: undefined,
|
|
8338
|
-
* sessionId: undefined,
|
|
8339
|
-
* observationId: undefined,
|
|
8340
|
-
* datasetRunId: undefined,
|
|
8341
|
-
* name: "name",
|
|
8342
|
-
* value: 1.1,
|
|
8343
|
-
* comment: undefined,
|
|
8344
|
-
* metadata: undefined,
|
|
8345
|
-
* environment: undefined,
|
|
8346
|
-
* queueId: undefined,
|
|
8347
|
-
* dataType: undefined,
|
|
8348
|
-
* configId: undefined,
|
|
8349
|
-
* source: undefined
|
|
8350
|
-
* })
|
|
8351
|
-
*/
|
|
8352
|
-
create(request: CreateScoreRequest, requestOptions?: ScoreV1.RequestOptions): HttpResponsePromise<CreateScoreResponse>;
|
|
8353
|
-
private __create;
|
|
8354
|
-
/**
|
|
8355
|
-
* Delete a score (supports both trace and session scores)
|
|
8356
|
-
*
|
|
8357
|
-
* @param {string} scoreId - The unique langfuse identifier of a score
|
|
8358
|
-
* @param {ScoreV1.RequestOptions} requestOptions - Request-specific configuration.
|
|
8359
|
-
*
|
|
8360
|
-
* @throws {@link LangfuseAPI.Error}
|
|
8361
|
-
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
8362
|
-
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
8363
|
-
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
8364
|
-
* @throws {@link LangfuseAPI.NotFoundError}
|
|
8365
|
-
*
|
|
8366
|
-
* @example
|
|
8367
|
-
* await client.legacy.scoreV1.delete("scoreId")
|
|
9441
|
+
* await client.legacy.scoreV1.delete("scoreId")
|
|
8368
9442
|
*/
|
|
8369
9443
|
delete(scoreId: string, requestOptions?: ScoreV1.RequestOptions): HttpResponsePromise<void>;
|
|
8370
9444
|
private __delete;
|
|
@@ -8665,7 +9739,7 @@ declare class Metrics {
|
|
|
8665
9739
|
* Get metrics from the Langfuse project using a query object. V2 endpoint with optimized performance.
|
|
8666
9740
|
*
|
|
8667
9741
|
* ## V2 Differences
|
|
8668
|
-
* - Supports `observations`, `scores-numeric`, and `scores-categorical` views only (traces view not supported)
|
|
9742
|
+
* - Supports `observations`, `scores-numeric`, `scores-boolean`, and `scores-categorical` views only (traces view not supported)
|
|
8669
9743
|
* - Direct access to tags and release fields on observations
|
|
8670
9744
|
* - Backwards-compatible: traceName, traceRelease, traceVersion dimensions are still available on observations view
|
|
8671
9745
|
* - High cardinality dimensions are not supported and will return a 400 error (see below)
|
|
@@ -8733,6 +9807,16 @@ declare class Metrics {
|
|
|
8733
9807
|
* - `count` - Total number of scores
|
|
8734
9808
|
* - `value` - Score value (for aggregations)
|
|
8735
9809
|
*
|
|
9810
|
+
* ### scores-boolean
|
|
9811
|
+
* Query boolean score data. It has the same score and parent trace/observation dimensions as scores-numeric, plus:
|
|
9812
|
+
*
|
|
9813
|
+
* **Dimensions:**
|
|
9814
|
+
* - `booleanValue` - Boolean value for true/false grouping and filtering
|
|
9815
|
+
*
|
|
9816
|
+
* **Measures:**
|
|
9817
|
+
* - `count` - Total number of boolean scores
|
|
9818
|
+
* - `value` - Numeric 0/1 score value; `avg` returns the true-rate
|
|
9819
|
+
*
|
|
8736
9820
|
* ### scores-categorical
|
|
8737
9821
|
* Query categorical score data. Same dimensions as scores-numeric except uses `stringValue` instead of `value`.
|
|
8738
9822
|
*
|
|
@@ -8750,7 +9834,7 @@ declare class Metrics {
|
|
|
8750
9834
|
* - `sessionId` - Use sessionId filter instead
|
|
8751
9835
|
* - `parentObservationId` - Use parentObservationId filter instead
|
|
8752
9836
|
*
|
|
8753
|
-
* **scores-numeric / scores-categorical views:**
|
|
9837
|
+
* **scores-numeric / scores-boolean / scores-categorical views:**
|
|
8754
9838
|
* - `id` - Use specific filters to narrow down results
|
|
8755
9839
|
* - `traceId` - Use traceId filter instead
|
|
8756
9840
|
* - `userId` - Use userId filter instead
|
|
@@ -8960,7 +10044,7 @@ declare class Observations {
|
|
|
8960
10044
|
* ## Field Selection
|
|
8961
10045
|
* Use the `fields` parameter to control which observation fields are returned:
|
|
8962
10046
|
* - `core` - Always included: id, traceId, startTime, endTime, projectId, parentObservationId, type
|
|
8963
|
-
* - `basic` - name, level, statusMessage, version, environment, bookmarked, public, userId, sessionId
|
|
10047
|
+
* - `basic` - name, level, statusMessage, version, environment, bookmarked, public, userId, sessionId, isRootObservation
|
|
8964
10048
|
* - `time` - completionStartTime, createdAt, updatedAt
|
|
8965
10049
|
* - `io` - input, output
|
|
8966
10050
|
* - `metadata` - metadata (truncated to 200 chars by default, use `expandMetadata` to get full values)
|
|
@@ -10093,14 +11177,456 @@ declare class Scores {
|
|
|
10093
11177
|
protected readonly _options: Scores.Options;
|
|
10094
11178
|
constructor(_options: Scores.Options);
|
|
10095
11179
|
/**
|
|
10096
|
-
*
|
|
10097
|
-
*
|
|
11180
|
+
* Create a score (supports trace, observation, session, and dataset run scores)
|
|
11181
|
+
*
|
|
11182
|
+
* @param {LangfuseAPI.CreateScoreRequest} request
|
|
11183
|
+
* @param {Scores.RequestOptions} requestOptions - Request-specific configuration.
|
|
11184
|
+
*
|
|
11185
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11186
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11187
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11188
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11189
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11190
|
+
*
|
|
11191
|
+
* @example
|
|
11192
|
+
* await client.scores.create({
|
|
11193
|
+
* id: undefined,
|
|
11194
|
+
* traceId: undefined,
|
|
11195
|
+
* sessionId: undefined,
|
|
11196
|
+
* observationId: undefined,
|
|
11197
|
+
* datasetRunId: undefined,
|
|
11198
|
+
* name: "name",
|
|
11199
|
+
* value: 1.1,
|
|
11200
|
+
* comment: undefined,
|
|
11201
|
+
* metadata: undefined,
|
|
11202
|
+
* environment: undefined,
|
|
11203
|
+
* queueId: undefined,
|
|
11204
|
+
* dataType: undefined,
|
|
11205
|
+
* configId: undefined,
|
|
11206
|
+
* source: undefined
|
|
11207
|
+
* })
|
|
11208
|
+
*/
|
|
11209
|
+
create(request: CreateScoreRequest, requestOptions?: Scores.RequestOptions): HttpResponsePromise<CreateScoreResponse>;
|
|
11210
|
+
private __create;
|
|
11211
|
+
/**
|
|
11212
|
+
* **Deprecated.** Use `GET /api/public/v3/scores` instead. This endpoint
|
|
11213
|
+
* is no longer available on Langfuse v4 and later.
|
|
11214
|
+
*
|
|
11215
|
+
* Get a list of scores (supports both trace and session scores)
|
|
11216
|
+
*
|
|
11217
|
+
* @param {LangfuseAPI.GetScoresRequest} request
|
|
11218
|
+
* @param {Scores.RequestOptions} requestOptions - Request-specific configuration.
|
|
11219
|
+
*
|
|
11220
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11221
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11222
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11223
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11224
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11225
|
+
*
|
|
11226
|
+
* @example
|
|
11227
|
+
* await client.scores.getMany()
|
|
11228
|
+
*/
|
|
11229
|
+
getMany(request?: GetScoresRequest, requestOptions?: Scores.RequestOptions): HttpResponsePromise<GetScoresResponse>;
|
|
11230
|
+
private __getMany;
|
|
11231
|
+
/**
|
|
11232
|
+
* **Deprecated.** Use `GET /api/public/v3/scores` with the `id` filter
|
|
11233
|
+
* instead. This endpoint is no longer available on Langfuse v4 and later.
|
|
11234
|
+
*
|
|
11235
|
+
* Get a score (supports both trace and session scores)
|
|
11236
|
+
*
|
|
11237
|
+
* @param {string} scoreId - The unique langfuse identifier of a score
|
|
11238
|
+
* @param {Scores.RequestOptions} requestOptions - Request-specific configuration.
|
|
11239
|
+
*
|
|
11240
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11241
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11242
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11243
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11244
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11245
|
+
*
|
|
11246
|
+
* @example
|
|
11247
|
+
* await client.scores.getById("scoreId")
|
|
11248
|
+
*/
|
|
11249
|
+
getById(scoreId: string, requestOptions?: Scores.RequestOptions): HttpResponsePromise<Score>;
|
|
11250
|
+
private __getById;
|
|
11251
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
11252
|
+
}
|
|
11253
|
+
|
|
11254
|
+
/**
|
|
11255
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
11256
|
+
*/
|
|
11257
|
+
|
|
11258
|
+
declare namespace Sessions {
|
|
11259
|
+
interface Options {
|
|
11260
|
+
environment: Supplier<string>;
|
|
11261
|
+
/** Specify a custom URL to connect the client to. */
|
|
11262
|
+
baseUrl?: Supplier<string>;
|
|
11263
|
+
username?: Supplier<string | undefined>;
|
|
11264
|
+
password?: Supplier<string | undefined>;
|
|
11265
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
11266
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
11267
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
11268
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
11269
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
11270
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
11271
|
+
/** Additional headers to include in requests. */
|
|
11272
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
11273
|
+
}
|
|
11274
|
+
interface RequestOptions {
|
|
11275
|
+
/** The maximum time to wait for a response in seconds. */
|
|
11276
|
+
timeoutInSeconds?: number;
|
|
11277
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
11278
|
+
maxRetries?: number;
|
|
11279
|
+
/** A hook to abort the request. */
|
|
11280
|
+
abortSignal?: AbortSignal;
|
|
11281
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
11282
|
+
xLangfuseSdkName?: string | undefined;
|
|
11283
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
11284
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
11285
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
11286
|
+
xLangfusePublicKey?: string | undefined;
|
|
11287
|
+
/** Additional query string parameters to include in the request. */
|
|
11288
|
+
queryParams?: Record<string, unknown>;
|
|
11289
|
+
/** Additional headers to include in the request. */
|
|
11290
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
11291
|
+
}
|
|
11292
|
+
}
|
|
11293
|
+
declare class Sessions {
|
|
11294
|
+
protected readonly _options: Sessions.Options;
|
|
11295
|
+
constructor(_options: Sessions.Options);
|
|
11296
|
+
/**
|
|
11297
|
+
* Get sessions.
|
|
11298
|
+
*
|
|
11299
|
+
* This legacy endpoint is not recommended for new data extraction workflows.
|
|
11300
|
+
* Use the v2 observations endpoint with a bounded time range and group rows by
|
|
11301
|
+
* `sessionId` instead:
|
|
11302
|
+
* `GET /api/public/v2/observations?fromStartTime=<from>&toStartTime=<to>`.
|
|
11303
|
+
*
|
|
11304
|
+
* @param {LangfuseAPI.GetSessionsRequest} request
|
|
11305
|
+
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
11306
|
+
*
|
|
11307
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11308
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11309
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11310
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11311
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11312
|
+
*
|
|
11313
|
+
* @example
|
|
11314
|
+
* await client.sessions.list()
|
|
11315
|
+
*/
|
|
11316
|
+
list(request?: GetSessionsRequest, requestOptions?: Sessions.RequestOptions): HttpResponsePromise<PaginatedSessions>;
|
|
11317
|
+
private __list;
|
|
11318
|
+
/**
|
|
11319
|
+
* Get a session.
|
|
11320
|
+
*
|
|
11321
|
+
* Please note that `traces` on this endpoint are not paginated. For large
|
|
11322
|
+
* sessions or new data extraction workflows, use the v2 observations endpoint
|
|
11323
|
+
* with a URL-encoded `sessionId` filter and a bounded time range:
|
|
11324
|
+
* `GET /api/public/v2/observations?filter=<sessionId filter>&fromStartTime=<from>&toStartTime=<to>`.
|
|
11325
|
+
*
|
|
11326
|
+
* @param {string} sessionId - The unique id of a session
|
|
11327
|
+
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
11328
|
+
*
|
|
11329
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11330
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11331
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11332
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11333
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11334
|
+
*
|
|
11335
|
+
* @example
|
|
11336
|
+
* await client.sessions.get("sessionId")
|
|
11337
|
+
*/
|
|
11338
|
+
get(sessionId: string, requestOptions?: Sessions.RequestOptions): HttpResponsePromise<SessionWithTraces>;
|
|
11339
|
+
private __get;
|
|
11340
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
11341
|
+
}
|
|
11342
|
+
|
|
11343
|
+
/**
|
|
11344
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
11345
|
+
*/
|
|
11346
|
+
|
|
11347
|
+
declare namespace Trace {
|
|
11348
|
+
interface Options {
|
|
11349
|
+
environment: Supplier<string>;
|
|
11350
|
+
/** Specify a custom URL to connect the client to. */
|
|
11351
|
+
baseUrl?: Supplier<string>;
|
|
11352
|
+
username?: Supplier<string | undefined>;
|
|
11353
|
+
password?: Supplier<string | undefined>;
|
|
11354
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
11355
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
11356
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
11357
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
11358
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
11359
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
11360
|
+
/** Additional headers to include in requests. */
|
|
11361
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
11362
|
+
}
|
|
11363
|
+
interface RequestOptions {
|
|
11364
|
+
/** The maximum time to wait for a response in seconds. */
|
|
11365
|
+
timeoutInSeconds?: number;
|
|
11366
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
11367
|
+
maxRetries?: number;
|
|
11368
|
+
/** A hook to abort the request. */
|
|
11369
|
+
abortSignal?: AbortSignal;
|
|
11370
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
11371
|
+
xLangfuseSdkName?: string | undefined;
|
|
11372
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
11373
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
11374
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
11375
|
+
xLangfusePublicKey?: string | undefined;
|
|
11376
|
+
/** Additional query string parameters to include in the request. */
|
|
11377
|
+
queryParams?: Record<string, unknown>;
|
|
11378
|
+
/** Additional headers to include in the request. */
|
|
11379
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
11380
|
+
}
|
|
11381
|
+
}
|
|
11382
|
+
declare class Trace {
|
|
11383
|
+
protected readonly _options: Trace.Options;
|
|
11384
|
+
constructor(_options: Trace.Options);
|
|
11385
|
+
/**
|
|
11386
|
+
* Get a specific trace
|
|
11387
|
+
*
|
|
11388
|
+
* @param {string} traceId - The unique langfuse identifier of a trace
|
|
11389
|
+
* @param {LangfuseAPI.GetTraceRequest} request
|
|
11390
|
+
* @param {Trace.RequestOptions} requestOptions - Request-specific configuration.
|
|
11391
|
+
*
|
|
11392
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11393
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11394
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11395
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11396
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11397
|
+
*
|
|
11398
|
+
* @example
|
|
11399
|
+
* await client.trace.get("traceId")
|
|
11400
|
+
*/
|
|
11401
|
+
get(traceId: string, request?: GetTraceRequest, requestOptions?: Trace.RequestOptions): HttpResponsePromise<TraceWithFullDetails>;
|
|
11402
|
+
private __get;
|
|
11403
|
+
/**
|
|
11404
|
+
* Delete a specific trace
|
|
11405
|
+
*
|
|
11406
|
+
* @param {string} traceId - The unique langfuse identifier of the trace to delete
|
|
11407
|
+
* @param {Trace.RequestOptions} requestOptions - Request-specific configuration.
|
|
11408
|
+
*
|
|
11409
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11410
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11411
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11412
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11413
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11414
|
+
*
|
|
11415
|
+
* @example
|
|
11416
|
+
* await client.trace.delete("traceId")
|
|
11417
|
+
*/
|
|
11418
|
+
delete(traceId: string, requestOptions?: Trace.RequestOptions): HttpResponsePromise<DeleteTraceResponse>;
|
|
11419
|
+
private __delete;
|
|
11420
|
+
/**
|
|
11421
|
+
* Get list of traces
|
|
11422
|
+
*
|
|
11423
|
+
* @param {LangfuseAPI.GetTracesRequest} request
|
|
11424
|
+
* @param {Trace.RequestOptions} requestOptions - Request-specific configuration.
|
|
11425
|
+
*
|
|
11426
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11427
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11428
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11429
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11430
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11431
|
+
*
|
|
11432
|
+
* @example
|
|
11433
|
+
* await client.trace.list()
|
|
11434
|
+
*/
|
|
11435
|
+
list(request?: GetTracesRequest, requestOptions?: Trace.RequestOptions): HttpResponsePromise<Traces>;
|
|
11436
|
+
private __list;
|
|
11437
|
+
/**
|
|
11438
|
+
* Delete multiple traces
|
|
11439
|
+
*
|
|
11440
|
+
* @param {LangfuseAPI.DeleteTracesRequest} request
|
|
11441
|
+
* @param {Trace.RequestOptions} requestOptions - Request-specific configuration.
|
|
11442
|
+
*
|
|
11443
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11444
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11445
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11446
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11447
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11448
|
+
*
|
|
11449
|
+
* @example
|
|
11450
|
+
* await client.trace.deleteMultiple({
|
|
11451
|
+
* traceIds: ["traceIds", "traceIds"]
|
|
11452
|
+
* })
|
|
11453
|
+
*/
|
|
11454
|
+
deleteMultiple(request: DeleteTracesRequest, requestOptions?: Trace.RequestOptions): HttpResponsePromise<DeleteTraceResponse>;
|
|
11455
|
+
private __deleteMultiple;
|
|
11456
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
11457
|
+
}
|
|
11458
|
+
|
|
11459
|
+
/**
|
|
11460
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
11461
|
+
*/
|
|
11462
|
+
|
|
11463
|
+
declare namespace DashboardWidgets {
|
|
11464
|
+
interface Options {
|
|
11465
|
+
environment: Supplier<string>;
|
|
11466
|
+
/** Specify a custom URL to connect the client to. */
|
|
11467
|
+
baseUrl?: Supplier<string>;
|
|
11468
|
+
username?: Supplier<string | undefined>;
|
|
11469
|
+
password?: Supplier<string | undefined>;
|
|
11470
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
11471
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
11472
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
11473
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
11474
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
11475
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
11476
|
+
/** Additional headers to include in requests. */
|
|
11477
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
11478
|
+
}
|
|
11479
|
+
interface RequestOptions {
|
|
11480
|
+
/** The maximum time to wait for a response in seconds. */
|
|
11481
|
+
timeoutInSeconds?: number;
|
|
11482
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
11483
|
+
maxRetries?: number;
|
|
11484
|
+
/** A hook to abort the request. */
|
|
11485
|
+
abortSignal?: AbortSignal;
|
|
11486
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
11487
|
+
xLangfuseSdkName?: string | undefined;
|
|
11488
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
11489
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
11490
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
11491
|
+
xLangfusePublicKey?: string | undefined;
|
|
11492
|
+
/** Additional query string parameters to include in the request. */
|
|
11493
|
+
queryParams?: Record<string, unknown>;
|
|
11494
|
+
/** Additional headers to include in the request. */
|
|
11495
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
11496
|
+
}
|
|
11497
|
+
}
|
|
11498
|
+
declare class DashboardWidgets {
|
|
11499
|
+
protected readonly _options: DashboardWidgets.Options;
|
|
11500
|
+
constructor(_options: DashboardWidgets.Options);
|
|
11501
|
+
/**
|
|
11502
|
+
* List dashboard widgets in the project, ordered by most recently
|
|
11503
|
+
* updated first.
|
|
11504
|
+
*
|
|
11505
|
+
* Responses may include legacy `traces` widgets created before this
|
|
11506
|
+
* API existed. New widgets cannot be created with `view: traces`.
|
|
11507
|
+
*
|
|
11508
|
+
* @param {LangfuseAPI.unstable.ListDashboardWidgetsRequest} request
|
|
11509
|
+
* @param {DashboardWidgets.RequestOptions} requestOptions - Request-specific configuration.
|
|
11510
|
+
*
|
|
11511
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11512
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11513
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11514
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11515
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11516
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
11517
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11518
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11519
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11520
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11521
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11522
|
+
*
|
|
11523
|
+
* @example
|
|
11524
|
+
* await client.unstable.dashboardWidgets.list()
|
|
11525
|
+
*/
|
|
11526
|
+
list(request?: ListDashboardWidgetsRequest, requestOptions?: DashboardWidgets.RequestOptions): HttpResponsePromise<DashboardWidgetList>;
|
|
11527
|
+
private __list;
|
|
11528
|
+
/**
|
|
11529
|
+
* Create a dashboard widget (a standalone chart definition you place on
|
|
11530
|
+
* any dashboard).
|
|
11531
|
+
*
|
|
11532
|
+
* This endpoint creates the widget only; place it on a dashboard via
|
|
11533
|
+
* `POST /dashboards/{dashboardId}/placements`.
|
|
11534
|
+
*
|
|
11535
|
+
* Supported views are `observations`, `scores-numeric`, `scores-boolean`, and `scores-categorical`.
|
|
11536
|
+
* The legacy `traces` view is not supported by this unstable API.
|
|
11537
|
+
* Widgets are created as v2 internally.
|
|
11538
|
+
*
|
|
11539
|
+
* `chartConfig` is optional and defaults to the plain config for
|
|
11540
|
+
* `chartType`; when `chartConfig.type` is given it must match
|
|
11541
|
+
* `chartType`.
|
|
11542
|
+
*
|
|
11543
|
+
* Unstable API note:
|
|
11544
|
+
* - This surface may evolve while dashboard/widget APIs are being finalized.
|
|
11545
|
+
*
|
|
11546
|
+
* @param {LangfuseAPI.unstable.CreateDashboardWidgetRequest} request
|
|
11547
|
+
* @param {DashboardWidgets.RequestOptions} requestOptions - Request-specific configuration.
|
|
11548
|
+
*
|
|
11549
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11550
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11551
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11552
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11553
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11554
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
11555
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11556
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11557
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11558
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11559
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11560
|
+
*
|
|
11561
|
+
* @example
|
|
11562
|
+
* await client.unstable.dashboardWidgets.create({
|
|
11563
|
+
* name: "Total cost by model",
|
|
11564
|
+
* description: "Total model cost grouped by provided model name.",
|
|
11565
|
+
* view: "observations",
|
|
11566
|
+
* dimensions: [{
|
|
11567
|
+
* field: "providedModelName"
|
|
11568
|
+
* }],
|
|
11569
|
+
* metrics: [{
|
|
11570
|
+
* measure: "totalCost",
|
|
11571
|
+
* agg: "sum"
|
|
11572
|
+
* }],
|
|
11573
|
+
* filters: [],
|
|
11574
|
+
* chartType: "HORIZONTAL_BAR",
|
|
11575
|
+
* chartConfig: {
|
|
11576
|
+
* row_limit: 10
|
|
11577
|
+
* }
|
|
11578
|
+
* })
|
|
11579
|
+
*/
|
|
11580
|
+
create(request: CreateDashboardWidgetRequest, requestOptions?: DashboardWidgets.RequestOptions): HttpResponsePromise<DashboardWidget>;
|
|
11581
|
+
private __create;
|
|
11582
|
+
/**
|
|
11583
|
+
* Get a dashboard widget by id.
|
|
11584
|
+
*
|
|
11585
|
+
* The response may use `view: traces` for legacy widgets.
|
|
11586
|
+
*
|
|
11587
|
+
* @param {string} widgetId
|
|
11588
|
+
* @param {DashboardWidgets.RequestOptions} requestOptions - Request-specific configuration.
|
|
11589
|
+
*
|
|
11590
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11591
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11592
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11593
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11594
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11595
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11596
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
11597
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11598
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11599
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11600
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11601
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11602
|
+
*
|
|
11603
|
+
* @example
|
|
11604
|
+
* await client.unstable.dashboardWidgets.get("widgetId")
|
|
11605
|
+
*/
|
|
11606
|
+
get(widgetId: string, requestOptions?: DashboardWidgets.RequestOptions): HttpResponsePromise<DashboardWidget>;
|
|
11607
|
+
private __get;
|
|
11608
|
+
/**
|
|
11609
|
+
* Update a dashboard widget.
|
|
10098
11610
|
*
|
|
10099
|
-
*
|
|
11611
|
+
* All fields are optional; at least one field is required.
|
|
11612
|
+
* Changing `chartType` without sending `chartConfig` resets the config
|
|
11613
|
+
* to the new chart type's defaults. When `chartConfig.type` is given
|
|
11614
|
+
* it must match the widget's (possibly updated) `chartType`.
|
|
10100
11615
|
*
|
|
10101
|
-
*
|
|
10102
|
-
*
|
|
11616
|
+
* `view` cannot be changed to the legacy `traces` value. Existing
|
|
11617
|
+
* `traces` widgets may be updated on other fields.
|
|
11618
|
+
*
|
|
11619
|
+
* @param {string} widgetId
|
|
11620
|
+
* @param {LangfuseAPI.unstable.UpdateDashboardWidgetRequest} request
|
|
11621
|
+
* @param {DashboardWidgets.RequestOptions} requestOptions - Request-specific configuration.
|
|
10103
11622
|
*
|
|
11623
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11624
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11625
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11626
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11627
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11628
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11629
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10104
11630
|
* @throws {@link LangfuseAPI.Error}
|
|
10105
11631
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10106
11632
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10108,19 +11634,36 @@ declare class Scores {
|
|
|
10108
11634
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10109
11635
|
*
|
|
10110
11636
|
* @example
|
|
10111
|
-
* await client.
|
|
11637
|
+
* await client.unstable.dashboardWidgets.update("widgetId", {
|
|
11638
|
+
* name: undefined,
|
|
11639
|
+
* description: undefined,
|
|
11640
|
+
* view: undefined,
|
|
11641
|
+
* dimensions: undefined,
|
|
11642
|
+
* metrics: undefined,
|
|
11643
|
+
* filters: undefined,
|
|
11644
|
+
* chartType: undefined,
|
|
11645
|
+
* chartConfig: undefined
|
|
11646
|
+
* })
|
|
10112
11647
|
*/
|
|
10113
|
-
|
|
10114
|
-
private
|
|
11648
|
+
update(widgetId: string, request: UpdateDashboardWidgetRequest, requestOptions?: DashboardWidgets.RequestOptions): HttpResponsePromise<DashboardWidget>;
|
|
11649
|
+
private __update;
|
|
10115
11650
|
/**
|
|
10116
|
-
*
|
|
10117
|
-
* instead. This endpoint is no longer available on Langfuse v4 and later.
|
|
11651
|
+
* Delete a dashboard widget.
|
|
10118
11652
|
*
|
|
10119
|
-
*
|
|
11653
|
+
* The API returns `409` while the widget is still placed on a dashboard.
|
|
11654
|
+
* Remove those placements first.
|
|
10120
11655
|
*
|
|
10121
|
-
* @param {string}
|
|
10122
|
-
* @param {
|
|
11656
|
+
* @param {string} widgetId
|
|
11657
|
+
* @param {DashboardWidgets.RequestOptions} requestOptions - Request-specific configuration.
|
|
10123
11658
|
*
|
|
11659
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11660
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11661
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11662
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11663
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11664
|
+
* @throws {@link LangfuseAPI.unstable.ConflictError}
|
|
11665
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11666
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10124
11667
|
* @throws {@link LangfuseAPI.Error}
|
|
10125
11668
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10126
11669
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10128,10 +11671,10 @@ declare class Scores {
|
|
|
10128
11671
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10129
11672
|
*
|
|
10130
11673
|
* @example
|
|
10131
|
-
* await client.
|
|
11674
|
+
* await client.unstable.dashboardWidgets.delete("widgetId")
|
|
10132
11675
|
*/
|
|
10133
|
-
|
|
10134
|
-
private
|
|
11676
|
+
delete(widgetId: string, requestOptions?: DashboardWidgets.RequestOptions): HttpResponsePromise<DeleteDashboardWidgetResponse>;
|
|
11677
|
+
private __delete;
|
|
10135
11678
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
10136
11679
|
}
|
|
10137
11680
|
|
|
@@ -10139,7 +11682,7 @@ declare class Scores {
|
|
|
10139
11682
|
* This file was auto-generated by Fern from our API Definition.
|
|
10140
11683
|
*/
|
|
10141
11684
|
|
|
10142
|
-
declare namespace
|
|
11685
|
+
declare namespace Dashboards {
|
|
10143
11686
|
interface Options {
|
|
10144
11687
|
environment: Supplier<string>;
|
|
10145
11688
|
/** Specify a custom URL to connect the client to. */
|
|
@@ -10174,20 +11717,22 @@ declare namespace Sessions {
|
|
|
10174
11717
|
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
10175
11718
|
}
|
|
10176
11719
|
}
|
|
10177
|
-
declare class
|
|
10178
|
-
protected readonly _options:
|
|
10179
|
-
constructor(_options:
|
|
11720
|
+
declare class Dashboards {
|
|
11721
|
+
protected readonly _options: Dashboards.Options;
|
|
11722
|
+
constructor(_options: Dashboards.Options);
|
|
10180
11723
|
/**
|
|
10181
|
-
*
|
|
11724
|
+
* List dashboards in the project, ordered by most recently updated
|
|
11725
|
+
* first.
|
|
10182
11726
|
*
|
|
10183
|
-
*
|
|
10184
|
-
*
|
|
10185
|
-
* `sessionId` instead:
|
|
10186
|
-
* `GET /api/public/v2/observations?fromStartTime=<from>&toStartTime=<to>`.
|
|
10187
|
-
*
|
|
10188
|
-
* @param {LangfuseAPI.GetSessionsRequest} request
|
|
10189
|
-
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
|
11727
|
+
* @param {LangfuseAPI.unstable.ListDashboardsRequest} request
|
|
11728
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
10190
11729
|
*
|
|
11730
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11731
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11732
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11733
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11734
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11735
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10191
11736
|
* @throws {@link LangfuseAPI.Error}
|
|
10192
11737
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10193
11738
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10195,21 +11740,52 @@ declare class Sessions {
|
|
|
10195
11740
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10196
11741
|
*
|
|
10197
11742
|
* @example
|
|
10198
|
-
* await client.
|
|
11743
|
+
* await client.unstable.dashboards.list()
|
|
10199
11744
|
*/
|
|
10200
|
-
list(request?:
|
|
11745
|
+
list(request?: ListDashboardsRequest, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<DashboardList>;
|
|
10201
11746
|
private __list;
|
|
10202
11747
|
/**
|
|
10203
|
-
*
|
|
11748
|
+
* Create a dashboard.
|
|
10204
11749
|
*
|
|
10205
|
-
*
|
|
10206
|
-
*
|
|
10207
|
-
* with a URL-encoded `sessionId` filter and a bounded time range:
|
|
10208
|
-
* `GET /api/public/v2/observations?filter=<sessionId filter>&fromStartTime=<from>&toStartTime=<to>`.
|
|
11750
|
+
* @param {LangfuseAPI.unstable.CreateDashboardRequest} request
|
|
11751
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
10209
11752
|
*
|
|
10210
|
-
* @
|
|
10211
|
-
* @
|
|
11753
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11754
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11755
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11756
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11757
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11758
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11759
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
11760
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11761
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11762
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11763
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11764
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11765
|
+
*
|
|
11766
|
+
* @example
|
|
11767
|
+
* await client.unstable.dashboards.create({
|
|
11768
|
+
* name: "name",
|
|
11769
|
+
* description: undefined,
|
|
11770
|
+
* definition: undefined,
|
|
11771
|
+
* filters: undefined
|
|
11772
|
+
* })
|
|
11773
|
+
*/
|
|
11774
|
+
create(request: CreateDashboardRequest, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<Dashboard>;
|
|
11775
|
+
private __create;
|
|
11776
|
+
/**
|
|
11777
|
+
* Get a dashboard by id.
|
|
10212
11778
|
*
|
|
11779
|
+
* @param {string} dashboardId
|
|
11780
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
11781
|
+
*
|
|
11782
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11783
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11784
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11785
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11786
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11787
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11788
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10213
11789
|
* @throws {@link LangfuseAPI.Error}
|
|
10214
11790
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10215
11791
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10217,62 +11793,24 @@ declare class Sessions {
|
|
|
10217
11793
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10218
11794
|
*
|
|
10219
11795
|
* @example
|
|
10220
|
-
* await client.
|
|
11796
|
+
* await client.unstable.dashboards.get("dashboardId")
|
|
10221
11797
|
*/
|
|
10222
|
-
get(
|
|
11798
|
+
get(dashboardId: string, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<Dashboard>;
|
|
10223
11799
|
private __get;
|
|
10224
|
-
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
10225
|
-
}
|
|
10226
|
-
|
|
10227
|
-
/**
|
|
10228
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
10229
|
-
*/
|
|
10230
|
-
|
|
10231
|
-
declare namespace Trace {
|
|
10232
|
-
interface Options {
|
|
10233
|
-
environment: Supplier<string>;
|
|
10234
|
-
/** Specify a custom URL to connect the client to. */
|
|
10235
|
-
baseUrl?: Supplier<string>;
|
|
10236
|
-
username?: Supplier<string | undefined>;
|
|
10237
|
-
password?: Supplier<string | undefined>;
|
|
10238
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
10239
|
-
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
10240
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
10241
|
-
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
10242
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
10243
|
-
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
10244
|
-
/** Additional headers to include in requests. */
|
|
10245
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
10246
|
-
}
|
|
10247
|
-
interface RequestOptions {
|
|
10248
|
-
/** The maximum time to wait for a response in seconds. */
|
|
10249
|
-
timeoutInSeconds?: number;
|
|
10250
|
-
/** The number of times to retry the request. Defaults to 2. */
|
|
10251
|
-
maxRetries?: number;
|
|
10252
|
-
/** A hook to abort the request. */
|
|
10253
|
-
abortSignal?: AbortSignal;
|
|
10254
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
10255
|
-
xLangfuseSdkName?: string | undefined;
|
|
10256
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
10257
|
-
xLangfuseSdkVersion?: string | undefined;
|
|
10258
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
10259
|
-
xLangfusePublicKey?: string | undefined;
|
|
10260
|
-
/** Additional query string parameters to include in the request. */
|
|
10261
|
-
queryParams?: Record<string, unknown>;
|
|
10262
|
-
/** Additional headers to include in the request. */
|
|
10263
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
10264
|
-
}
|
|
10265
|
-
}
|
|
10266
|
-
declare class Trace {
|
|
10267
|
-
protected readonly _options: Trace.Options;
|
|
10268
|
-
constructor(_options: Trace.Options);
|
|
10269
11800
|
/**
|
|
10270
|
-
*
|
|
11801
|
+
* Update a dashboard's name, description, definition, or filters.
|
|
10271
11802
|
*
|
|
10272
|
-
* @param {string}
|
|
10273
|
-
* @param {LangfuseAPI.
|
|
10274
|
-
* @param {
|
|
11803
|
+
* @param {string} dashboardId
|
|
11804
|
+
* @param {LangfuseAPI.unstable.UpdateDashboardRequest} request
|
|
11805
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
10275
11806
|
*
|
|
11807
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11808
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11809
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11810
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11811
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11812
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11813
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10276
11814
|
* @throws {@link LangfuseAPI.Error}
|
|
10277
11815
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10278
11816
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10280,16 +11818,28 @@ declare class Trace {
|
|
|
10280
11818
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10281
11819
|
*
|
|
10282
11820
|
* @example
|
|
10283
|
-
* await client.
|
|
11821
|
+
* await client.unstable.dashboards.update("dashboardId", {
|
|
11822
|
+
* name: undefined,
|
|
11823
|
+
* description: undefined,
|
|
11824
|
+
* definition: undefined,
|
|
11825
|
+
* filters: undefined
|
|
11826
|
+
* })
|
|
10284
11827
|
*/
|
|
10285
|
-
|
|
10286
|
-
private
|
|
11828
|
+
update(dashboardId: string, request: UpdateDashboardRequest, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<Dashboard>;
|
|
11829
|
+
private __update;
|
|
10287
11830
|
/**
|
|
10288
|
-
* Delete a
|
|
11831
|
+
* Delete a dashboard.
|
|
10289
11832
|
*
|
|
10290
|
-
* @param {string}
|
|
10291
|
-
* @param {
|
|
11833
|
+
* @param {string} dashboardId
|
|
11834
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
10292
11835
|
*
|
|
11836
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11837
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11838
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11839
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11840
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11841
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11842
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10293
11843
|
* @throws {@link LangfuseAPI.Error}
|
|
10294
11844
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10295
11845
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10297,16 +11847,34 @@ declare class Trace {
|
|
|
10297
11847
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10298
11848
|
*
|
|
10299
11849
|
* @example
|
|
10300
|
-
* await client.
|
|
11850
|
+
* await client.unstable.dashboards.delete("dashboardId")
|
|
10301
11851
|
*/
|
|
10302
|
-
delete(
|
|
11852
|
+
delete(dashboardId: string, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<DeleteDashboardResponse>;
|
|
10303
11853
|
private __delete;
|
|
10304
11854
|
/**
|
|
10305
|
-
*
|
|
11855
|
+
* Add a placement to a dashboard grid (see `DashboardPlacement` for
|
|
11856
|
+
* grid semantics).
|
|
10306
11857
|
*
|
|
10307
|
-
*
|
|
10308
|
-
*
|
|
11858
|
+
* `id` and the position fields are optional: when omitted, the
|
|
11859
|
+
* placement gets a server-generated id and is appended below all
|
|
11860
|
+
* existing tiles as a 6x6 tile. Returns the created placement.
|
|
11861
|
+
*
|
|
11862
|
+
* The referenced widget must exist in the same project or be a
|
|
11863
|
+
* Langfuse-managed widget. The API returns `409` if a placement with
|
|
11864
|
+
* the same `id` already exists on the dashboard.
|
|
11865
|
+
*
|
|
11866
|
+
* @param {string} dashboardId
|
|
11867
|
+
* @param {LangfuseAPI.unstable.CreateDashboardPlacementRequest} request
|
|
11868
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
10309
11869
|
*
|
|
11870
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11871
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11872
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11873
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11874
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11875
|
+
* @throws {@link LangfuseAPI.unstable.ConflictError}
|
|
11876
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11877
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10310
11878
|
* @throws {@link LangfuseAPI.Error}
|
|
10311
11879
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10312
11880
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10314,16 +11882,36 @@ declare class Trace {
|
|
|
10314
11882
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10315
11883
|
*
|
|
10316
11884
|
* @example
|
|
10317
|
-
* await client.
|
|
11885
|
+
* await client.unstable.dashboards.addPlacement("dashboardId", {
|
|
11886
|
+
* type: "widget",
|
|
11887
|
+
* id: undefined,
|
|
11888
|
+
* widgetId: "widgetId",
|
|
11889
|
+
* x: undefined,
|
|
11890
|
+
* y: undefined,
|
|
11891
|
+
* width: undefined,
|
|
11892
|
+
* height: undefined
|
|
11893
|
+
* })
|
|
10318
11894
|
*/
|
|
10319
|
-
|
|
10320
|
-
private
|
|
11895
|
+
addPlacement(dashboardId: string, request: CreateDashboardPlacementRequest, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<DashboardPlacement>;
|
|
11896
|
+
private __addPlacement;
|
|
10321
11897
|
/**
|
|
10322
|
-
*
|
|
11898
|
+
* Move or resize a placement. All fields are optional; at least one is
|
|
11899
|
+
* required. Omitted fields keep their current value. The placement's
|
|
11900
|
+
* content (widget/preset reference) and id cannot change — delete and
|
|
11901
|
+
* re-add the placement to swap content. Returns the updated placement.
|
|
10323
11902
|
*
|
|
10324
|
-
* @param {
|
|
10325
|
-
* @param {
|
|
11903
|
+
* @param {string} dashboardId
|
|
11904
|
+
* @param {string} placementId
|
|
11905
|
+
* @param {LangfuseAPI.unstable.UpdateDashboardPlacementRequest} request
|
|
11906
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
10326
11907
|
*
|
|
11908
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11909
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11910
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11911
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11912
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11913
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11914
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
10327
11915
|
* @throws {@link LangfuseAPI.Error}
|
|
10328
11916
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
10329
11917
|
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
@@ -10331,12 +11919,40 @@ declare class Trace {
|
|
|
10331
11919
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
10332
11920
|
*
|
|
10333
11921
|
* @example
|
|
10334
|
-
* await client.
|
|
10335
|
-
*
|
|
11922
|
+
* await client.unstable.dashboards.updatePlacement("dashboardId", "placementId", {
|
|
11923
|
+
* x: undefined,
|
|
11924
|
+
* y: undefined,
|
|
11925
|
+
* width: undefined,
|
|
11926
|
+
* height: undefined
|
|
10336
11927
|
* })
|
|
10337
11928
|
*/
|
|
10338
|
-
|
|
10339
|
-
private
|
|
11929
|
+
updatePlacement(dashboardId: string, placementId: string, request: UpdateDashboardPlacementRequest, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<DashboardPlacement>;
|
|
11930
|
+
private __updatePlacement;
|
|
11931
|
+
/**
|
|
11932
|
+
* Remove a placement from a dashboard grid without deleting the referenced widget.
|
|
11933
|
+
*
|
|
11934
|
+
* @param {string} dashboardId
|
|
11935
|
+
* @param {string} placementId
|
|
11936
|
+
* @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
|
|
11937
|
+
*
|
|
11938
|
+
* @throws {@link LangfuseAPI.unstable.BadRequestError}
|
|
11939
|
+
* @throws {@link LangfuseAPI.unstable.UnauthorizedError}
|
|
11940
|
+
* @throws {@link LangfuseAPI.unstable.AccessDeniedError}
|
|
11941
|
+
* @throws {@link LangfuseAPI.unstable.NotFoundError}
|
|
11942
|
+
* @throws {@link LangfuseAPI.unstable.MethodNotAllowedError}
|
|
11943
|
+
* @throws {@link LangfuseAPI.unstable.TooManyRequestsError}
|
|
11944
|
+
* @throws {@link LangfuseAPI.unstable.InternalServerError}
|
|
11945
|
+
* @throws {@link LangfuseAPI.Error}
|
|
11946
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
11947
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
11948
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
11949
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
11950
|
+
*
|
|
11951
|
+
* @example
|
|
11952
|
+
* await client.unstable.dashboards.deletePlacement("dashboardId", "placementId")
|
|
11953
|
+
*/
|
|
11954
|
+
deletePlacement(dashboardId: string, placementId: string, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<DeleteDashboardPlacementResponse>;
|
|
11955
|
+
private __deletePlacement;
|
|
10340
11956
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
10341
11957
|
}
|
|
10342
11958
|
|
|
@@ -10514,7 +12130,7 @@ declare class EvaluationRules {
|
|
|
10514
12130
|
/**
|
|
10515
12131
|
* List evaluation rules in the authenticated project.
|
|
10516
12132
|
*
|
|
10517
|
-
*
|
|
12133
|
+
* This includes legacy `trace` and `dataset` rules so they can be inspected and migrated to v4 rules. Legacy rules are read-only through this API; create, update, and delete continue to support only `observation` and `experiment` rules.
|
|
10518
12134
|
*
|
|
10519
12135
|
* @param {LangfuseAPI.unstable.ListEvaluationRulesRequest} request
|
|
10520
12136
|
* @param {EvaluationRules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -10539,7 +12155,7 @@ declare class EvaluationRules {
|
|
|
10539
12155
|
/**
|
|
10540
12156
|
* Get one evaluation rule by its identifier.
|
|
10541
12157
|
*
|
|
10542
|
-
* Use this endpoint to inspect the current evaluator, target, mapping, filters, and effective runtime status.
|
|
12158
|
+
* Use this endpoint to inspect the current evaluator, target, mapping, filters, execution timing, and effective runtime status. Legacy `trace` and `dataset` rules are returned for migration and are read-only through this API.
|
|
10543
12159
|
*
|
|
10544
12160
|
* @param {string} evaluationRuleId - Evaluation rule identifier returned by the evaluation rule endpoints.
|
|
10545
12161
|
* @param {EvaluationRules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -10560,7 +12176,7 @@ declare class EvaluationRules {
|
|
|
10560
12176
|
* @example
|
|
10561
12177
|
* await client.unstable.evaluationRules.get("evaluationRuleId")
|
|
10562
12178
|
*/
|
|
10563
|
-
get(evaluationRuleId: string, requestOptions?: EvaluationRules.RequestOptions): HttpResponsePromise<
|
|
12179
|
+
get(evaluationRuleId: string, requestOptions?: EvaluationRules.RequestOptions): HttpResponsePromise<ReadableEvaluationRule>;
|
|
10564
12180
|
private __get;
|
|
10565
12181
|
/**
|
|
10566
12182
|
* Update an evaluation rule.
|
|
@@ -10885,9 +12501,13 @@ declare namespace Unstable {
|
|
|
10885
12501
|
}
|
|
10886
12502
|
declare class Unstable {
|
|
10887
12503
|
protected readonly _options: Unstable.Options;
|
|
12504
|
+
protected _dashboardWidgets: DashboardWidgets | undefined;
|
|
12505
|
+
protected _dashboards: Dashboards | undefined;
|
|
10888
12506
|
protected _evaluationRules: EvaluationRules | undefined;
|
|
10889
12507
|
protected _evaluators: Evaluators | undefined;
|
|
10890
12508
|
constructor(_options: Unstable.Options);
|
|
12509
|
+
get dashboardWidgets(): DashboardWidgets;
|
|
12510
|
+
get dashboards(): Dashboards;
|
|
10891
12511
|
get evaluationRules(): EvaluationRules;
|
|
10892
12512
|
get evaluators(): Evaluators;
|
|
10893
12513
|
}
|
|
@@ -10939,6 +12559,8 @@ declare class LangfuseAPIClient {
|
|
|
10939
12559
|
protected _datasetItems: DatasetItems | undefined;
|
|
10940
12560
|
protected _datasetRunItems: DatasetRunItems | undefined;
|
|
10941
12561
|
protected _datasets: Datasets | undefined;
|
|
12562
|
+
protected _experiments: Experiments | undefined;
|
|
12563
|
+
protected _feedback: Feedback | undefined;
|
|
10942
12564
|
protected _health: Health | undefined;
|
|
10943
12565
|
protected _ingestion: Ingestion | undefined;
|
|
10944
12566
|
protected _legacy: Legacy | undefined;
|
|
@@ -10966,6 +12588,8 @@ declare class LangfuseAPIClient {
|
|
|
10966
12588
|
get datasetItems(): DatasetItems;
|
|
10967
12589
|
get datasetRunItems(): DatasetRunItems;
|
|
10968
12590
|
get datasets(): Datasets;
|
|
12591
|
+
get experiments(): Experiments;
|
|
12592
|
+
get feedback(): Feedback;
|
|
10969
12593
|
get health(): Health;
|
|
10970
12594
|
get ingestion(): Ingestion;
|
|
10971
12595
|
get legacy(): Legacy;
|
|
@@ -11330,11 +12954,11 @@ declare function uploadMedia(params: UploadMediaParams): Promise<void>;
|
|
|
11330
12954
|
* Attribute propagation utilities for Langfuse OpenTelemetry integration.
|
|
11331
12955
|
*
|
|
11332
12956
|
* This module provides the `propagateAttributes` function for setting trace-level
|
|
11333
|
-
* attributes (userId, sessionId, metadata) that automatically propagate
|
|
11334
|
-
* within the context.
|
|
12957
|
+
* attributes (userId, sessionId, environment, metadata) that automatically propagate
|
|
12958
|
+
* to all child spans within the context.
|
|
11335
12959
|
*/
|
|
11336
12960
|
|
|
11337
|
-
type CorrelatedKey = "userId" | "sessionId" | "metadata" | "version" | "tags" | "traceName";
|
|
12961
|
+
type CorrelatedKey = "userId" | "sessionId" | "metadata" | "version" | "tags" | "traceName" | "environment" | "promptName" | "promptVersion";
|
|
11338
12962
|
declare const experimentKeys: readonly ["experimentId", "experimentName", "experimentMetadata", "experimentDatasetId", "experimentItemId", "experimentItemMetadata", "experimentItemRootObservationId"];
|
|
11339
12963
|
type ExperimentKey = (typeof experimentKeys)[number];
|
|
11340
12964
|
type PropagatedKey = CorrelatedKey | ExperimentKey;
|
|
@@ -11371,6 +12995,23 @@ declare function getLangfuseTraceIdFromBaggage(context: Context): string | undef
|
|
|
11371
12995
|
* @internal
|
|
11372
12996
|
*/
|
|
11373
12997
|
declare function setLangfuseTraceIdInBaggage(context: Context, traceId: string): Context;
|
|
12998
|
+
/**
|
|
12999
|
+
* Prompt-like input accepted by {@link propagateAttributes}.
|
|
13000
|
+
*
|
|
13001
|
+
* Satisfied by prompt clients returned from Langfuse prompt management
|
|
13002
|
+
* (e.g. `langfuse.prompt.get(...)`) as well as plain objects exposing
|
|
13003
|
+
* `name` and `version`.
|
|
13004
|
+
*
|
|
13005
|
+
* @public
|
|
13006
|
+
*/
|
|
13007
|
+
type PropagatedPromptInput = {
|
|
13008
|
+
/** Name of the prompt. Must be a non-empty string. */
|
|
13009
|
+
name: string;
|
|
13010
|
+
/** Version of the prompt. Must be an integer; digit-only strings (e.g. "5") are coerced. */
|
|
13011
|
+
version: number | string;
|
|
13012
|
+
/** Whether this is a fallback prompt. Fallback prompts are never linked. */
|
|
13013
|
+
isFallback?: boolean;
|
|
13014
|
+
};
|
|
11374
13015
|
/**
|
|
11375
13016
|
* Parameters for propagateAttributes function.
|
|
11376
13017
|
*
|
|
@@ -11410,6 +13051,33 @@ interface PropagateAttributesParams {
|
|
|
11410
13051
|
* Must be a string ≤200 characters.
|
|
11411
13052
|
*/
|
|
11412
13053
|
traceName?: string;
|
|
13054
|
+
/**
|
|
13055
|
+
* Langfuse environment to associate with all spans in this context.
|
|
13056
|
+
*
|
|
13057
|
+
* Must be a lowercase alphanumeric string with optional hyphens or underscores,
|
|
13058
|
+
* must be ≤40 characters, and must not start with `langfuse`. This maps to the
|
|
13059
|
+
* first-class `langfuse.environment` attribute, not to trace metadata.
|
|
13060
|
+
*
|
|
13061
|
+
* A propagated environment takes precedence over the default configured on
|
|
13062
|
+
* `LangfuseSpanProcessor` or via `LANGFUSE_TRACING_ENVIRONMENT` while this
|
|
13063
|
+
* propagation scope is active.
|
|
13064
|
+
*/
|
|
13065
|
+
environment?: string;
|
|
13066
|
+
/**
|
|
13067
|
+
* Langfuse prompt to link to observations created within this context.
|
|
13068
|
+
*
|
|
13069
|
+
* Accepts a prompt client returned by `langfuse.prompt.get(...)` or any plain
|
|
13070
|
+
* object exposing `name` (non-empty string) and `version` (integer) — e.g.
|
|
13071
|
+
* `{ name: "my-prompt", version: 3 }`. This is the recommended way to link
|
|
13072
|
+
* prompts to generations emitted by auto-instrumentation libraries (e.g.
|
|
13073
|
+
* OpenInference, other OTel instrumentations) where you don't create the
|
|
13074
|
+
* generation via the Langfuse SDK yourself.
|
|
13075
|
+
*
|
|
13076
|
+
* The prompt link is only applied to generation-type observations by the
|
|
13077
|
+
* Langfuse backend. Fallback prompts are never linked. An explicit `prompt`
|
|
13078
|
+
* set directly on an observation takes precedence over the propagated one.
|
|
13079
|
+
*/
|
|
13080
|
+
prompt?: PropagatedPromptInput;
|
|
11413
13081
|
/**
|
|
11414
13082
|
* If true, propagates attributes using OpenTelemetry baggage for
|
|
11415
13083
|
* cross-process/service propagation.
|
|
@@ -11436,8 +13104,9 @@ interface PropagateAttributesParams {
|
|
|
11436
13104
|
*
|
|
11437
13105
|
* This function sets attributes on the currently active span AND automatically
|
|
11438
13106
|
* propagates them to all new child spans created within the callback. This is the
|
|
11439
|
-
* recommended way to set trace-level attributes like userId, sessionId,
|
|
11440
|
-
* dimensions that should be consistently applied across all observations
|
|
13107
|
+
* recommended way to set trace-level attributes like userId, sessionId, environment,
|
|
13108
|
+
* and metadata dimensions that should be consistently applied across all observations
|
|
13109
|
+
* in a trace.
|
|
11441
13110
|
*
|
|
11442
13111
|
* **IMPORTANT**: Call this as early as possible within your trace/workflow. Only the
|
|
11443
13112
|
* currently active span and spans created after entering this context will have these
|
|
@@ -11463,11 +13132,12 @@ interface PropagateAttributesParams {
|
|
|
11463
13132
|
* await propagateAttributes({
|
|
11464
13133
|
* userId: 'user_123',
|
|
11465
13134
|
* sessionId: 'session_abc',
|
|
11466
|
-
*
|
|
13135
|
+
* environment: 'production',
|
|
13136
|
+
* metadata: { experiment: 'variant_a' }
|
|
11467
13137
|
* }, async () => {
|
|
11468
|
-
* // All spans created here will have userId, sessionId, and metadata
|
|
13138
|
+
* // All spans created here will have userId, sessionId, environment, and metadata
|
|
11469
13139
|
* const llmSpan = startObservation('llm_call', { input: 'Hello' });
|
|
11470
|
-
* // This span inherits
|
|
13140
|
+
* // This span inherits userId, sessionId, environment, and experiment metadata
|
|
11471
13141
|
* llmSpan.end();
|
|
11472
13142
|
*
|
|
11473
13143
|
* const gen = startObservation('completion', {}, { asType: 'generation' });
|
|
@@ -11478,6 +13148,27 @@ interface PropagateAttributesParams {
|
|
|
11478
13148
|
* ```
|
|
11479
13149
|
*
|
|
11480
13150
|
* @example
|
|
13151
|
+
* Prompt linking with auto-instrumented libraries:
|
|
13152
|
+
*
|
|
13153
|
+
* ```typescript
|
|
13154
|
+
* import { LangfuseClient } from '@langfuse/client';
|
|
13155
|
+
* import { propagateAttributes } from '@langfuse/tracing';
|
|
13156
|
+
*
|
|
13157
|
+
* const langfuse = new LangfuseClient();
|
|
13158
|
+
* const prompt = await langfuse.prompt.get('my-prompt');
|
|
13159
|
+
*
|
|
13160
|
+
* await propagateAttributes({ prompt }, async () => {
|
|
13161
|
+
* // Generations emitted by auto-instrumentation (OpenInference,
|
|
13162
|
+
* // other OTel instrumentations, ...) within this context are
|
|
13163
|
+
* // linked to the prompt version.
|
|
13164
|
+
* const completion = await openai.chat.completions.create({
|
|
13165
|
+
* model: 'gpt-4o',
|
|
13166
|
+
* messages: [{ role: 'user', content: prompt.compile({ topic: 'chickens' }) }],
|
|
13167
|
+
* });
|
|
13168
|
+
* });
|
|
13169
|
+
* ```
|
|
13170
|
+
*
|
|
13171
|
+
* @example
|
|
11481
13172
|
* Late propagation (anti-pattern):
|
|
11482
13173
|
*
|
|
11483
13174
|
* ```typescript
|
|
@@ -11508,11 +13199,12 @@ interface PropagateAttributesParams {
|
|
|
11508
13199
|
* await propagateAttributes({
|
|
11509
13200
|
* userId: 'user_123',
|
|
11510
13201
|
* sessionId: 'session_abc',
|
|
13202
|
+
* environment: 'staging',
|
|
11511
13203
|
* asBaggage: true // Propagate via HTTP headers
|
|
11512
13204
|
* }, async () => {
|
|
11513
13205
|
* // Make HTTP request to Service B
|
|
11514
13206
|
* const response = await fetch('https://service-b.example.com/api');
|
|
11515
|
-
* // userId and
|
|
13207
|
+
* // userId, sessionId, and environment are now in HTTP headers
|
|
11516
13208
|
* });
|
|
11517
13209
|
* });
|
|
11518
13210
|
*
|
|
@@ -11522,9 +13214,10 @@ interface PropagateAttributesParams {
|
|
|
11522
13214
|
* ```
|
|
11523
13215
|
*
|
|
11524
13216
|
* @remarks
|
|
11525
|
-
* - **Validation**:
|
|
11526
|
-
*
|
|
11527
|
-
*
|
|
13217
|
+
* - **Validation**: Attribute values (userId, sessionId, metadata values) must be
|
|
13218
|
+
* strings ≤200 characters. Environment must be a lowercase alphanumeric string
|
|
13219
|
+
* with optional hyphens or underscores, must be ≤40 characters, and must not start
|
|
13220
|
+
* with `langfuse`. Invalid values will be dropped with a warning logged.
|
|
11528
13221
|
* - **OpenTelemetry**: This uses OpenTelemetry context propagation under the hood,
|
|
11529
13222
|
* making it compatible with other OTel-instrumented libraries.
|
|
11530
13223
|
* - **Baggage Security**: When `asBaggage=true`, attribute values are added to HTTP
|
|
@@ -11534,6 +13227,6 @@ interface PropagateAttributesParams {
|
|
|
11534
13227
|
* @public
|
|
11535
13228
|
*/
|
|
11536
13229
|
declare function propagateAttributes<A extends unknown[], F extends (...args: A) => ReturnType<F>>(params: PropagateAttributesParams, fn: F): ReturnType<F>;
|
|
11537
|
-
declare function getPropagatedAttributesFromContext(context: Context): Record<string, string | string[]>;
|
|
13230
|
+
declare function getPropagatedAttributesFromContext(context: Context): Record<string, string | string[] | number>;
|
|
11538
13231
|
|
|
11539
|
-
export { AccessDeniedError$1 as AccessDeniedError, type AnnotationQueue, type AnnotationQueueAssignmentRequest, type AnnotationQueueItem, AnnotationQueueObjectType, AnnotationQueueStatus, type ApiKeyDeletionResponse, type ApiKeyList, type ApiKeyResponse, type ApiKeySummary, type AuthenticationScheme, type BaseEvent, type BasePrompt, type BaseScore, type BaseScoreV1, type BaseScoreV3, BlobStorageExportFieldGroup, BlobStorageExportFrequency, BlobStorageExportMode, BlobStorageExportSource, type BlobStorageIntegrationDeletionResponse, BlobStorageIntegrationFileType, type BlobStorageIntegrationResponse, type BlobStorageIntegrationStatusResponse, BlobStorageIntegrationType, type BlobStorageIntegrationsResponse, BlobStorageSyncStatus, type BooleanScore, type BooleanScoreV1, type BooleanScoreV3, type BulkConfig, type CategoricalScore, type CategoricalScoreV1, type CategoricalScoreV3, type ChatMessage, ChatMessageType, type ChatMessageWithPlaceholders, type ChatPrompt, type Comment, CommentObjectType, type ConfigCategory, type CorrectionScore, type CorrectionScoreV3, type CreateAnnotationQueueAssignmentResponse, type CreateAnnotationQueueItemRequest, type CreateAnnotationQueueRequest, type CreateApiKeyRequest, type CreateBlobStorageIntegrationRequest, type CreateChatPromptRequest, CreateChatPromptType, type CreateCommentRequest, type CreateCommentResponse, type CreateDatasetItemRequest, type CreateDatasetRequest, type CreateDatasetRunItemRequest, type CreateEventBody, type CreateEventEvent, type CreateGenerationBody, type CreateGenerationEvent, type CreateModelRequest, type CreateObservationEvent, type CreateProjectRequest, type CreatePromptRequest, type CreateScoreConfigRequest, type CreateScoreValue, type CreateSpanBody, type CreateSpanEvent, type CreateTextPromptRequest, CreateTextPromptType, type CreateUserRequest, type Dataset, type DatasetItem, type DatasetItemMediaReference, DatasetItemMediaReferenceField, type DatasetItemMediaReferenceMedia, type DatasetRun, type DatasetRunItem, type DatasetRunWithItems, DatasetStatus, type DeleteAnnotationQueueAssignmentResponse, type DeleteAnnotationQueueItemResponse, type DeleteDatasetItemResponse, type DeleteDatasetRunResponse, type DeleteLlmConnectionResponse, type DeleteMembershipRequest, type DeletePromptRequest, type DeleteTraceResponse, type DeleteTracesRequest, type EmptyResponse, Error$1 as Error, type FilterConfig, type GetAnnotationQueueItemsRequest, type GetAnnotationQueuesRequest, type GetCommentsRequest, type GetCommentsResponse, type GetDatasetItemsRequest, type GetDatasetRunsRequest, type GetDatasetsRequest, type GetLlmConnectionsRequest, type GetMediaResponse, type GetMediaUploadUrlRequest, type GetMediaUploadUrlResponse, type GetMetricsV2Request, type GetModelsRequest, type GetObservationsV2Request, type GetPromptRequest, type GetScoreConfigsRequest, type GetScoresRequest, type GetScoresResponse, GetScoresResponseData, type GetScoresResponseDataBoolean, type GetScoresResponseDataCategorical, type GetScoresResponseDataCorrection, type GetScoresResponseDataNumeric, type GetScoresResponseDataText, type GetScoresResponseTraceData, type GetScoresV3Meta, type GetScoresV3Request, type GetScoresV3Response, type GetSessionsRequest, type GetTraceRequest, type GetTracesRequest, type HealthResponse, type IngestionError, IngestionEvent, type IngestionRequest, type IngestionResponse, type IngestionSuccess, type IngestionUsage, LANGFUSE_SDK_EXPERIMENT_ENVIRONMENT, LANGFUSE_SDK_NAME, LANGFUSE_SDK_VERSION, LANGFUSE_TRACER_NAME, LANGFUSE_TRACE_ID_BAGGAGE_KEY, LangfuseAPIClient, LangfuseAPIError, LangfuseAPITimeoutError, LangfuseMedia, type LangfuseMediaParams, LangfuseMediaReference, type LangfuseMediaReferenceParams, LangfuseOtelContextKeys, LangfuseOtelSpanAttributes, type ListDatasetRunItemsRequest, type ListPromptsMetaRequest, type ListUsersRequest, LlmAdapter, type LlmConnection, LogLevel, Logger, type LoggerConfig, type MapValue, MediaContentType, type MembershipDeletionResponse, type MembershipRequest, type MembershipResponse, MembershipRole, type MembershipsResponse, MethodNotAllowedError$1 as MethodNotAllowedError, type MetricsV2Response, type Model, type ModelPrice, ModelUsageUnit, NotFoundError$1 as NotFoundError, type NumericScore, type NumericScoreV1, type NumericScoreV3, type Observation, type ObservationBody, ObservationLevel, ObservationType, type ObservationV2, type ObservationsV2Meta, type ObservationsV2Response, type ObservationsView, type OpenAiCompletionUsageSchema, type OpenAiResponseUsageSchema, type OpenAiUsage, type OptionalObservationBody, type Organization, type OrganizationApiKey, type OrganizationApiKeysResponse, type OrganizationProject, type OrganizationProjectsResponse, type OtelAttribute, type OtelAttributeValue, type OtelResource, type OtelResourceSpan, type OtelScope, type OtelScopeSpan, type OtelSpan, type OtelTraceRequest, type OtelTraceResponse, type PaginatedAnnotationQueueItems, type PaginatedAnnotationQueues, type PaginatedDatasetItems, type PaginatedDatasetRunItems, type PaginatedDatasetRuns, type PaginatedDatasets, type PaginatedLlmConnections, type PaginatedModels, type PaginatedSessions, type ParsedMediaReference, type PatchMediaBody, type PlaceholderMessage, PlaceholderMessageType, type PricingTier, type PricingTierCondition, type PricingTierInput, PricingTierOperator, type Project, type ProjectDeletionResponse, type Projects$1 as Projects, Prompt, type PromptMeta, type PromptMetaListResponse, PromptType, type PropagateAttributesParams, type ResourceMeta, type ResourceType, type ResourceTypesResponse, type SchemaExtension, type SchemaResource, type SchemasResponse, type ScimEmail, type ScimFeatureSupport, type ScimName, type ScimUser, type ScimUsersListResponse, Score, type ScoreBody, type ScoreConfig, ScoreConfigDataType, type ScoreConfigs$1 as ScoreConfigs, ScoreDataType, type ScoreEvent, ScoreSource, type ScoreSubjectExperimentV3, type ScoreSubjectObservationV3, type ScoreSubjectSessionV3, type ScoreSubjectTraceV3, ScoreSubjectV3, ScoreV1$1 as ScoreV1, ScoreV3, type SdkLogBody, type SdkLogEvent, type ServiceProviderConfig, ServiceUnavailableError, type Session, type SessionWithTraces, type Sort, type TextPrompt, type TextScore, type TextScoreV1, type TextScoreV3, type Trace$1 as Trace, type TraceBody, type TraceEvent, type TraceWithDetails, type TraceWithFullDetails, type Traces, UnauthorizedError$1 as UnauthorizedError, type UpdateAnnotationQueueItemRequest, type UpdateEventBody, type UpdateGenerationBody, type UpdateGenerationEvent, type UpdateObservationEvent, type UpdateProjectRequest, type UpdatePromptRequest, type UpdateScoreConfigRequest, type UpdateSpanBody, type UpdateSpanEvent, type UploadMediaParams, type UpsertLlmConnectionRequest, type Usage, type UsageDetails, type UserMeta, index$
|
|
13232
|
+
export { AccessDeniedError$1 as AccessDeniedError, type AnnotationQueue, type AnnotationQueueAssignmentRequest, type AnnotationQueueItem, AnnotationQueueObjectType, AnnotationQueueStatus, type ApiKeyDeletionResponse, type ApiKeyList, type ApiKeyResponse, type ApiKeySummary, type AuthenticationScheme, type BaseEvent, type BasePrompt, type BaseScore, type BaseScoreV1, type BaseScoreV3, BlobStorageExportFieldGroup, BlobStorageExportFrequency, BlobStorageExportMode, BlobStorageExportSource, type BlobStorageIntegrationDeletionResponse, BlobStorageIntegrationFileType, BlobStorageIntegrationFileTypeResponse, type BlobStorageIntegrationResponse, type BlobStorageIntegrationStatusResponse, BlobStorageIntegrationType, type BlobStorageIntegrationsResponse, BlobStorageSyncStatus, type BooleanScore, type BooleanScoreV1, type BooleanScoreV3, type BulkConfig, type CategoricalScore, type CategoricalScoreV1, type CategoricalScoreV3, type ChatMessage, ChatMessageType, type ChatMessageWithPlaceholders, type ChatPrompt, type Comment, CommentObjectType, type ConfigCategory, type CorrectionScore, type CorrectionScoreV3, type CreateAnnotationQueueAssignmentResponse, type CreateAnnotationQueueItemRequest, type CreateAnnotationQueueRequest, type CreateApiKeyRequest, type CreateBlobStorageIntegrationRequest, type CreateChatPromptRequest, CreateChatPromptType, type CreateCommentRequest, type CreateCommentResponse, type CreateDatasetItemRequest, type CreateDatasetRequest, type CreateDatasetRunItemRequest, type CreateEventBody, type CreateEventEvent, type CreateGenerationBody, type CreateGenerationEvent, type CreateModelRequest, type CreateObservationEvent, type CreateProjectRequest, type CreatePromptRequest, type CreateScoreConfigRequest, type CreateScoreRequest, type CreateScoreResponse, CreateScoreSource, type CreateScoreValue, type CreateSpanBody, type CreateSpanEvent, type CreateTextPromptRequest, CreateTextPromptType, type CreateUserRequest, type Dataset, type DatasetItem, type DatasetItemMediaReference, DatasetItemMediaReferenceField, type DatasetItemMediaReferenceMedia, type DatasetRun, type DatasetRunItem, type DatasetRunWithItems, DatasetStatus, type DeleteAnnotationQueueAssignmentResponse, type DeleteAnnotationQueueItemResponse, type DeleteDatasetItemResponse, type DeleteDatasetRunResponse, type DeleteLlmConnectionResponse, type DeleteMembershipRequest, type DeletePromptRequest, type DeleteTraceResponse, type DeleteTracesRequest, type Deprecation, type EmptyResponse, Error$1 as Error, type Experiment, type ExperimentItem, type ExperimentItemsResponse, type ExperimentsResponse, type ExperimentsResponseMeta, FeedbackNotConfiguredError, FeedbackTargetType, type FilterConfig, type GetAnnotationQueueItemsRequest, type GetAnnotationQueuesRequest, type GetCommentsRequest, type GetCommentsResponse, type GetDatasetItemsRequest, type GetDatasetRunsRequest, type GetDatasetsRequest, type GetLlmConnectionsRequest, type GetMediaResponse, type GetMediaUploadUrlRequest, type GetMediaUploadUrlResponse, type GetMetricsV2Request, type GetModelsRequest, type GetObservationsV2Request, type GetPromptRequest, type GetScoreConfigsRequest, type GetScoresRequest, type GetScoresResponse, GetScoresResponseData, type GetScoresResponseDataBoolean, type GetScoresResponseDataCategorical, type GetScoresResponseDataCorrection, type GetScoresResponseDataNumeric, type GetScoresResponseDataText, type GetScoresResponseTraceData, type GetScoresV3Meta, type GetScoresV3Request, type GetScoresV3Response, type GetSessionsRequest, type GetTraceRequest, type GetTracesRequest, type HealthResponse, type IngestionError, IngestionEvent, type IngestionRequest, type IngestionResponse, type IngestionSuccess, type IngestionUsage, LANGFUSE_SDK_EXPERIMENT_ENVIRONMENT, LANGFUSE_SDK_NAME, LANGFUSE_SDK_VERSION, LANGFUSE_TRACER_NAME, LANGFUSE_TRACE_ID_BAGGAGE_KEY, LangfuseAPIClient, LangfuseAPIError, LangfuseAPITimeoutError, LangfuseMedia, type LangfuseMediaParams, LangfuseMediaReference, type LangfuseMediaReferenceParams, LangfuseOtelContextKeys, LangfuseOtelSpanAttributes, type ListDatasetRunItemsRequest, type ListExperimentItemsRequest, type ListExperimentsRequest, type ListPromptsMetaRequest, type ListUsersRequest, LlmAdapter, type LlmConnection, LogLevel, Logger, type LoggerConfig, type MapValue, MediaContentType, type MembershipDeletionResponse, type MembershipRequest, type MembershipResponse, MembershipRole, type MembershipsResponse, MethodNotAllowedError$1 as MethodNotAllowedError, type MetricsV2Response, type Model, type ModelPrice, ModelUsageUnit, NotFoundError$1 as NotFoundError, type NumericScore, type NumericScoreV1, type NumericScoreV3, type Observation, type ObservationBody, ObservationLevel, ObservationType, type ObservationV2, type ObservationsV2Meta, type ObservationsV2Response, type ObservationsView, type ObservationsViewSingle, type OpenAiCompletionUsageSchema, type OpenAiResponseUsageSchema, type OpenAiUsage, type OptionalObservationBody, type Organization, type OrganizationApiKey, type OrganizationApiKeysResponse, type OrganizationProject, type OrganizationProjectsResponse, type OtelAttribute, type OtelAttributeValue, type OtelResource, type OtelResourceSpan, type OtelScope, type OtelScopeSpan, type OtelSpan, type OtelTraceRequest, type OtelTraceResponse, type PaginatedAnnotationQueueItems, type PaginatedAnnotationQueues, type PaginatedDatasetItems, type PaginatedDatasetRunItems, type PaginatedDatasetRuns, type PaginatedDatasets, type PaginatedLlmConnections, type PaginatedModels, type PaginatedSessions, type ParsedMediaReference, type PatchMediaBody, type PlaceholderMessage, PlaceholderMessageType, type PricingTier, type PricingTierCondition, type PricingTierInput, PricingTierOperator, type Project, type ProjectDeletionResponse, type Projects$1 as Projects, Prompt, type PromptMeta, type PromptMetaListResponse, PromptType, type PropagateAttributesParams, type PropagatedPromptInput, type ResourceMeta, type ResourceType, type ResourceTypesResponse, type SchemaExtension, type SchemaResource, type SchemasResponse, type ScimEmail, type ScimFeatureSupport, type ScimName, type ScimUser, type ScimUsersListResponse, Score, type ScoreBody, type ScoreConfig, ScoreConfigDataType, type ScoreConfigs$1 as ScoreConfigs, ScoreDataType, type ScoreEvent, ScoreSource, type ScoreSubjectExperimentV3, type ScoreSubjectObservationV3, type ScoreSubjectSessionV3, type ScoreSubjectTraceV3, ScoreSubjectV3, ScoreV1$1 as ScoreV1, ScoreV3, type SdkLogBody, type SdkLogEvent, type ServiceProviderConfig, ServiceUnavailableError, type Session, type SessionWithTraces, type Sort, type SubmitFeedbackRequest, type SubmitFeedbackResponse, type TextPrompt, type TextScore, type TextScoreV1, type TextScoreV3, type Trace$1 as Trace, type TraceBody, type TraceEvent, type TraceWithDetails, type TraceWithFullDetails, type Traces, UnauthorizedError$1 as UnauthorizedError, type UpdateAnnotationQueueItemRequest, type UpdateEventBody, type UpdateGenerationBody, type UpdateGenerationEvent, type UpdateObservationEvent, type UpdateProjectRequest, type UpdatePromptRequest, type UpdateScoreConfigRequest, type UpdateSpanBody, type UpdateSpanEvent, type UploadMediaParams, type UpsertLlmConnectionRequest, type Usage, type UsageDetails, type UserMeta, index$D as annotationQueues, base64Decode, base64Encode, base64ToBytes, index$C as blobStorageIntegrations, bytesToBase64, index$B as comments, index$A as commons, configureGlobalLogger, createExperimentId, createExperimentItemId, createLogger, index$z as datasetItems, index$y as datasetRunItems, index$x as datasets, index$w as experiments, index$v as feedback, generateUUID, getEnv, getGlobalLogger, getLangfuseTraceIdFromBaggage, getPropagatedAttributesFromContext, index$u as health, index$t as ingestion, index$p as legacy, index$o as llmConnections, LoggerSingleton as logger, index$n as media, index$m as metrics, index$l as models, index$k as observations, index$j as opentelemetry, index$i as organizations, index$h as projects, index as promptVersion, index$g as prompts, propagateAttributes, resetGlobalLogger, safeSetTimeout, index$f as scim, index$e as scoreConfigs, index$c as scores, index$d as scoresV3, serializeValue, index$b as sessions, setLangfuseTraceIdInBaggage, index$a as trace, index$3 as unstable, uploadMedia, index$1 as utils };
|