@langfuse/core 5.0.0-beta.1 → 5.0.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/dist/index.cjs +782 -767
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1152 -1114
- package/dist/index.d.ts +1152 -1114
- package/dist/index.mjs +780 -763
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -390,23 +390,23 @@ interface GetAnnotationQueueItemsRequest {
|
|
|
390
390
|
limit?: number;
|
|
391
391
|
}
|
|
392
392
|
|
|
393
|
-
type index$
|
|
394
|
-
type index$
|
|
395
|
-
type index$
|
|
396
|
-
declare const index$
|
|
397
|
-
declare const index$
|
|
398
|
-
type index$
|
|
399
|
-
type index$
|
|
400
|
-
type index$
|
|
401
|
-
type index$
|
|
402
|
-
type index$
|
|
403
|
-
type index$
|
|
404
|
-
type index$
|
|
405
|
-
type index$
|
|
406
|
-
type index$
|
|
407
|
-
type index$
|
|
408
|
-
declare namespace index$
|
|
409
|
-
export { type index$
|
|
393
|
+
type index$t_AnnotationQueue = AnnotationQueue;
|
|
394
|
+
type index$t_AnnotationQueueAssignmentRequest = AnnotationQueueAssignmentRequest;
|
|
395
|
+
type index$t_AnnotationQueueItem = AnnotationQueueItem;
|
|
396
|
+
declare const index$t_AnnotationQueueObjectType: typeof AnnotationQueueObjectType;
|
|
397
|
+
declare const index$t_AnnotationQueueStatus: typeof AnnotationQueueStatus;
|
|
398
|
+
type index$t_CreateAnnotationQueueAssignmentResponse = CreateAnnotationQueueAssignmentResponse;
|
|
399
|
+
type index$t_CreateAnnotationQueueItemRequest = CreateAnnotationQueueItemRequest;
|
|
400
|
+
type index$t_CreateAnnotationQueueRequest = CreateAnnotationQueueRequest;
|
|
401
|
+
type index$t_DeleteAnnotationQueueAssignmentResponse = DeleteAnnotationQueueAssignmentResponse;
|
|
402
|
+
type index$t_DeleteAnnotationQueueItemResponse = DeleteAnnotationQueueItemResponse;
|
|
403
|
+
type index$t_GetAnnotationQueueItemsRequest = GetAnnotationQueueItemsRequest;
|
|
404
|
+
type index$t_GetAnnotationQueuesRequest = GetAnnotationQueuesRequest;
|
|
405
|
+
type index$t_PaginatedAnnotationQueueItems = PaginatedAnnotationQueueItems;
|
|
406
|
+
type index$t_PaginatedAnnotationQueues = PaginatedAnnotationQueues;
|
|
407
|
+
type index$t_UpdateAnnotationQueueItemRequest = UpdateAnnotationQueueItemRequest;
|
|
408
|
+
declare namespace index$t {
|
|
409
|
+
export { type index$t_AnnotationQueue as AnnotationQueue, type index$t_AnnotationQueueAssignmentRequest as AnnotationQueueAssignmentRequest, type index$t_AnnotationQueueItem as AnnotationQueueItem, index$t_AnnotationQueueObjectType as AnnotationQueueObjectType, index$t_AnnotationQueueStatus as AnnotationQueueStatus, type index$t_CreateAnnotationQueueAssignmentResponse as CreateAnnotationQueueAssignmentResponse, type index$t_CreateAnnotationQueueItemRequest as CreateAnnotationQueueItemRequest, type index$t_CreateAnnotationQueueRequest as CreateAnnotationQueueRequest, type index$t_DeleteAnnotationQueueAssignmentResponse as DeleteAnnotationQueueAssignmentResponse, type index$t_DeleteAnnotationQueueItemResponse as DeleteAnnotationQueueItemResponse, type index$t_GetAnnotationQueueItemsRequest as GetAnnotationQueueItemsRequest, type index$t_GetAnnotationQueuesRequest as GetAnnotationQueuesRequest, type index$t_PaginatedAnnotationQueueItems as PaginatedAnnotationQueueItems, type index$t_PaginatedAnnotationQueues as PaginatedAnnotationQueues, type index$t_UpdateAnnotationQueueItemRequest as UpdateAnnotationQueueItemRequest };
|
|
410
410
|
}
|
|
411
411
|
|
|
412
412
|
/**
|
|
@@ -520,16 +520,16 @@ interface BlobStorageIntegrationDeletionResponse {
|
|
|
520
520
|
message: string;
|
|
521
521
|
}
|
|
522
522
|
|
|
523
|
-
declare const index$
|
|
524
|
-
declare const index$
|
|
525
|
-
type index$
|
|
526
|
-
declare const index$
|
|
527
|
-
type index$
|
|
528
|
-
declare const index$
|
|
529
|
-
type index$
|
|
530
|
-
type index$
|
|
531
|
-
declare namespace index$
|
|
532
|
-
export { index$
|
|
523
|
+
declare const index$s_BlobStorageExportFrequency: typeof BlobStorageExportFrequency;
|
|
524
|
+
declare const index$s_BlobStorageExportMode: typeof BlobStorageExportMode;
|
|
525
|
+
type index$s_BlobStorageIntegrationDeletionResponse = BlobStorageIntegrationDeletionResponse;
|
|
526
|
+
declare const index$s_BlobStorageIntegrationFileType: typeof BlobStorageIntegrationFileType;
|
|
527
|
+
type index$s_BlobStorageIntegrationResponse = BlobStorageIntegrationResponse;
|
|
528
|
+
declare const index$s_BlobStorageIntegrationType: typeof BlobStorageIntegrationType;
|
|
529
|
+
type index$s_BlobStorageIntegrationsResponse = BlobStorageIntegrationsResponse;
|
|
530
|
+
type index$s_CreateBlobStorageIntegrationRequest = CreateBlobStorageIntegrationRequest;
|
|
531
|
+
declare namespace index$s {
|
|
532
|
+
export { index$s_BlobStorageExportFrequency as BlobStorageExportFrequency, index$s_BlobStorageExportMode as BlobStorageExportMode, type index$s_BlobStorageIntegrationDeletionResponse as BlobStorageIntegrationDeletionResponse, index$s_BlobStorageIntegrationFileType as BlobStorageIntegrationFileType, type index$s_BlobStorageIntegrationResponse as BlobStorageIntegrationResponse, index$s_BlobStorageIntegrationType as BlobStorageIntegrationType, type index$s_BlobStorageIntegrationsResponse as BlobStorageIntegrationsResponse, type index$s_CreateBlobStorageIntegrationRequest as CreateBlobStorageIntegrationRequest };
|
|
533
533
|
}
|
|
534
534
|
|
|
535
535
|
/**
|
|
@@ -585,12 +585,12 @@ interface GetCommentsRequest {
|
|
|
585
585
|
authorUserId?: string;
|
|
586
586
|
}
|
|
587
587
|
|
|
588
|
-
type index$
|
|
589
|
-
type index$
|
|
590
|
-
type index$
|
|
591
|
-
type index$
|
|
592
|
-
declare namespace index$
|
|
593
|
-
export type { index$
|
|
588
|
+
type index$r_CreateCommentRequest = CreateCommentRequest;
|
|
589
|
+
type index$r_CreateCommentResponse = CreateCommentResponse;
|
|
590
|
+
type index$r_GetCommentsRequest = GetCommentsRequest;
|
|
591
|
+
type index$r_GetCommentsResponse = GetCommentsResponse;
|
|
592
|
+
declare namespace index$r {
|
|
593
|
+
export type { index$r_CreateCommentRequest as CreateCommentRequest, index$r_CreateCommentResponse as CreateCommentResponse, index$r_GetCommentsRequest as GetCommentsRequest, index$r_GetCommentsResponse as GetCommentsResponse };
|
|
594
594
|
}
|
|
595
595
|
|
|
596
596
|
/**
|
|
@@ -656,7 +656,7 @@ interface TraceWithFullDetails extends Trace$1 {
|
|
|
656
656
|
/** List of observations */
|
|
657
657
|
observations: ObservationsView[];
|
|
658
658
|
/** List of scores */
|
|
659
|
-
scores: ScoreV1[];
|
|
659
|
+
scores: ScoreV1$1[];
|
|
660
660
|
}
|
|
661
661
|
|
|
662
662
|
/**
|
|
@@ -955,17 +955,17 @@ interface CategoricalScoreV1 extends BaseScoreV1 {
|
|
|
955
955
|
* This file was auto-generated by Fern from our API Definition.
|
|
956
956
|
*/
|
|
957
957
|
|
|
958
|
-
type ScoreV1 =
|
|
958
|
+
type ScoreV1$1 =
|
|
959
959
|
/**
|
|
960
960
|
* Score with NUMERIC data type */
|
|
961
|
-
ScoreV1.Numeric
|
|
961
|
+
ScoreV1$1.Numeric
|
|
962
962
|
/**
|
|
963
963
|
* Score with CATEGORICAL data type */
|
|
964
|
-
| ScoreV1.Categorical
|
|
964
|
+
| ScoreV1$1.Categorical
|
|
965
965
|
/**
|
|
966
966
|
* Score with BOOLEAN data type */
|
|
967
|
-
| ScoreV1.Boolean;
|
|
968
|
-
declare namespace ScoreV1 {
|
|
967
|
+
| ScoreV1$1.Boolean;
|
|
968
|
+
declare namespace ScoreV1$1 {
|
|
969
969
|
interface Numeric extends NumericScoreV1 {
|
|
970
970
|
dataType: "NUMERIC";
|
|
971
971
|
}
|
|
@@ -1056,20 +1056,20 @@ interface CorrectionScore extends BaseScore {
|
|
|
1056
1056
|
* This file was auto-generated by Fern from our API Definition.
|
|
1057
1057
|
*/
|
|
1058
1058
|
|
|
1059
|
-
type Score
|
|
1059
|
+
type Score =
|
|
1060
1060
|
/**
|
|
1061
1061
|
* Score with NUMERIC data type */
|
|
1062
|
-
Score
|
|
1062
|
+
Score.Numeric
|
|
1063
1063
|
/**
|
|
1064
1064
|
* Score with CATEGORICAL data type */
|
|
1065
|
-
| Score
|
|
1065
|
+
| Score.Categorical
|
|
1066
1066
|
/**
|
|
1067
1067
|
* Score with BOOLEAN data type */
|
|
1068
|
-
| Score
|
|
1068
|
+
| Score.Boolean
|
|
1069
1069
|
/**
|
|
1070
1070
|
* Score with CORRECTION data type */
|
|
1071
|
-
| Score
|
|
1072
|
-
declare namespace Score
|
|
1071
|
+
| Score.Correction;
|
|
1072
|
+
declare namespace Score {
|
|
1073
1073
|
interface Numeric extends NumericScore {
|
|
1074
1074
|
dataType: "NUMERIC";
|
|
1075
1075
|
}
|
|
@@ -1679,57 +1679,57 @@ declare class MethodNotAllowedError extends LangfuseAPIError {
|
|
|
1679
1679
|
constructor(body?: unknown, rawResponse?: RawResponse);
|
|
1680
1680
|
}
|
|
1681
1681
|
|
|
1682
|
-
type index$
|
|
1683
|
-
declare const index$
|
|
1684
|
-
type index$
|
|
1685
|
-
type index$
|
|
1686
|
-
type index$
|
|
1687
|
-
type index$
|
|
1688
|
-
type index$
|
|
1689
|
-
type index$
|
|
1690
|
-
type index$
|
|
1691
|
-
declare const index$
|
|
1692
|
-
type index$
|
|
1693
|
-
type index$
|
|
1694
|
-
type index$
|
|
1695
|
-
type index$
|
|
1696
|
-
type index$
|
|
1697
|
-
type index$
|
|
1698
|
-
type index$
|
|
1699
|
-
type index$
|
|
1700
|
-
declare const index$
|
|
1701
|
-
type index$
|
|
1702
|
-
type index$
|
|
1703
|
-
declare const index$
|
|
1704
|
-
type index$
|
|
1705
|
-
type index$
|
|
1706
|
-
declare const index$
|
|
1707
|
-
type index$
|
|
1708
|
-
declare const index$
|
|
1709
|
-
type index$
|
|
1710
|
-
type index$
|
|
1711
|
-
type index$
|
|
1712
|
-
declare const index$
|
|
1713
|
-
type index$
|
|
1714
|
-
type index$
|
|
1715
|
-
type index$
|
|
1716
|
-
type index$
|
|
1717
|
-
type index$
|
|
1718
|
-
declare const index$
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
declare const index$
|
|
1722
|
-
declare const index$
|
|
1723
|
-
declare const index$
|
|
1724
|
-
type index$
|
|
1725
|
-
type index$
|
|
1726
|
-
type index$
|
|
1727
|
-
type index$
|
|
1728
|
-
type index$
|
|
1729
|
-
declare const index$
|
|
1730
|
-
type index$
|
|
1731
|
-
declare namespace index$
|
|
1732
|
-
export { index$
|
|
1682
|
+
type index$q_AccessDeniedError = AccessDeniedError;
|
|
1683
|
+
declare const index$q_AccessDeniedError: typeof AccessDeniedError;
|
|
1684
|
+
type index$q_BaseScore = BaseScore;
|
|
1685
|
+
type index$q_BaseScoreV1 = BaseScoreV1;
|
|
1686
|
+
type index$q_BooleanScore = BooleanScore;
|
|
1687
|
+
type index$q_BooleanScoreV1 = BooleanScoreV1;
|
|
1688
|
+
type index$q_CategoricalScore = CategoricalScore;
|
|
1689
|
+
type index$q_CategoricalScoreV1 = CategoricalScoreV1;
|
|
1690
|
+
type index$q_Comment = Comment;
|
|
1691
|
+
declare const index$q_CommentObjectType: typeof CommentObjectType;
|
|
1692
|
+
type index$q_ConfigCategory = ConfigCategory;
|
|
1693
|
+
type index$q_CorrectionScore = CorrectionScore;
|
|
1694
|
+
type index$q_CreateScoreValue = CreateScoreValue;
|
|
1695
|
+
type index$q_Dataset = Dataset;
|
|
1696
|
+
type index$q_DatasetItem = DatasetItem;
|
|
1697
|
+
type index$q_DatasetRun = DatasetRun;
|
|
1698
|
+
type index$q_DatasetRunItem = DatasetRunItem;
|
|
1699
|
+
type index$q_DatasetRunWithItems = DatasetRunWithItems;
|
|
1700
|
+
declare const index$q_DatasetStatus: typeof DatasetStatus;
|
|
1701
|
+
type index$q_MapValue = MapValue;
|
|
1702
|
+
type index$q_MethodNotAllowedError = MethodNotAllowedError;
|
|
1703
|
+
declare const index$q_MethodNotAllowedError: typeof MethodNotAllowedError;
|
|
1704
|
+
type index$q_Model = Model;
|
|
1705
|
+
type index$q_ModelPrice = ModelPrice;
|
|
1706
|
+
declare const index$q_ModelUsageUnit: typeof ModelUsageUnit;
|
|
1707
|
+
type index$q_NotFoundError = NotFoundError;
|
|
1708
|
+
declare const index$q_NotFoundError: typeof NotFoundError;
|
|
1709
|
+
type index$q_NumericScore = NumericScore;
|
|
1710
|
+
type index$q_NumericScoreV1 = NumericScoreV1;
|
|
1711
|
+
type index$q_Observation = Observation;
|
|
1712
|
+
declare const index$q_ObservationLevel: typeof ObservationLevel;
|
|
1713
|
+
type index$q_ObservationV2 = ObservationV2;
|
|
1714
|
+
type index$q_ObservationsView = ObservationsView;
|
|
1715
|
+
type index$q_PricingTier = PricingTier;
|
|
1716
|
+
type index$q_PricingTierCondition = PricingTierCondition;
|
|
1717
|
+
type index$q_PricingTierInput = PricingTierInput;
|
|
1718
|
+
declare const index$q_PricingTierOperator: typeof PricingTierOperator;
|
|
1719
|
+
declare const index$q_Score: typeof Score;
|
|
1720
|
+
type index$q_ScoreConfig = ScoreConfig;
|
|
1721
|
+
declare const index$q_ScoreConfigDataType: typeof ScoreConfigDataType;
|
|
1722
|
+
declare const index$q_ScoreDataType: typeof ScoreDataType;
|
|
1723
|
+
declare const index$q_ScoreSource: typeof ScoreSource;
|
|
1724
|
+
type index$q_Session = Session;
|
|
1725
|
+
type index$q_SessionWithTraces = SessionWithTraces;
|
|
1726
|
+
type index$q_TraceWithDetails = TraceWithDetails;
|
|
1727
|
+
type index$q_TraceWithFullDetails = TraceWithFullDetails;
|
|
1728
|
+
type index$q_UnauthorizedError = UnauthorizedError;
|
|
1729
|
+
declare const index$q_UnauthorizedError: typeof UnauthorizedError;
|
|
1730
|
+
type index$q_Usage = Usage;
|
|
1731
|
+
declare namespace index$q {
|
|
1732
|
+
export { index$q_AccessDeniedError as AccessDeniedError, type index$q_BaseScore as BaseScore, type index$q_BaseScoreV1 as BaseScoreV1, type index$q_BooleanScore as BooleanScore, type index$q_BooleanScoreV1 as BooleanScoreV1, type index$q_CategoricalScore as CategoricalScore, type index$q_CategoricalScoreV1 as CategoricalScoreV1, type index$q_Comment as Comment, index$q_CommentObjectType as CommentObjectType, type index$q_ConfigCategory as ConfigCategory, type index$q_CorrectionScore as CorrectionScore, type index$q_CreateScoreValue as CreateScoreValue, type index$q_Dataset as Dataset, type index$q_DatasetItem as DatasetItem, type index$q_DatasetRun as DatasetRun, type index$q_DatasetRunItem as DatasetRunItem, type index$q_DatasetRunWithItems as DatasetRunWithItems, index$q_DatasetStatus as DatasetStatus, Error$1 as Error, type index$q_MapValue as MapValue, index$q_MethodNotAllowedError as MethodNotAllowedError, type index$q_Model as Model, type index$q_ModelPrice as ModelPrice, index$q_ModelUsageUnit as ModelUsageUnit, index$q_NotFoundError as NotFoundError, type index$q_NumericScore as NumericScore, type index$q_NumericScoreV1 as NumericScoreV1, type index$q_Observation as Observation, index$q_ObservationLevel as ObservationLevel, type index$q_ObservationV2 as ObservationV2, type index$q_ObservationsView as ObservationsView, type index$q_PricingTier as PricingTier, type index$q_PricingTierCondition as PricingTierCondition, type index$q_PricingTierInput as PricingTierInput, index$q_PricingTierOperator as PricingTierOperator, index$q_Score as Score, type index$q_ScoreConfig as ScoreConfig, index$q_ScoreConfigDataType as ScoreConfigDataType, index$q_ScoreDataType as ScoreDataType, index$q_ScoreSource as ScoreSource, ScoreV1$1 as ScoreV1, type index$q_Session as Session, type index$q_SessionWithTraces as SessionWithTraces, type Trace$1 as Trace, type index$q_TraceWithDetails as TraceWithDetails, type index$q_TraceWithFullDetails as TraceWithFullDetails, index$q_UnauthorizedError as UnauthorizedError, type index$q_Usage as Usage };
|
|
1733
1733
|
}
|
|
1734
1734
|
|
|
1735
1735
|
/**
|
|
@@ -1789,12 +1789,12 @@ interface GetDatasetItemsRequest {
|
|
|
1789
1789
|
limit?: number;
|
|
1790
1790
|
}
|
|
1791
1791
|
|
|
1792
|
-
type index$
|
|
1793
|
-
type index$
|
|
1794
|
-
type index$
|
|
1795
|
-
type index$
|
|
1796
|
-
declare namespace index$
|
|
1797
|
-
export type { index$
|
|
1792
|
+
type index$p_CreateDatasetItemRequest = CreateDatasetItemRequest;
|
|
1793
|
+
type index$p_DeleteDatasetItemResponse = DeleteDatasetItemResponse;
|
|
1794
|
+
type index$p_GetDatasetItemsRequest = GetDatasetItemsRequest;
|
|
1795
|
+
type index$p_PaginatedDatasetItems = PaginatedDatasetItems;
|
|
1796
|
+
declare namespace index$p {
|
|
1797
|
+
export type { index$p_CreateDatasetItemRequest as CreateDatasetItemRequest, index$p_DeleteDatasetItemResponse as DeleteDatasetItemResponse, index$p_GetDatasetItemsRequest as GetDatasetItemsRequest, index$p_PaginatedDatasetItems as PaginatedDatasetItems };
|
|
1798
1798
|
}
|
|
1799
1799
|
|
|
1800
1800
|
/**
|
|
@@ -1847,11 +1847,11 @@ interface ListDatasetRunItemsRequest {
|
|
|
1847
1847
|
limit?: number;
|
|
1848
1848
|
}
|
|
1849
1849
|
|
|
1850
|
-
type index$
|
|
1851
|
-
type index$
|
|
1852
|
-
type index$
|
|
1853
|
-
declare namespace index$
|
|
1854
|
-
export type { index$
|
|
1850
|
+
type index$o_CreateDatasetRunItemRequest = CreateDatasetRunItemRequest;
|
|
1851
|
+
type index$o_ListDatasetRunItemsRequest = ListDatasetRunItemsRequest;
|
|
1852
|
+
type index$o_PaginatedDatasetRunItems = PaginatedDatasetRunItems;
|
|
1853
|
+
declare namespace index$o {
|
|
1854
|
+
export type { index$o_CreateDatasetRunItemRequest as CreateDatasetRunItemRequest, index$o_ListDatasetRunItemsRequest as ListDatasetRunItemsRequest, index$o_PaginatedDatasetRunItems as PaginatedDatasetRunItems };
|
|
1855
1855
|
}
|
|
1856
1856
|
|
|
1857
1857
|
/**
|
|
@@ -1920,14 +1920,14 @@ interface GetDatasetRunsRequest {
|
|
|
1920
1920
|
limit?: number;
|
|
1921
1921
|
}
|
|
1922
1922
|
|
|
1923
|
-
type index$
|
|
1924
|
-
type index$
|
|
1925
|
-
type index$
|
|
1926
|
-
type index$
|
|
1927
|
-
type index$
|
|
1928
|
-
type index$
|
|
1929
|
-
declare namespace index$
|
|
1930
|
-
export type { index$
|
|
1923
|
+
type index$n_CreateDatasetRequest = CreateDatasetRequest;
|
|
1924
|
+
type index$n_DeleteDatasetRunResponse = DeleteDatasetRunResponse;
|
|
1925
|
+
type index$n_GetDatasetRunsRequest = GetDatasetRunsRequest;
|
|
1926
|
+
type index$n_GetDatasetsRequest = GetDatasetsRequest;
|
|
1927
|
+
type index$n_PaginatedDatasetRuns = PaginatedDatasetRuns;
|
|
1928
|
+
type index$n_PaginatedDatasets = PaginatedDatasets;
|
|
1929
|
+
declare namespace index$n {
|
|
1930
|
+
export type { index$n_CreateDatasetRequest as CreateDatasetRequest, index$n_DeleteDatasetRunResponse as DeleteDatasetRunResponse, index$n_GetDatasetRunsRequest as GetDatasetRunsRequest, index$n_GetDatasetsRequest as GetDatasetsRequest, index$n_PaginatedDatasetRuns as PaginatedDatasetRuns, index$n_PaginatedDatasets as PaginatedDatasets };
|
|
1931
1931
|
}
|
|
1932
1932
|
|
|
1933
1933
|
/**
|
|
@@ -1954,11 +1954,11 @@ declare class ServiceUnavailableError extends LangfuseAPIError {
|
|
|
1954
1954
|
constructor(rawResponse?: RawResponse);
|
|
1955
1955
|
}
|
|
1956
1956
|
|
|
1957
|
-
type index$
|
|
1958
|
-
type index$
|
|
1959
|
-
declare const index$
|
|
1960
|
-
declare namespace index$
|
|
1961
|
-
export { type index$
|
|
1957
|
+
type index$m_HealthResponse = HealthResponse;
|
|
1958
|
+
type index$m_ServiceUnavailableError = ServiceUnavailableError;
|
|
1959
|
+
declare const index$m_ServiceUnavailableError: typeof ServiceUnavailableError;
|
|
1960
|
+
declare namespace index$m {
|
|
1961
|
+
export { type index$m_HealthResponse as HealthResponse, index$m_ServiceUnavailableError as ServiceUnavailableError };
|
|
1962
1962
|
}
|
|
1963
1963
|
|
|
1964
1964
|
/**
|
|
@@ -2513,277 +2513,47 @@ interface IngestionRequest {
|
|
|
2513
2513
|
metadata?: unknown;
|
|
2514
2514
|
}
|
|
2515
2515
|
|
|
2516
|
-
type index$
|
|
2517
|
-
type index$
|
|
2518
|
-
type index$
|
|
2519
|
-
type index$
|
|
2520
|
-
type index$
|
|
2521
|
-
type index$
|
|
2522
|
-
type index$
|
|
2523
|
-
type index$
|
|
2524
|
-
type index$
|
|
2525
|
-
declare const index$
|
|
2526
|
-
type index$
|
|
2527
|
-
type index$
|
|
2528
|
-
type index$
|
|
2529
|
-
type index$
|
|
2530
|
-
type index$
|
|
2531
|
-
declare const index$
|
|
2532
|
-
type index$
|
|
2533
|
-
type index$
|
|
2534
|
-
type index$
|
|
2535
|
-
type index$
|
|
2536
|
-
type index$
|
|
2537
|
-
type index$
|
|
2538
|
-
type index$
|
|
2539
|
-
type index$
|
|
2540
|
-
type index$
|
|
2541
|
-
type index$
|
|
2542
|
-
type index$
|
|
2543
|
-
type index$
|
|
2544
|
-
type index$
|
|
2545
|
-
type index$
|
|
2546
|
-
type index$
|
|
2547
|
-
type index$
|
|
2548
|
-
type index$
|
|
2549
|
-
declare namespace index$
|
|
2550
|
-
export { type index$
|
|
2551
|
-
}
|
|
2552
|
-
|
|
2553
|
-
/**
|
|
2554
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2555
|
-
*/
|
|
2556
|
-
/**
|
|
2557
|
-
* LLM API connection configuration (secrets excluded)
|
|
2558
|
-
*/
|
|
2559
|
-
interface LlmConnection {
|
|
2560
|
-
id: string;
|
|
2561
|
-
/** Provider name (e.g., 'openai', 'my-gateway'). Must be unique in project, used for upserting. */
|
|
2562
|
-
provider: string;
|
|
2563
|
-
/** The adapter used to interface with the LLM */
|
|
2564
|
-
adapter: string;
|
|
2565
|
-
/** Masked version of the secret key for display purposes */
|
|
2566
|
-
displaySecretKey: string;
|
|
2567
|
-
/** Custom base URL for the LLM API */
|
|
2568
|
-
baseURL?: string;
|
|
2569
|
-
/** List of custom model names available for this connection */
|
|
2570
|
-
customModels: string[];
|
|
2571
|
-
/** Whether to include default models for this adapter */
|
|
2572
|
-
withDefaultModels: boolean;
|
|
2573
|
-
/** Keys of extra headers sent with requests (values excluded for security) */
|
|
2574
|
-
extraHeaderKeys: string[];
|
|
2575
|
-
/** Adapter-specific configuration. Required for Bedrock (`{"region":"us-east-1"}`), optional for VertexAI (`{"location":"us-central1"}`), not used by other adapters. */
|
|
2576
|
-
config?: Record<string, unknown>;
|
|
2577
|
-
createdAt: string;
|
|
2578
|
-
updatedAt: string;
|
|
2579
|
-
}
|
|
2580
|
-
|
|
2581
|
-
/**
|
|
2582
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2583
|
-
*/
|
|
2584
|
-
|
|
2585
|
-
interface PaginatedLlmConnections {
|
|
2586
|
-
data: LlmConnection[];
|
|
2587
|
-
meta: MetaResponse;
|
|
2588
|
-
}
|
|
2589
|
-
|
|
2590
|
-
/**
|
|
2591
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2592
|
-
*/
|
|
2593
|
-
|
|
2594
|
-
/**
|
|
2595
|
-
* Request to create or update an LLM connection (upsert)
|
|
2596
|
-
*/
|
|
2597
|
-
interface UpsertLlmConnectionRequest {
|
|
2598
|
-
/** Provider name (e.g., 'openai', 'my-gateway'). Must be unique in project, used for upserting. */
|
|
2599
|
-
provider: string;
|
|
2600
|
-
/** The adapter used to interface with the LLM */
|
|
2601
|
-
adapter: LlmAdapter;
|
|
2602
|
-
/** Secret key for the LLM API. */
|
|
2603
|
-
secretKey: string;
|
|
2604
|
-
/** Custom base URL for the LLM API */
|
|
2605
|
-
baseURL?: string;
|
|
2606
|
-
/** List of custom model names */
|
|
2607
|
-
customModels?: string[];
|
|
2608
|
-
/** Whether to include default models. Default is true. */
|
|
2609
|
-
withDefaultModels?: boolean;
|
|
2610
|
-
/** Extra headers to send with requests */
|
|
2611
|
-
extraHeaders?: Record<string, string>;
|
|
2612
|
-
/** Adapter-specific configuration. Validation rules: - **Bedrock**: Required. Must be `{"region": "<aws-region>"}` (e.g., `{"region":"us-east-1"}`) - **VertexAI**: Optional. If provided, must be `{"location": "<gcp-location>"}` (e.g., `{"location":"us-central1"}`) - **Other adapters**: Not supported. Omit this field or set to null. */
|
|
2613
|
-
config?: Record<string, unknown>;
|
|
2614
|
-
}
|
|
2615
|
-
|
|
2616
|
-
/**
|
|
2617
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2618
|
-
*/
|
|
2619
|
-
type LlmAdapter = "anthropic" | "openai" | "azure" | "bedrock" | "google-vertex-ai" | "google-ai-studio";
|
|
2620
|
-
declare const LlmAdapter: {
|
|
2621
|
-
readonly Anthropic: "anthropic";
|
|
2622
|
-
readonly OpenAi: "openai";
|
|
2623
|
-
readonly Azure: "azure";
|
|
2624
|
-
readonly Bedrock: "bedrock";
|
|
2625
|
-
readonly GoogleVertexAi: "google-vertex-ai";
|
|
2626
|
-
readonly GoogleAiStudio: "google-ai-studio";
|
|
2627
|
-
};
|
|
2628
|
-
|
|
2629
|
-
/**
|
|
2630
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2631
|
-
*/
|
|
2632
|
-
/**
|
|
2633
|
-
* @example
|
|
2634
|
-
* {}
|
|
2635
|
-
*/
|
|
2636
|
-
interface GetLlmConnectionsRequest {
|
|
2637
|
-
/** page number, starts at 1 */
|
|
2638
|
-
page?: number;
|
|
2639
|
-
/** limit of items per page */
|
|
2640
|
-
limit?: number;
|
|
2641
|
-
}
|
|
2642
|
-
|
|
2643
|
-
type index$j_GetLlmConnectionsRequest = GetLlmConnectionsRequest;
|
|
2644
|
-
declare const index$j_LlmAdapter: typeof LlmAdapter;
|
|
2645
|
-
type index$j_LlmConnection = LlmConnection;
|
|
2646
|
-
type index$j_PaginatedLlmConnections = PaginatedLlmConnections;
|
|
2647
|
-
type index$j_UpsertLlmConnectionRequest = UpsertLlmConnectionRequest;
|
|
2648
|
-
declare namespace index$j {
|
|
2649
|
-
export { type index$j_GetLlmConnectionsRequest as GetLlmConnectionsRequest, index$j_LlmAdapter as LlmAdapter, type index$j_LlmConnection as LlmConnection, type index$j_PaginatedLlmConnections as PaginatedLlmConnections, type index$j_UpsertLlmConnectionRequest as UpsertLlmConnectionRequest };
|
|
2650
|
-
}
|
|
2651
|
-
|
|
2652
|
-
/**
|
|
2653
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2654
|
-
*/
|
|
2655
|
-
interface GetMediaResponse {
|
|
2656
|
-
/** The unique langfuse identifier of a media record */
|
|
2657
|
-
mediaId: string;
|
|
2658
|
-
/** The MIME type of the media record */
|
|
2659
|
-
contentType: string;
|
|
2660
|
-
/** The size of the media record in bytes */
|
|
2661
|
-
contentLength: number;
|
|
2662
|
-
/** The date and time when the media record was uploaded */
|
|
2663
|
-
uploadedAt: string;
|
|
2664
|
-
/** The download URL of the media record */
|
|
2665
|
-
url: string;
|
|
2666
|
-
/** The expiry date and time of the media record download URL */
|
|
2667
|
-
urlExpiry: string;
|
|
2668
|
-
}
|
|
2669
|
-
|
|
2670
|
-
/**
|
|
2671
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2672
|
-
*/
|
|
2673
|
-
interface PatchMediaBody {
|
|
2674
|
-
/** The date and time when the media record was uploaded */
|
|
2675
|
-
uploadedAt: string;
|
|
2676
|
-
/** The HTTP status code of the upload */
|
|
2677
|
-
uploadHttpStatus: number;
|
|
2678
|
-
/** The HTTP error message of the upload */
|
|
2679
|
-
uploadHttpError?: string;
|
|
2680
|
-
/** The time in milliseconds it took to upload the media record */
|
|
2681
|
-
uploadTimeMs?: number;
|
|
2682
|
-
}
|
|
2683
|
-
|
|
2684
|
-
/**
|
|
2685
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2686
|
-
*/
|
|
2687
|
-
|
|
2688
|
-
interface GetMediaUploadUrlRequest {
|
|
2689
|
-
/** The trace ID associated with the media record */
|
|
2690
|
-
traceId: string;
|
|
2691
|
-
/** The observation ID associated with the media record. If the media record is associated directly with a trace, this will be null. */
|
|
2692
|
-
observationId?: string;
|
|
2693
|
-
contentType: MediaContentType;
|
|
2694
|
-
/** The size of the media record in bytes */
|
|
2695
|
-
contentLength: number;
|
|
2696
|
-
/** The SHA-256 hash of the media record */
|
|
2697
|
-
sha256Hash: string;
|
|
2698
|
-
/** The trace / observation field the media record is associated with. This can be one of `input`, `output`, `metadata` */
|
|
2699
|
-
field: string;
|
|
2700
|
-
}
|
|
2701
|
-
|
|
2702
|
-
/**
|
|
2703
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2704
|
-
*/
|
|
2705
|
-
interface GetMediaUploadUrlResponse {
|
|
2706
|
-
/** The presigned upload URL. If the asset is already uploaded, this will be null */
|
|
2707
|
-
uploadUrl?: string;
|
|
2708
|
-
/** The unique langfuse identifier of a media record */
|
|
2709
|
-
mediaId: string;
|
|
2710
|
-
}
|
|
2711
|
-
|
|
2712
|
-
/**
|
|
2713
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2714
|
-
*/
|
|
2715
|
-
/**
|
|
2716
|
-
* The MIME type of the media record
|
|
2717
|
-
*/
|
|
2718
|
-
type MediaContentType = "image/png" | "image/jpeg" | "image/jpg" | "image/webp" | "image/gif" | "image/svg+xml" | "image/tiff" | "image/bmp" | "image/avif" | "image/heic" | "audio/mpeg" | "audio/mp3" | "audio/wav" | "audio/ogg" | "audio/oga" | "audio/aac" | "audio/mp4" | "audio/flac" | "audio/opus" | "audio/webm" | "video/mp4" | "video/webm" | "video/ogg" | "video/mpeg" | "video/quicktime" | "video/x-msvideo" | "video/x-matroska" | "text/plain" | "text/html" | "text/css" | "text/csv" | "text/markdown" | "text/x-python" | "application/javascript" | "text/x-typescript" | "application/x-yaml" | "application/pdf" | "application/msword" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/zip" | "application/json" | "application/xml" | "application/octet-stream" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/rtf" | "application/x-ndjson" | "application/vnd.apache.parquet" | "application/gzip" | "application/x-tar" | "application/x-7z-compressed";
|
|
2719
|
-
declare const MediaContentType: {
|
|
2720
|
-
readonly ImagePng: "image/png";
|
|
2721
|
-
readonly ImageJpeg: "image/jpeg";
|
|
2722
|
-
readonly ImageJpg: "image/jpg";
|
|
2723
|
-
readonly ImageWebp: "image/webp";
|
|
2724
|
-
readonly ImageGif: "image/gif";
|
|
2725
|
-
readonly ImageSvgXml: "image/svg+xml";
|
|
2726
|
-
readonly ImageTiff: "image/tiff";
|
|
2727
|
-
readonly ImageBmp: "image/bmp";
|
|
2728
|
-
readonly ImageAvif: "image/avif";
|
|
2729
|
-
readonly ImageHeic: "image/heic";
|
|
2730
|
-
readonly AudioMpeg: "audio/mpeg";
|
|
2731
|
-
readonly AudioMp3: "audio/mp3";
|
|
2732
|
-
readonly AudioWav: "audio/wav";
|
|
2733
|
-
readonly AudioOgg: "audio/ogg";
|
|
2734
|
-
readonly AudioOga: "audio/oga";
|
|
2735
|
-
readonly AudioAac: "audio/aac";
|
|
2736
|
-
readonly AudioMp4: "audio/mp4";
|
|
2737
|
-
readonly AudioFlac: "audio/flac";
|
|
2738
|
-
readonly AudioOpus: "audio/opus";
|
|
2739
|
-
readonly AudioWebm: "audio/webm";
|
|
2740
|
-
readonly VideoMp4: "video/mp4";
|
|
2741
|
-
readonly VideoWebm: "video/webm";
|
|
2742
|
-
readonly VideoOgg: "video/ogg";
|
|
2743
|
-
readonly VideoMpeg: "video/mpeg";
|
|
2744
|
-
readonly VideoQuicktime: "video/quicktime";
|
|
2745
|
-
readonly VideoXMsvideo: "video/x-msvideo";
|
|
2746
|
-
readonly VideoXMatroska: "video/x-matroska";
|
|
2747
|
-
readonly TextPlain: "text/plain";
|
|
2748
|
-
readonly TextHtml: "text/html";
|
|
2749
|
-
readonly TextCss: "text/css";
|
|
2750
|
-
readonly TextCsv: "text/csv";
|
|
2751
|
-
readonly TextMarkdown: "text/markdown";
|
|
2752
|
-
readonly TextXPython: "text/x-python";
|
|
2753
|
-
readonly ApplicationJavascript: "application/javascript";
|
|
2754
|
-
readonly TextXTypescript: "text/x-typescript";
|
|
2755
|
-
readonly ApplicationXYaml: "application/x-yaml";
|
|
2756
|
-
readonly ApplicationPdf: "application/pdf";
|
|
2757
|
-
readonly ApplicationMsword: "application/msword";
|
|
2758
|
-
readonly ApplicationMsExcel: "application/vnd.ms-excel";
|
|
2759
|
-
readonly ApplicationOpenxmlSpreadsheet: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
|
|
2760
|
-
readonly ApplicationZip: "application/zip";
|
|
2761
|
-
readonly ApplicationJson: "application/json";
|
|
2762
|
-
readonly ApplicationXml: "application/xml";
|
|
2763
|
-
readonly ApplicationOctetStream: "application/octet-stream";
|
|
2764
|
-
readonly ApplicationOpenxmlWord: "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
|
|
2765
|
-
readonly ApplicationOpenxmlPresentation: "application/vnd.openxmlformats-officedocument.presentationml.presentation";
|
|
2766
|
-
readonly ApplicationRtf: "application/rtf";
|
|
2767
|
-
readonly ApplicationXNdjson: "application/x-ndjson";
|
|
2768
|
-
readonly ApplicationParquet: "application/vnd.apache.parquet";
|
|
2769
|
-
readonly ApplicationGzip: "application/gzip";
|
|
2770
|
-
readonly ApplicationXTar: "application/x-tar";
|
|
2771
|
-
readonly ApplicationX7ZCompressed: "application/x-7z-compressed";
|
|
2772
|
-
};
|
|
2773
|
-
|
|
2774
|
-
type index$i_GetMediaResponse = GetMediaResponse;
|
|
2775
|
-
type index$i_GetMediaUploadUrlRequest = GetMediaUploadUrlRequest;
|
|
2776
|
-
type index$i_GetMediaUploadUrlResponse = GetMediaUploadUrlResponse;
|
|
2777
|
-
declare const index$i_MediaContentType: typeof MediaContentType;
|
|
2778
|
-
type index$i_PatchMediaBody = PatchMediaBody;
|
|
2779
|
-
declare namespace index$i {
|
|
2780
|
-
export { type index$i_GetMediaResponse as GetMediaResponse, type index$i_GetMediaUploadUrlRequest as GetMediaUploadUrlRequest, type index$i_GetMediaUploadUrlResponse as GetMediaUploadUrlResponse, index$i_MediaContentType as MediaContentType, type index$i_PatchMediaBody as PatchMediaBody };
|
|
2516
|
+
type index$l_BaseEvent = BaseEvent;
|
|
2517
|
+
type index$l_CreateEventBody = CreateEventBody;
|
|
2518
|
+
type index$l_CreateEventEvent = CreateEventEvent;
|
|
2519
|
+
type index$l_CreateGenerationBody = CreateGenerationBody;
|
|
2520
|
+
type index$l_CreateGenerationEvent = CreateGenerationEvent;
|
|
2521
|
+
type index$l_CreateObservationEvent = CreateObservationEvent;
|
|
2522
|
+
type index$l_CreateSpanBody = CreateSpanBody;
|
|
2523
|
+
type index$l_CreateSpanEvent = CreateSpanEvent;
|
|
2524
|
+
type index$l_IngestionError = IngestionError;
|
|
2525
|
+
declare const index$l_IngestionEvent: typeof IngestionEvent;
|
|
2526
|
+
type index$l_IngestionRequest = IngestionRequest;
|
|
2527
|
+
type index$l_IngestionResponse = IngestionResponse;
|
|
2528
|
+
type index$l_IngestionSuccess = IngestionSuccess;
|
|
2529
|
+
type index$l_IngestionUsage = IngestionUsage;
|
|
2530
|
+
type index$l_ObservationBody = ObservationBody;
|
|
2531
|
+
declare const index$l_ObservationType: typeof ObservationType;
|
|
2532
|
+
type index$l_OpenAiCompletionUsageSchema = OpenAiCompletionUsageSchema;
|
|
2533
|
+
type index$l_OpenAiResponseUsageSchema = OpenAiResponseUsageSchema;
|
|
2534
|
+
type index$l_OpenAiUsage = OpenAiUsage;
|
|
2535
|
+
type index$l_OptionalObservationBody = OptionalObservationBody;
|
|
2536
|
+
type index$l_ScoreBody = ScoreBody;
|
|
2537
|
+
type index$l_ScoreEvent = ScoreEvent;
|
|
2538
|
+
type index$l_SdkLogBody = SdkLogBody;
|
|
2539
|
+
type index$l_SdkLogEvent = SdkLogEvent;
|
|
2540
|
+
type index$l_TraceBody = TraceBody;
|
|
2541
|
+
type index$l_TraceEvent = TraceEvent;
|
|
2542
|
+
type index$l_UpdateEventBody = UpdateEventBody;
|
|
2543
|
+
type index$l_UpdateGenerationBody = UpdateGenerationBody;
|
|
2544
|
+
type index$l_UpdateGenerationEvent = UpdateGenerationEvent;
|
|
2545
|
+
type index$l_UpdateObservationEvent = UpdateObservationEvent;
|
|
2546
|
+
type index$l_UpdateSpanBody = UpdateSpanBody;
|
|
2547
|
+
type index$l_UpdateSpanEvent = UpdateSpanEvent;
|
|
2548
|
+
type index$l_UsageDetails = UsageDetails;
|
|
2549
|
+
declare namespace index$l {
|
|
2550
|
+
export { type index$l_BaseEvent as BaseEvent, type index$l_CreateEventBody as CreateEventBody, type index$l_CreateEventEvent as CreateEventEvent, type index$l_CreateGenerationBody as CreateGenerationBody, type index$l_CreateGenerationEvent as CreateGenerationEvent, type index$l_CreateObservationEvent as CreateObservationEvent, type index$l_CreateSpanBody as CreateSpanBody, type index$l_CreateSpanEvent as CreateSpanEvent, type index$l_IngestionError as IngestionError, index$l_IngestionEvent as IngestionEvent, type index$l_IngestionRequest as IngestionRequest, type index$l_IngestionResponse as IngestionResponse, type index$l_IngestionSuccess as IngestionSuccess, type index$l_IngestionUsage as IngestionUsage, type index$l_ObservationBody as ObservationBody, index$l_ObservationType as ObservationType, type index$l_OpenAiCompletionUsageSchema as OpenAiCompletionUsageSchema, type index$l_OpenAiResponseUsageSchema as OpenAiResponseUsageSchema, type index$l_OpenAiUsage as OpenAiUsage, type index$l_OptionalObservationBody as OptionalObservationBody, type index$l_ScoreBody as ScoreBody, type index$l_ScoreEvent as ScoreEvent, type index$l_SdkLogBody as SdkLogBody, type index$l_SdkLogEvent as SdkLogEvent, type index$l_TraceBody as TraceBody, type index$l_TraceEvent as TraceEvent, type index$l_UpdateEventBody as UpdateEventBody, type index$l_UpdateGenerationBody as UpdateGenerationBody, type index$l_UpdateGenerationEvent as UpdateGenerationEvent, type index$l_UpdateObservationEvent as UpdateObservationEvent, type index$l_UpdateSpanBody as UpdateSpanBody, type index$l_UpdateSpanEvent as UpdateSpanEvent, type index$l_UsageDetails as UsageDetails };
|
|
2781
2551
|
}
|
|
2782
2552
|
|
|
2783
2553
|
/**
|
|
2784
2554
|
* This file was auto-generated by Fern from our API Definition.
|
|
2785
2555
|
*/
|
|
2786
|
-
interface
|
|
2556
|
+
interface MetricsResponse {
|
|
2787
2557
|
/**
|
|
2788
2558
|
* The metrics data. Each item in the list contains the metric values and dimensions requested in the query.
|
|
2789
2559
|
* Format varies based on the query parameters.
|
|
@@ -2801,103 +2571,21 @@ interface MetricsV2Response {
|
|
|
2801
2571
|
* query: "query"
|
|
2802
2572
|
* }
|
|
2803
2573
|
*/
|
|
2804
|
-
interface
|
|
2574
|
+
interface GetMetricsRequest {
|
|
2805
2575
|
/**
|
|
2806
2576
|
* JSON string containing the query parameters with the following structure:
|
|
2807
2577
|
* ```json
|
|
2808
2578
|
* {
|
|
2809
|
-
* "view": string, // Required. One of "observations", "scores-numeric", "scores-categorical"
|
|
2579
|
+
* "view": string, // Required. One of "traces", "observations", "scores-numeric", "scores-categorical"
|
|
2810
2580
|
* "dimensions": [ // Optional. Default: []
|
|
2811
2581
|
* {
|
|
2812
|
-
* "field": string // Field to group by
|
|
2582
|
+
* "field": string // Field to group by, e.g. "name", "userId", "sessionId"
|
|
2813
2583
|
* }
|
|
2814
2584
|
* ],
|
|
2815
2585
|
* "metrics": [ // Required. At least one metric must be provided
|
|
2816
2586
|
* {
|
|
2817
|
-
* "measure": string, // What to measure
|
|
2818
|
-
* "aggregation": string // How to aggregate
|
|
2819
|
-
* }
|
|
2820
|
-
* ],
|
|
2821
|
-
* "filters": [ // Optional. Default: []
|
|
2822
|
-
* {
|
|
2823
|
-
* "column": string, // Column to filter on (any dimension field)
|
|
2824
|
-
* "operator": string, // Operator based on type:
|
|
2825
|
-
* // - datetime: ">", "<", ">=", "<="
|
|
2826
|
-
* // - string: "=", "contains", "does not contain", "starts with", "ends with"
|
|
2827
|
-
* // - stringOptions: "any of", "none of"
|
|
2828
|
-
* // - arrayOptions: "any of", "none of", "all of"
|
|
2829
|
-
* // - number: "=", ">", "<", ">=", "<="
|
|
2830
|
-
* // - stringObject/numberObject: same as string/number with required "key"
|
|
2831
|
-
* // - boolean: "=", "<>"
|
|
2832
|
-
* // - null: "is null", "is not null"
|
|
2833
|
-
* "value": any, // Value to compare against
|
|
2834
|
-
* "type": string, // Data type: "datetime", "string", "number", "stringOptions", "categoryOptions", "arrayOptions", "stringObject", "numberObject", "boolean", "null"
|
|
2835
|
-
* "key": string // Required only for stringObject/numberObject types (e.g., metadata filtering)
|
|
2836
|
-
* }
|
|
2837
|
-
* ],
|
|
2838
|
-
* "timeDimension": { // Optional. Default: null. If provided, results will be grouped by time
|
|
2839
|
-
* "granularity": string // One of "auto", "minute", "hour", "day", "week", "month"
|
|
2840
|
-
* },
|
|
2841
|
-
* "fromTimestamp": string, // Required. ISO datetime string for start of time range
|
|
2842
|
-
* "toTimestamp": string, // Required. ISO datetime string for end of time range (must be after fromTimestamp)
|
|
2843
|
-
* "orderBy": [ // Optional. Default: null
|
|
2844
|
-
* {
|
|
2845
|
-
* "field": string, // Field to order by (dimension or metric alias)
|
|
2846
|
-
* "direction": string // "asc" or "desc"
|
|
2847
|
-
* }
|
|
2848
|
-
* ],
|
|
2849
|
-
* "config": { // Optional. Query-specific configuration
|
|
2850
|
-
* "bins": number, // Optional. Number of bins for histogram aggregation (1-100), default: 10
|
|
2851
|
-
* "row_limit": number // Optional. Maximum number of rows to return (1-1000), default: 100
|
|
2852
|
-
* }
|
|
2853
|
-
* }
|
|
2854
|
-
* ```
|
|
2855
|
-
*/
|
|
2856
|
-
query: string;
|
|
2857
|
-
}
|
|
2858
|
-
|
|
2859
|
-
type index$h_GetMetricsV2Request = GetMetricsV2Request;
|
|
2860
|
-
type index$h_MetricsV2Response = MetricsV2Response;
|
|
2861
|
-
declare namespace index$h {
|
|
2862
|
-
export type { index$h_GetMetricsV2Request as GetMetricsV2Request, index$h_MetricsV2Response as MetricsV2Response };
|
|
2863
|
-
}
|
|
2864
|
-
|
|
2865
|
-
/**
|
|
2866
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2867
|
-
*/
|
|
2868
|
-
interface MetricsResponse {
|
|
2869
|
-
/**
|
|
2870
|
-
* The metrics data. Each item in the list contains the metric values and dimensions requested in the query.
|
|
2871
|
-
* Format varies based on the query parameters.
|
|
2872
|
-
* Histograms will return an array with [lower, upper, height] tuples.
|
|
2873
|
-
*/
|
|
2874
|
-
data: Record<string, unknown>[];
|
|
2875
|
-
}
|
|
2876
|
-
|
|
2877
|
-
/**
|
|
2878
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2879
|
-
*/
|
|
2880
|
-
/**
|
|
2881
|
-
* @example
|
|
2882
|
-
* {
|
|
2883
|
-
* query: "query"
|
|
2884
|
-
* }
|
|
2885
|
-
*/
|
|
2886
|
-
interface GetMetricsRequest {
|
|
2887
|
-
/**
|
|
2888
|
-
* JSON string containing the query parameters with the following structure:
|
|
2889
|
-
* ```json
|
|
2890
|
-
* {
|
|
2891
|
-
* "view": string, // Required. One of "traces", "observations", "scores-numeric", "scores-categorical"
|
|
2892
|
-
* "dimensions": [ // Optional. Default: []
|
|
2893
|
-
* {
|
|
2894
|
-
* "field": string // Field to group by, e.g. "name", "userId", "sessionId"
|
|
2895
|
-
* }
|
|
2896
|
-
* ],
|
|
2897
|
-
* "metrics": [ // Required. At least one metric must be provided
|
|
2898
|
-
* {
|
|
2899
|
-
* "measure": string, // What to measure, e.g. "count", "latency", "value"
|
|
2900
|
-
* "aggregation": string // How to aggregate, e.g. "count", "sum", "avg", "p95", "histogram"
|
|
2587
|
+
* "measure": string, // What to measure, e.g. "count", "latency", "value"
|
|
2588
|
+
* "aggregation": string // How to aggregate, e.g. "count", "sum", "avg", "p95", "histogram"
|
|
2901
2589
|
* }
|
|
2902
2590
|
* ],
|
|
2903
2591
|
* "filters": [ // Optional. Default: []
|
|
@@ -2930,18 +2618,18 @@ interface GetMetricsRequest {
|
|
|
2930
2618
|
query: string;
|
|
2931
2619
|
}
|
|
2932
2620
|
|
|
2933
|
-
type index$
|
|
2934
|
-
type index$
|
|
2935
|
-
declare namespace index$
|
|
2936
|
-
export type { index$
|
|
2621
|
+
type index$k_GetMetricsRequest = GetMetricsRequest;
|
|
2622
|
+
type index$k_MetricsResponse = MetricsResponse;
|
|
2623
|
+
declare namespace index$k {
|
|
2624
|
+
export type { index$k_GetMetricsRequest as GetMetricsRequest, index$k_MetricsResponse as MetricsResponse };
|
|
2937
2625
|
}
|
|
2938
2626
|
|
|
2939
2627
|
/**
|
|
2940
2628
|
* This file was auto-generated by Fern from our API Definition.
|
|
2941
2629
|
*/
|
|
2942
2630
|
|
|
2943
|
-
interface
|
|
2944
|
-
data:
|
|
2631
|
+
interface Observations$1 {
|
|
2632
|
+
data: Observation[];
|
|
2945
2633
|
meta: MetaResponse;
|
|
2946
2634
|
}
|
|
2947
2635
|
|
|
@@ -2949,94 +2637,9 @@ interface PaginatedModels {
|
|
|
2949
2637
|
* This file was auto-generated by Fern from our API Definition.
|
|
2950
2638
|
*/
|
|
2951
2639
|
|
|
2952
|
-
interface
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
/** Regex pattern which matches this model definition to generation.model. Useful in case of fine-tuned models. If you want to exact match, use `(?i)^modelname$` */
|
|
2956
|
-
matchPattern: string;
|
|
2957
|
-
/** Apply only to generations which are newer than this ISO date. */
|
|
2958
|
-
startDate?: string;
|
|
2959
|
-
/** Unit used by this model. */
|
|
2960
|
-
unit?: ModelUsageUnit;
|
|
2961
|
-
/** Deprecated. Use 'pricingTiers' instead. Price (USD) per input unit. Creates a default tier if pricingTiers not provided. */
|
|
2962
|
-
inputPrice?: number;
|
|
2963
|
-
/** Deprecated. Use 'pricingTiers' instead. Price (USD) per output unit. Creates a default tier if pricingTiers not provided. */
|
|
2964
|
-
outputPrice?: number;
|
|
2965
|
-
/** Deprecated. Use 'pricingTiers' instead. Price (USD) per total units. Cannot be set if input or output price is set. Creates a default tier if pricingTiers not provided. */
|
|
2966
|
-
totalPrice?: number;
|
|
2967
|
-
/**
|
|
2968
|
-
* Optional. Array of pricing tiers for this model.
|
|
2969
|
-
*
|
|
2970
|
-
* Use pricing tiers for all models - both those with threshold-based pricing variations and those with simple flat pricing:
|
|
2971
|
-
*
|
|
2972
|
-
* - For models with standard flat pricing: Create a single default tier with your prices
|
|
2973
|
-
* (e.g., one tier with isDefault=true, priority=0, conditions=[], and your standard prices)
|
|
2974
|
-
*
|
|
2975
|
-
* - For models with threshold-based pricing: Create a default tier plus additional conditional tiers
|
|
2976
|
-
* (e.g., default tier for standard usage + high-volume tier for usage above certain thresholds)
|
|
2977
|
-
*
|
|
2978
|
-
* Requirements:
|
|
2979
|
-
* - Cannot be provided with flat prices (inputPrice/outputPrice/totalPrice) - use one approach or the other
|
|
2980
|
-
* - Must include exactly one default tier with isDefault=true, priority=0, and conditions=[]
|
|
2981
|
-
* - All tier names and priorities must be unique within the model
|
|
2982
|
-
* - Each tier must define at least one price
|
|
2983
|
-
*
|
|
2984
|
-
* If omitted, you must provide flat prices instead (inputPrice/outputPrice/totalPrice),
|
|
2985
|
-
* which will automatically create a single default tier named "Standard".
|
|
2986
|
-
*/
|
|
2987
|
-
pricingTiers?: PricingTierInput[];
|
|
2988
|
-
/** Optional. Tokenizer to be applied to observations which match to this model. See docs for more details. */
|
|
2989
|
-
tokenizerId?: string;
|
|
2990
|
-
/** Optional. Configuration for the selected tokenizer. Needs to be JSON. See docs for more details. */
|
|
2991
|
-
tokenizerConfig?: unknown;
|
|
2992
|
-
}
|
|
2993
|
-
|
|
2994
|
-
/**
|
|
2995
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
2996
|
-
*/
|
|
2997
|
-
/**
|
|
2998
|
-
* @example
|
|
2999
|
-
* {}
|
|
3000
|
-
*/
|
|
3001
|
-
interface GetModelsRequest {
|
|
3002
|
-
/** page number, starts at 1 */
|
|
3003
|
-
page?: number;
|
|
3004
|
-
/** limit of items per page */
|
|
3005
|
-
limit?: number;
|
|
3006
|
-
}
|
|
3007
|
-
|
|
3008
|
-
type index$f_CreateModelRequest = CreateModelRequest;
|
|
3009
|
-
type index$f_GetModelsRequest = GetModelsRequest;
|
|
3010
|
-
type index$f_PaginatedModels = PaginatedModels;
|
|
3011
|
-
declare namespace index$f {
|
|
3012
|
-
export type { index$f_CreateModelRequest as CreateModelRequest, index$f_GetModelsRequest as GetModelsRequest, index$f_PaginatedModels as PaginatedModels };
|
|
3013
|
-
}
|
|
3014
|
-
|
|
3015
|
-
/**
|
|
3016
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3017
|
-
*/
|
|
3018
|
-
|
|
3019
|
-
/**
|
|
3020
|
-
* Response containing observations with field-group-based filtering and cursor-based pagination.
|
|
3021
|
-
*
|
|
3022
|
-
* The `data` array contains observation objects with only the requested field groups included.
|
|
3023
|
-
* Use the `cursor` in `meta` to retrieve the next page of results.
|
|
3024
|
-
*/
|
|
3025
|
-
interface ObservationsV2Response {
|
|
3026
|
-
/** Array of observation objects. Fields included depend on the `fields` parameter in the request. */
|
|
3027
|
-
data: ObservationV2[];
|
|
3028
|
-
meta: ObservationsV2Meta;
|
|
3029
|
-
}
|
|
3030
|
-
|
|
3031
|
-
/**
|
|
3032
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3033
|
-
*/
|
|
3034
|
-
/**
|
|
3035
|
-
* Metadata for cursor-based pagination
|
|
3036
|
-
*/
|
|
3037
|
-
interface ObservationsV2Meta {
|
|
3038
|
-
/** Base64-encoded cursor to use for retrieving the next page. If not present, there are no more results. */
|
|
3039
|
-
cursor?: string;
|
|
2640
|
+
interface ObservationsViews {
|
|
2641
|
+
data: ObservationsView[];
|
|
2642
|
+
meta: MetaResponse;
|
|
3040
2643
|
}
|
|
3041
2644
|
|
|
3042
2645
|
/**
|
|
@@ -3047,34 +2650,13 @@ interface ObservationsV2Meta {
|
|
|
3047
2650
|
* @example
|
|
3048
2651
|
* {}
|
|
3049
2652
|
*/
|
|
3050
|
-
interface
|
|
3051
|
-
/**
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
* If not specified, `core` and `basic` field groups are returned.
|
|
3055
|
-
* Example: "basic,usage,model"
|
|
3056
|
-
*/
|
|
3057
|
-
fields?: string;
|
|
3058
|
-
/**
|
|
3059
|
-
* Comma-separated list of metadata keys to return non-truncated.
|
|
3060
|
-
* By default, metadata values over 200 characters are truncated.
|
|
3061
|
-
* Use this parameter to retrieve full values for specific keys.
|
|
3062
|
-
* Example: "key1,key2"
|
|
3063
|
-
*/
|
|
3064
|
-
expandMetadata?: string;
|
|
3065
|
-
/** Number of items to return per page. Maximum 1000, default 50. */
|
|
2653
|
+
interface GetObservationsRequest {
|
|
2654
|
+
/** Page number, starts at 1. */
|
|
2655
|
+
page?: number;
|
|
2656
|
+
/** Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit. */
|
|
3066
2657
|
limit?: number;
|
|
3067
|
-
/** Base64-encoded cursor for pagination. Use the cursor from the previous response to get the next page. */
|
|
3068
|
-
cursor?: string;
|
|
3069
|
-
/**
|
|
3070
|
-
* **Deprecated.** Setting this to `true` will return a 400 error.
|
|
3071
|
-
* Input/output fields are always returned as raw strings.
|
|
3072
|
-
* Remove this parameter or set it to `false`.
|
|
3073
|
-
*/
|
|
3074
|
-
parseIoAsJson?: boolean;
|
|
3075
2658
|
name?: string;
|
|
3076
2659
|
userId?: string;
|
|
3077
|
-
/** Filter by observation type (e.g., "GENERATION", "SPAN", "EVENT", "AGENT", "TOOL", "CHAIN", "RETRIEVER", "EVALUATOR", "EMBEDDING", "GUARDRAIL") */
|
|
3078
2660
|
type?: string;
|
|
3079
2661
|
traceId?: string;
|
|
3080
2662
|
/** Optional filter for observations with a specific level (e.g. "DEBUG", "DEFAULT", "WARNING", "ERROR"). */
|
|
@@ -3128,13 +2710,6 @@ interface GetObservationsV2Request {
|
|
|
3128
2710
|
* - `level` (string) - Log level (DEBUG, DEFAULT, WARNING, ERROR)
|
|
3129
2711
|
* - `statusMessage` (string) - Status message
|
|
3130
2712
|
* - `version` (string) - Version tag
|
|
3131
|
-
* - `userId` (string) - User ID
|
|
3132
|
-
* - `sessionId` (string) - Session ID
|
|
3133
|
-
*
|
|
3134
|
-
* ### Trace-Related Fields
|
|
3135
|
-
* - `traceName` (string) - Name of the parent trace
|
|
3136
|
-
* - `traceTags` (arrayOptions) - Tags from the parent trace
|
|
3137
|
-
* - `tags` (arrayOptions) - Alias for traceTags
|
|
3138
2713
|
*
|
|
3139
2714
|
* ### Performance Metrics
|
|
3140
2715
|
* - `latency` (number) - Latency in seconds (calculated: end_time - start_time)
|
|
@@ -3152,13 +2727,19 @@ interface GetObservationsV2Request {
|
|
|
3152
2727
|
* - `totalCost` (number) - Total cost in USD
|
|
3153
2728
|
*
|
|
3154
2729
|
* ### Model Information
|
|
3155
|
-
* - `model` (string) - Provided model name
|
|
2730
|
+
* - `model` (string) - Provided model name
|
|
3156
2731
|
* - `promptName` (string) - Associated prompt name
|
|
3157
2732
|
* - `promptVersion` (number) - Associated prompt version
|
|
3158
2733
|
*
|
|
3159
2734
|
* ### Structured Data
|
|
3160
2735
|
* - `metadata` (stringObject/numberObject/categoryOptions) - Metadata key-value pairs. Use `key` parameter to filter on specific metadata keys.
|
|
3161
2736
|
*
|
|
2737
|
+
* ### Associated Trace Fields (requires join with traces table)
|
|
2738
|
+
* - `userId` (string) - User ID from associated trace
|
|
2739
|
+
* - `traceName` (string) - Name from associated trace
|
|
2740
|
+
* - `traceEnvironment` (string) - Environment from associated trace
|
|
2741
|
+
* - `traceTags` (arrayOptions) - Tags from associated trace
|
|
2742
|
+
*
|
|
3162
2743
|
* ## Filter Examples
|
|
3163
2744
|
* ```json
|
|
3164
2745
|
* [
|
|
@@ -3181,25 +2762,445 @@ interface GetObservationsV2Request {
|
|
|
3181
2762
|
* "operator": "=",
|
|
3182
2763
|
* "value": "production"
|
|
3183
2764
|
* }
|
|
3184
|
-
* ]
|
|
2765
|
+
* ]
|
|
2766
|
+
* ```
|
|
2767
|
+
*/
|
|
2768
|
+
filter?: string;
|
|
2769
|
+
}
|
|
2770
|
+
|
|
2771
|
+
type index$j_GetObservationsRequest = GetObservationsRequest;
|
|
2772
|
+
type index$j_ObservationsViews = ObservationsViews;
|
|
2773
|
+
declare namespace index$j {
|
|
2774
|
+
export type { index$j_GetObservationsRequest as GetObservationsRequest, Observations$1 as Observations, index$j_ObservationsViews as ObservationsViews };
|
|
2775
|
+
}
|
|
2776
|
+
|
|
2777
|
+
/**
|
|
2778
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2779
|
+
*/
|
|
2780
|
+
|
|
2781
|
+
/**
|
|
2782
|
+
* @example
|
|
2783
|
+
* {
|
|
2784
|
+
* name: "novelty",
|
|
2785
|
+
* value: 0.9,
|
|
2786
|
+
* traceId: "cdef-1234-5678-90ab"
|
|
2787
|
+
* }
|
|
2788
|
+
*
|
|
2789
|
+
* @example
|
|
2790
|
+
* {
|
|
2791
|
+
* name: "consistency",
|
|
2792
|
+
* value: 1.2,
|
|
2793
|
+
* dataType: LangfuseAPI.ScoreDataType.Numeric,
|
|
2794
|
+
* traceId: "cdef-1234-5678-90ab"
|
|
2795
|
+
* }
|
|
2796
|
+
*
|
|
2797
|
+
* @example
|
|
2798
|
+
* {
|
|
2799
|
+
* name: "accuracy",
|
|
2800
|
+
* value: 0.9,
|
|
2801
|
+
* dataType: LangfuseAPI.ScoreDataType.Numeric,
|
|
2802
|
+
* configId: "9203-4567-89ab-cdef",
|
|
2803
|
+
* traceId: "cdef-1234-5678-90ab",
|
|
2804
|
+
* environment: "test"
|
|
2805
|
+
* }
|
|
2806
|
+
*
|
|
2807
|
+
* @example
|
|
2808
|
+
* {
|
|
2809
|
+
* name: "toxicity",
|
|
2810
|
+
* value: "not toxic",
|
|
2811
|
+
* traceId: "cdef-1234-5678-90ab",
|
|
2812
|
+
* environment: "production"
|
|
2813
|
+
* }
|
|
2814
|
+
*
|
|
2815
|
+
* @example
|
|
2816
|
+
* {
|
|
2817
|
+
* name: "correctness",
|
|
2818
|
+
* value: "partially correct",
|
|
2819
|
+
* dataType: LangfuseAPI.ScoreDataType.Categorical,
|
|
2820
|
+
* configId: "1234-5678-90ab-cdef",
|
|
2821
|
+
* traceId: "cdef-1234-5678-90ab"
|
|
2822
|
+
* }
|
|
2823
|
+
*
|
|
2824
|
+
* @example
|
|
2825
|
+
* {
|
|
2826
|
+
* name: "hallucination",
|
|
2827
|
+
* value: 0,
|
|
2828
|
+
* dataType: LangfuseAPI.ScoreDataType.Boolean,
|
|
2829
|
+
* traceId: "cdef-1234-5678-90ab"
|
|
2830
|
+
* }
|
|
2831
|
+
*
|
|
2832
|
+
* @example
|
|
2833
|
+
* {
|
|
2834
|
+
* name: "helpfulness",
|
|
2835
|
+
* value: 1,
|
|
2836
|
+
* dataType: LangfuseAPI.ScoreDataType.Boolean,
|
|
2837
|
+
* configId: "1234-5678-90ab-cdef",
|
|
2838
|
+
* traceId: "cdef-1234-5678-90ab"
|
|
2839
|
+
* }
|
|
2840
|
+
*/
|
|
2841
|
+
interface CreateScoreRequest {
|
|
2842
|
+
id?: string;
|
|
2843
|
+
traceId?: string;
|
|
2844
|
+
sessionId?: string;
|
|
2845
|
+
observationId?: string;
|
|
2846
|
+
datasetRunId?: string;
|
|
2847
|
+
name: string;
|
|
2848
|
+
/** The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false) */
|
|
2849
|
+
value: CreateScoreValue;
|
|
2850
|
+
comment?: string;
|
|
2851
|
+
metadata?: Record<string, unknown>;
|
|
2852
|
+
/** The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'. */
|
|
2853
|
+
environment?: string;
|
|
2854
|
+
/** The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue. */
|
|
2855
|
+
queueId?: string;
|
|
2856
|
+
/** The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric. */
|
|
2857
|
+
dataType?: ScoreDataType;
|
|
2858
|
+
/** Reference a score config on a score. The unique langfuse identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated. */
|
|
2859
|
+
configId?: string;
|
|
2860
|
+
}
|
|
2861
|
+
|
|
2862
|
+
/**
|
|
2863
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2864
|
+
*/
|
|
2865
|
+
interface CreateScoreResponse {
|
|
2866
|
+
/** The id of the created object in Langfuse */
|
|
2867
|
+
id: string;
|
|
2868
|
+
}
|
|
2869
|
+
|
|
2870
|
+
type index$i_CreateScoreRequest = CreateScoreRequest;
|
|
2871
|
+
type index$i_CreateScoreResponse = CreateScoreResponse;
|
|
2872
|
+
declare namespace index$i {
|
|
2873
|
+
export type { index$i_CreateScoreRequest as CreateScoreRequest, index$i_CreateScoreResponse as CreateScoreResponse };
|
|
2874
|
+
}
|
|
2875
|
+
|
|
2876
|
+
type index$h_CreateScoreRequest = CreateScoreRequest;
|
|
2877
|
+
type index$h_CreateScoreResponse = CreateScoreResponse;
|
|
2878
|
+
type index$h_GetMetricsRequest = GetMetricsRequest;
|
|
2879
|
+
type index$h_GetObservationsRequest = GetObservationsRequest;
|
|
2880
|
+
type index$h_MetricsResponse = MetricsResponse;
|
|
2881
|
+
type index$h_ObservationsViews = ObservationsViews;
|
|
2882
|
+
declare namespace index$h {
|
|
2883
|
+
export { type index$h_CreateScoreRequest as CreateScoreRequest, type index$h_CreateScoreResponse as CreateScoreResponse, type index$h_GetMetricsRequest as GetMetricsRequest, type index$h_GetObservationsRequest as GetObservationsRequest, type index$h_MetricsResponse as MetricsResponse, type Observations$1 as Observations, type index$h_ObservationsViews as ObservationsViews, index$k as metricsV1, index$j as observationsV1, index$i as scoreV1 };
|
|
2884
|
+
}
|
|
2885
|
+
|
|
2886
|
+
/**
|
|
2887
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2888
|
+
*/
|
|
2889
|
+
/**
|
|
2890
|
+
* LLM API connection configuration (secrets excluded)
|
|
2891
|
+
*/
|
|
2892
|
+
interface LlmConnection {
|
|
2893
|
+
id: string;
|
|
2894
|
+
/** Provider name (e.g., 'openai', 'my-gateway'). Must be unique in project, used for upserting. */
|
|
2895
|
+
provider: string;
|
|
2896
|
+
/** The adapter used to interface with the LLM */
|
|
2897
|
+
adapter: string;
|
|
2898
|
+
/** Masked version of the secret key for display purposes */
|
|
2899
|
+
displaySecretKey: string;
|
|
2900
|
+
/** Custom base URL for the LLM API */
|
|
2901
|
+
baseURL?: string;
|
|
2902
|
+
/** List of custom model names available for this connection */
|
|
2903
|
+
customModels: string[];
|
|
2904
|
+
/** Whether to include default models for this adapter */
|
|
2905
|
+
withDefaultModels: boolean;
|
|
2906
|
+
/** Keys of extra headers sent with requests (values excluded for security) */
|
|
2907
|
+
extraHeaderKeys: string[];
|
|
2908
|
+
/** Adapter-specific configuration. Required for Bedrock (`{"region":"us-east-1"}`), optional for VertexAI (`{"location":"us-central1"}`), not used by other adapters. */
|
|
2909
|
+
config?: Record<string, unknown>;
|
|
2910
|
+
createdAt: string;
|
|
2911
|
+
updatedAt: string;
|
|
2912
|
+
}
|
|
2913
|
+
|
|
2914
|
+
/**
|
|
2915
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2916
|
+
*/
|
|
2917
|
+
|
|
2918
|
+
interface PaginatedLlmConnections {
|
|
2919
|
+
data: LlmConnection[];
|
|
2920
|
+
meta: MetaResponse;
|
|
2921
|
+
}
|
|
2922
|
+
|
|
2923
|
+
/**
|
|
2924
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2925
|
+
*/
|
|
2926
|
+
|
|
2927
|
+
/**
|
|
2928
|
+
* Request to create or update an LLM connection (upsert)
|
|
2929
|
+
*/
|
|
2930
|
+
interface UpsertLlmConnectionRequest {
|
|
2931
|
+
/** Provider name (e.g., 'openai', 'my-gateway'). Must be unique in project, used for upserting. */
|
|
2932
|
+
provider: string;
|
|
2933
|
+
/** The adapter used to interface with the LLM */
|
|
2934
|
+
adapter: LlmAdapter;
|
|
2935
|
+
/** Secret key for the LLM API. */
|
|
2936
|
+
secretKey: string;
|
|
2937
|
+
/** Custom base URL for the LLM API */
|
|
2938
|
+
baseURL?: string;
|
|
2939
|
+
/** List of custom model names */
|
|
2940
|
+
customModels?: string[];
|
|
2941
|
+
/** Whether to include default models. Default is true. */
|
|
2942
|
+
withDefaultModels?: boolean;
|
|
2943
|
+
/** Extra headers to send with requests */
|
|
2944
|
+
extraHeaders?: Record<string, string>;
|
|
2945
|
+
/** Adapter-specific configuration. Validation rules: - **Bedrock**: Required. Must be `{"region": "<aws-region>"}` (e.g., `{"region":"us-east-1"}`) - **VertexAI**: Optional. If provided, must be `{"location": "<gcp-location>"}` (e.g., `{"location":"us-central1"}`) - **Other adapters**: Not supported. Omit this field or set to null. */
|
|
2946
|
+
config?: Record<string, unknown>;
|
|
2947
|
+
}
|
|
2948
|
+
|
|
2949
|
+
/**
|
|
2950
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2951
|
+
*/
|
|
2952
|
+
type LlmAdapter = "anthropic" | "openai" | "azure" | "bedrock" | "google-vertex-ai" | "google-ai-studio";
|
|
2953
|
+
declare const LlmAdapter: {
|
|
2954
|
+
readonly Anthropic: "anthropic";
|
|
2955
|
+
readonly OpenAi: "openai";
|
|
2956
|
+
readonly Azure: "azure";
|
|
2957
|
+
readonly Bedrock: "bedrock";
|
|
2958
|
+
readonly GoogleVertexAi: "google-vertex-ai";
|
|
2959
|
+
readonly GoogleAiStudio: "google-ai-studio";
|
|
2960
|
+
};
|
|
2961
|
+
|
|
2962
|
+
/**
|
|
2963
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2964
|
+
*/
|
|
2965
|
+
/**
|
|
2966
|
+
* @example
|
|
2967
|
+
* {}
|
|
2968
|
+
*/
|
|
2969
|
+
interface GetLlmConnectionsRequest {
|
|
2970
|
+
/** page number, starts at 1 */
|
|
2971
|
+
page?: number;
|
|
2972
|
+
/** limit of items per page */
|
|
2973
|
+
limit?: number;
|
|
2974
|
+
}
|
|
2975
|
+
|
|
2976
|
+
type index$g_GetLlmConnectionsRequest = GetLlmConnectionsRequest;
|
|
2977
|
+
declare const index$g_LlmAdapter: typeof LlmAdapter;
|
|
2978
|
+
type index$g_LlmConnection = LlmConnection;
|
|
2979
|
+
type index$g_PaginatedLlmConnections = PaginatedLlmConnections;
|
|
2980
|
+
type index$g_UpsertLlmConnectionRequest = UpsertLlmConnectionRequest;
|
|
2981
|
+
declare namespace index$g {
|
|
2982
|
+
export { type index$g_GetLlmConnectionsRequest as GetLlmConnectionsRequest, index$g_LlmAdapter as LlmAdapter, type index$g_LlmConnection as LlmConnection, type index$g_PaginatedLlmConnections as PaginatedLlmConnections, type index$g_UpsertLlmConnectionRequest as UpsertLlmConnectionRequest };
|
|
2983
|
+
}
|
|
2984
|
+
|
|
2985
|
+
/**
|
|
2986
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2987
|
+
*/
|
|
2988
|
+
interface GetMediaResponse {
|
|
2989
|
+
/** The unique langfuse identifier of a media record */
|
|
2990
|
+
mediaId: string;
|
|
2991
|
+
/** The MIME type of the media record */
|
|
2992
|
+
contentType: string;
|
|
2993
|
+
/** The size of the media record in bytes */
|
|
2994
|
+
contentLength: number;
|
|
2995
|
+
/** The date and time when the media record was uploaded */
|
|
2996
|
+
uploadedAt: string;
|
|
2997
|
+
/** The download URL of the media record */
|
|
2998
|
+
url: string;
|
|
2999
|
+
/** The expiry date and time of the media record download URL */
|
|
3000
|
+
urlExpiry: string;
|
|
3001
|
+
}
|
|
3002
|
+
|
|
3003
|
+
/**
|
|
3004
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3005
|
+
*/
|
|
3006
|
+
interface PatchMediaBody {
|
|
3007
|
+
/** The date and time when the media record was uploaded */
|
|
3008
|
+
uploadedAt: string;
|
|
3009
|
+
/** The HTTP status code of the upload */
|
|
3010
|
+
uploadHttpStatus: number;
|
|
3011
|
+
/** The HTTP error message of the upload */
|
|
3012
|
+
uploadHttpError?: string;
|
|
3013
|
+
/** The time in milliseconds it took to upload the media record */
|
|
3014
|
+
uploadTimeMs?: number;
|
|
3015
|
+
}
|
|
3016
|
+
|
|
3017
|
+
/**
|
|
3018
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3019
|
+
*/
|
|
3020
|
+
|
|
3021
|
+
interface GetMediaUploadUrlRequest {
|
|
3022
|
+
/** The trace ID associated with the media record */
|
|
3023
|
+
traceId: string;
|
|
3024
|
+
/** The observation ID associated with the media record. If the media record is associated directly with a trace, this will be null. */
|
|
3025
|
+
observationId?: string;
|
|
3026
|
+
contentType: MediaContentType;
|
|
3027
|
+
/** The size of the media record in bytes */
|
|
3028
|
+
contentLength: number;
|
|
3029
|
+
/** The SHA-256 hash of the media record */
|
|
3030
|
+
sha256Hash: string;
|
|
3031
|
+
/** The trace / observation field the media record is associated with. This can be one of `input`, `output`, `metadata` */
|
|
3032
|
+
field: string;
|
|
3033
|
+
}
|
|
3034
|
+
|
|
3035
|
+
/**
|
|
3036
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3037
|
+
*/
|
|
3038
|
+
interface GetMediaUploadUrlResponse {
|
|
3039
|
+
/** The presigned upload URL. If the asset is already uploaded, this will be null */
|
|
3040
|
+
uploadUrl?: string;
|
|
3041
|
+
/** The unique langfuse identifier of a media record */
|
|
3042
|
+
mediaId: string;
|
|
3043
|
+
}
|
|
3044
|
+
|
|
3045
|
+
/**
|
|
3046
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3047
|
+
*/
|
|
3048
|
+
/**
|
|
3049
|
+
* The MIME type of the media record
|
|
3050
|
+
*/
|
|
3051
|
+
type MediaContentType = "image/png" | "image/jpeg" | "image/jpg" | "image/webp" | "image/gif" | "image/svg+xml" | "image/tiff" | "image/bmp" | "image/avif" | "image/heic" | "audio/mpeg" | "audio/mp3" | "audio/wav" | "audio/ogg" | "audio/oga" | "audio/aac" | "audio/mp4" | "audio/flac" | "audio/opus" | "audio/webm" | "video/mp4" | "video/webm" | "video/ogg" | "video/mpeg" | "video/quicktime" | "video/x-msvideo" | "video/x-matroska" | "text/plain" | "text/html" | "text/css" | "text/csv" | "text/markdown" | "text/x-python" | "application/javascript" | "text/x-typescript" | "application/x-yaml" | "application/pdf" | "application/msword" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/zip" | "application/json" | "application/xml" | "application/octet-stream" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/rtf" | "application/x-ndjson" | "application/vnd.apache.parquet" | "application/gzip" | "application/x-tar" | "application/x-7z-compressed";
|
|
3052
|
+
declare const MediaContentType: {
|
|
3053
|
+
readonly ImagePng: "image/png";
|
|
3054
|
+
readonly ImageJpeg: "image/jpeg";
|
|
3055
|
+
readonly ImageJpg: "image/jpg";
|
|
3056
|
+
readonly ImageWebp: "image/webp";
|
|
3057
|
+
readonly ImageGif: "image/gif";
|
|
3058
|
+
readonly ImageSvgXml: "image/svg+xml";
|
|
3059
|
+
readonly ImageTiff: "image/tiff";
|
|
3060
|
+
readonly ImageBmp: "image/bmp";
|
|
3061
|
+
readonly ImageAvif: "image/avif";
|
|
3062
|
+
readonly ImageHeic: "image/heic";
|
|
3063
|
+
readonly AudioMpeg: "audio/mpeg";
|
|
3064
|
+
readonly AudioMp3: "audio/mp3";
|
|
3065
|
+
readonly AudioWav: "audio/wav";
|
|
3066
|
+
readonly AudioOgg: "audio/ogg";
|
|
3067
|
+
readonly AudioOga: "audio/oga";
|
|
3068
|
+
readonly AudioAac: "audio/aac";
|
|
3069
|
+
readonly AudioMp4: "audio/mp4";
|
|
3070
|
+
readonly AudioFlac: "audio/flac";
|
|
3071
|
+
readonly AudioOpus: "audio/opus";
|
|
3072
|
+
readonly AudioWebm: "audio/webm";
|
|
3073
|
+
readonly VideoMp4: "video/mp4";
|
|
3074
|
+
readonly VideoWebm: "video/webm";
|
|
3075
|
+
readonly VideoOgg: "video/ogg";
|
|
3076
|
+
readonly VideoMpeg: "video/mpeg";
|
|
3077
|
+
readonly VideoQuicktime: "video/quicktime";
|
|
3078
|
+
readonly VideoXMsvideo: "video/x-msvideo";
|
|
3079
|
+
readonly VideoXMatroska: "video/x-matroska";
|
|
3080
|
+
readonly TextPlain: "text/plain";
|
|
3081
|
+
readonly TextHtml: "text/html";
|
|
3082
|
+
readonly TextCss: "text/css";
|
|
3083
|
+
readonly TextCsv: "text/csv";
|
|
3084
|
+
readonly TextMarkdown: "text/markdown";
|
|
3085
|
+
readonly TextXPython: "text/x-python";
|
|
3086
|
+
readonly ApplicationJavascript: "application/javascript";
|
|
3087
|
+
readonly TextXTypescript: "text/x-typescript";
|
|
3088
|
+
readonly ApplicationXYaml: "application/x-yaml";
|
|
3089
|
+
readonly ApplicationPdf: "application/pdf";
|
|
3090
|
+
readonly ApplicationMsword: "application/msword";
|
|
3091
|
+
readonly ApplicationMsExcel: "application/vnd.ms-excel";
|
|
3092
|
+
readonly ApplicationOpenxmlSpreadsheet: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
|
|
3093
|
+
readonly ApplicationZip: "application/zip";
|
|
3094
|
+
readonly ApplicationJson: "application/json";
|
|
3095
|
+
readonly ApplicationXml: "application/xml";
|
|
3096
|
+
readonly ApplicationOctetStream: "application/octet-stream";
|
|
3097
|
+
readonly ApplicationOpenxmlWord: "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
|
|
3098
|
+
readonly ApplicationOpenxmlPresentation: "application/vnd.openxmlformats-officedocument.presentationml.presentation";
|
|
3099
|
+
readonly ApplicationRtf: "application/rtf";
|
|
3100
|
+
readonly ApplicationXNdjson: "application/x-ndjson";
|
|
3101
|
+
readonly ApplicationParquet: "application/vnd.apache.parquet";
|
|
3102
|
+
readonly ApplicationGzip: "application/gzip";
|
|
3103
|
+
readonly ApplicationXTar: "application/x-tar";
|
|
3104
|
+
readonly ApplicationX7ZCompressed: "application/x-7z-compressed";
|
|
3105
|
+
};
|
|
3106
|
+
|
|
3107
|
+
type index$f_GetMediaResponse = GetMediaResponse;
|
|
3108
|
+
type index$f_GetMediaUploadUrlRequest = GetMediaUploadUrlRequest;
|
|
3109
|
+
type index$f_GetMediaUploadUrlResponse = GetMediaUploadUrlResponse;
|
|
3110
|
+
declare const index$f_MediaContentType: typeof MediaContentType;
|
|
3111
|
+
type index$f_PatchMediaBody = PatchMediaBody;
|
|
3112
|
+
declare namespace index$f {
|
|
3113
|
+
export { type index$f_GetMediaResponse as GetMediaResponse, type index$f_GetMediaUploadUrlRequest as GetMediaUploadUrlRequest, type index$f_GetMediaUploadUrlResponse as GetMediaUploadUrlResponse, index$f_MediaContentType as MediaContentType, type index$f_PatchMediaBody as PatchMediaBody };
|
|
3114
|
+
}
|
|
3115
|
+
|
|
3116
|
+
/**
|
|
3117
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3118
|
+
*/
|
|
3119
|
+
interface MetricsV2Response {
|
|
3120
|
+
/**
|
|
3121
|
+
* The metrics data. Each item in the list contains the metric values and dimensions requested in the query.
|
|
3122
|
+
* Format varies based on the query parameters.
|
|
3123
|
+
* Histograms will return an array with [lower, upper, height] tuples.
|
|
3124
|
+
*/
|
|
3125
|
+
data: Record<string, unknown>[];
|
|
3126
|
+
}
|
|
3127
|
+
|
|
3128
|
+
/**
|
|
3129
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3130
|
+
*/
|
|
3131
|
+
/**
|
|
3132
|
+
* @example
|
|
3133
|
+
* {
|
|
3134
|
+
* query: "query"
|
|
3135
|
+
* }
|
|
3136
|
+
*/
|
|
3137
|
+
interface GetMetricsV2Request {
|
|
3138
|
+
/**
|
|
3139
|
+
* JSON string containing the query parameters with the following structure:
|
|
3140
|
+
* ```json
|
|
3141
|
+
* {
|
|
3142
|
+
* "view": string, // Required. One of "observations", "scores-numeric", "scores-categorical"
|
|
3143
|
+
* "dimensions": [ // Optional. Default: []
|
|
3144
|
+
* {
|
|
3145
|
+
* "field": string // Field to group by (see available dimensions above)
|
|
3146
|
+
* }
|
|
3147
|
+
* ],
|
|
3148
|
+
* "metrics": [ // Required. At least one metric must be provided
|
|
3149
|
+
* {
|
|
3150
|
+
* "measure": string, // What to measure (see available measures above)
|
|
3151
|
+
* "aggregation": string // How to aggregate: "sum", "avg", "count", "max", "min", "p50", "p75", "p90", "p95", "p99", "histogram"
|
|
3152
|
+
* }
|
|
3153
|
+
* ],
|
|
3154
|
+
* "filters": [ // Optional. Default: []
|
|
3155
|
+
* {
|
|
3156
|
+
* "column": string, // Column to filter on (any dimension field)
|
|
3157
|
+
* "operator": string, // Operator based on type:
|
|
3158
|
+
* // - datetime: ">", "<", ">=", "<="
|
|
3159
|
+
* // - string: "=", "contains", "does not contain", "starts with", "ends with"
|
|
3160
|
+
* // - stringOptions: "any of", "none of"
|
|
3161
|
+
* // - arrayOptions: "any of", "none of", "all of"
|
|
3162
|
+
* // - number: "=", ">", "<", ">=", "<="
|
|
3163
|
+
* // - stringObject/numberObject: same as string/number with required "key"
|
|
3164
|
+
* // - boolean: "=", "<>"
|
|
3165
|
+
* // - null: "is null", "is not null"
|
|
3166
|
+
* "value": any, // Value to compare against
|
|
3167
|
+
* "type": string, // Data type: "datetime", "string", "number", "stringOptions", "categoryOptions", "arrayOptions", "stringObject", "numberObject", "boolean", "null"
|
|
3168
|
+
* "key": string // Required only for stringObject/numberObject types (e.g., metadata filtering)
|
|
3169
|
+
* }
|
|
3170
|
+
* ],
|
|
3171
|
+
* "timeDimension": { // Optional. Default: null. If provided, results will be grouped by time
|
|
3172
|
+
* "granularity": string // One of "auto", "minute", "hour", "day", "week", "month"
|
|
3173
|
+
* },
|
|
3174
|
+
* "fromTimestamp": string, // Required. ISO datetime string for start of time range
|
|
3175
|
+
* "toTimestamp": string, // Required. ISO datetime string for end of time range (must be after fromTimestamp)
|
|
3176
|
+
* "orderBy": [ // Optional. Default: null
|
|
3177
|
+
* {
|
|
3178
|
+
* "field": string, // Field to order by (dimension or metric alias)
|
|
3179
|
+
* "direction": string // "asc" or "desc"
|
|
3180
|
+
* }
|
|
3181
|
+
* ],
|
|
3182
|
+
* "config": { // Optional. Query-specific configuration
|
|
3183
|
+
* "bins": number, // Optional. Number of bins for histogram aggregation (1-100), default: 10
|
|
3184
|
+
* "row_limit": number // Optional. Maximum number of rows to return (1-1000), default: 100
|
|
3185
|
+
* }
|
|
3186
|
+
* }
|
|
3185
3187
|
* ```
|
|
3186
3188
|
*/
|
|
3187
|
-
|
|
3189
|
+
query: string;
|
|
3188
3190
|
}
|
|
3189
3191
|
|
|
3190
|
-
type index$
|
|
3191
|
-
type index$
|
|
3192
|
-
type index$e_ObservationsV2Response = ObservationsV2Response;
|
|
3192
|
+
type index$e_GetMetricsV2Request = GetMetricsV2Request;
|
|
3193
|
+
type index$e_MetricsV2Response = MetricsV2Response;
|
|
3193
3194
|
declare namespace index$e {
|
|
3194
|
-
export type { index$
|
|
3195
|
+
export type { index$e_GetMetricsV2Request as GetMetricsV2Request, index$e_MetricsV2Response as MetricsV2Response };
|
|
3195
3196
|
}
|
|
3196
3197
|
|
|
3197
3198
|
/**
|
|
3198
3199
|
* This file was auto-generated by Fern from our API Definition.
|
|
3199
3200
|
*/
|
|
3200
3201
|
|
|
3201
|
-
interface
|
|
3202
|
-
data:
|
|
3202
|
+
interface PaginatedModels {
|
|
3203
|
+
data: Model[];
|
|
3203
3204
|
meta: MetaResponse;
|
|
3204
3205
|
}
|
|
3205
3206
|
|
|
@@ -3207,26 +3208,132 @@ interface Observations$1 {
|
|
|
3207
3208
|
* This file was auto-generated by Fern from our API Definition.
|
|
3208
3209
|
*/
|
|
3209
3210
|
|
|
3210
|
-
interface
|
|
3211
|
-
|
|
3212
|
-
|
|
3211
|
+
interface CreateModelRequest {
|
|
3212
|
+
/** Name of the model definition. If multiple with the same name exist, they are applied in the following order: (1) custom over built-in, (2) newest according to startTime where model.startTime<observation.startTime */
|
|
3213
|
+
modelName: string;
|
|
3214
|
+
/** Regex pattern which matches this model definition to generation.model. Useful in case of fine-tuned models. If you want to exact match, use `(?i)^modelname$` */
|
|
3215
|
+
matchPattern: string;
|
|
3216
|
+
/** Apply only to generations which are newer than this ISO date. */
|
|
3217
|
+
startDate?: string;
|
|
3218
|
+
/** Unit used by this model. */
|
|
3219
|
+
unit?: ModelUsageUnit;
|
|
3220
|
+
/** Deprecated. Use 'pricingTiers' instead. Price (USD) per input unit. Creates a default tier if pricingTiers not provided. */
|
|
3221
|
+
inputPrice?: number;
|
|
3222
|
+
/** Deprecated. Use 'pricingTiers' instead. Price (USD) per output unit. Creates a default tier if pricingTiers not provided. */
|
|
3223
|
+
outputPrice?: number;
|
|
3224
|
+
/** Deprecated. Use 'pricingTiers' instead. Price (USD) per total units. Cannot be set if input or output price is set. Creates a default tier if pricingTiers not provided. */
|
|
3225
|
+
totalPrice?: number;
|
|
3226
|
+
/**
|
|
3227
|
+
* Optional. Array of pricing tiers for this model.
|
|
3228
|
+
*
|
|
3229
|
+
* Use pricing tiers for all models - both those with threshold-based pricing variations and those with simple flat pricing:
|
|
3230
|
+
*
|
|
3231
|
+
* - For models with standard flat pricing: Create a single default tier with your prices
|
|
3232
|
+
* (e.g., one tier with isDefault=true, priority=0, conditions=[], and your standard prices)
|
|
3233
|
+
*
|
|
3234
|
+
* - For models with threshold-based pricing: Create a default tier plus additional conditional tiers
|
|
3235
|
+
* (e.g., default tier for standard usage + high-volume tier for usage above certain thresholds)
|
|
3236
|
+
*
|
|
3237
|
+
* Requirements:
|
|
3238
|
+
* - Cannot be provided with flat prices (inputPrice/outputPrice/totalPrice) - use one approach or the other
|
|
3239
|
+
* - Must include exactly one default tier with isDefault=true, priority=0, and conditions=[]
|
|
3240
|
+
* - All tier names and priorities must be unique within the model
|
|
3241
|
+
* - Each tier must define at least one price
|
|
3242
|
+
*
|
|
3243
|
+
* If omitted, you must provide flat prices instead (inputPrice/outputPrice/totalPrice),
|
|
3244
|
+
* which will automatically create a single default tier named "Standard".
|
|
3245
|
+
*/
|
|
3246
|
+
pricingTiers?: PricingTierInput[];
|
|
3247
|
+
/** Optional. Tokenizer to be applied to observations which match to this model. See docs for more details. */
|
|
3248
|
+
tokenizerId?: string;
|
|
3249
|
+
/** Optional. Configuration for the selected tokenizer. Needs to be JSON. See docs for more details. */
|
|
3250
|
+
tokenizerConfig?: unknown;
|
|
3213
3251
|
}
|
|
3214
3252
|
|
|
3215
3253
|
/**
|
|
3216
3254
|
* This file was auto-generated by Fern from our API Definition.
|
|
3217
3255
|
*/
|
|
3218
|
-
|
|
3219
3256
|
/**
|
|
3220
3257
|
* @example
|
|
3221
3258
|
* {}
|
|
3222
3259
|
*/
|
|
3223
|
-
interface
|
|
3224
|
-
/**
|
|
3260
|
+
interface GetModelsRequest {
|
|
3261
|
+
/** page number, starts at 1 */
|
|
3225
3262
|
page?: number;
|
|
3226
|
-
/**
|
|
3263
|
+
/** limit of items per page */
|
|
3264
|
+
limit?: number;
|
|
3265
|
+
}
|
|
3266
|
+
|
|
3267
|
+
type index$d_CreateModelRequest = CreateModelRequest;
|
|
3268
|
+
type index$d_GetModelsRequest = GetModelsRequest;
|
|
3269
|
+
type index$d_PaginatedModels = PaginatedModels;
|
|
3270
|
+
declare namespace index$d {
|
|
3271
|
+
export type { index$d_CreateModelRequest as CreateModelRequest, index$d_GetModelsRequest as GetModelsRequest, index$d_PaginatedModels as PaginatedModels };
|
|
3272
|
+
}
|
|
3273
|
+
|
|
3274
|
+
/**
|
|
3275
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3276
|
+
*/
|
|
3277
|
+
|
|
3278
|
+
/**
|
|
3279
|
+
* Response containing observations with field-group-based filtering and cursor-based pagination.
|
|
3280
|
+
*
|
|
3281
|
+
* The `data` array contains observation objects with only the requested field groups included.
|
|
3282
|
+
* Use the `cursor` in `meta` to retrieve the next page of results.
|
|
3283
|
+
*/
|
|
3284
|
+
interface ObservationsV2Response {
|
|
3285
|
+
/** Array of observation objects. Fields included depend on the `fields` parameter in the request. */
|
|
3286
|
+
data: ObservationV2[];
|
|
3287
|
+
meta: ObservationsV2Meta;
|
|
3288
|
+
}
|
|
3289
|
+
|
|
3290
|
+
/**
|
|
3291
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3292
|
+
*/
|
|
3293
|
+
/**
|
|
3294
|
+
* Metadata for cursor-based pagination
|
|
3295
|
+
*/
|
|
3296
|
+
interface ObservationsV2Meta {
|
|
3297
|
+
/** Base64-encoded cursor to use for retrieving the next page. If not present, there are no more results. */
|
|
3298
|
+
cursor?: string;
|
|
3299
|
+
}
|
|
3300
|
+
|
|
3301
|
+
/**
|
|
3302
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3303
|
+
*/
|
|
3304
|
+
|
|
3305
|
+
/**
|
|
3306
|
+
* @example
|
|
3307
|
+
* {}
|
|
3308
|
+
*/
|
|
3309
|
+
interface GetObservationsV2Request {
|
|
3310
|
+
/**
|
|
3311
|
+
* Comma-separated list of field groups to include in the response.
|
|
3312
|
+
* Available groups: core, basic, time, io, metadata, model, usage, prompt, metrics.
|
|
3313
|
+
* If not specified, `core` and `basic` field groups are returned.
|
|
3314
|
+
* Example: "basic,usage,model"
|
|
3315
|
+
*/
|
|
3316
|
+
fields?: string;
|
|
3317
|
+
/**
|
|
3318
|
+
* Comma-separated list of metadata keys to return non-truncated.
|
|
3319
|
+
* By default, metadata values over 200 characters are truncated.
|
|
3320
|
+
* Use this parameter to retrieve full values for specific keys.
|
|
3321
|
+
* Example: "key1,key2"
|
|
3322
|
+
*/
|
|
3323
|
+
expandMetadata?: string;
|
|
3324
|
+
/** Number of items to return per page. Maximum 1000, default 50. */
|
|
3227
3325
|
limit?: number;
|
|
3326
|
+
/** Base64-encoded cursor for pagination. Use the cursor from the previous response to get the next page. */
|
|
3327
|
+
cursor?: string;
|
|
3328
|
+
/**
|
|
3329
|
+
* **Deprecated.** Setting this to `true` will return a 400 error.
|
|
3330
|
+
* Input/output fields are always returned as raw strings.
|
|
3331
|
+
* Remove this parameter or set it to `false`.
|
|
3332
|
+
*/
|
|
3333
|
+
parseIoAsJson?: boolean;
|
|
3228
3334
|
name?: string;
|
|
3229
3335
|
userId?: string;
|
|
3336
|
+
/** Filter by observation type (e.g., "GENERATION", "SPAN", "EVENT", "AGENT", "TOOL", "CHAIN", "RETRIEVER", "EVALUATOR", "EMBEDDING", "GUARDRAIL") */
|
|
3230
3337
|
type?: string;
|
|
3231
3338
|
traceId?: string;
|
|
3232
3339
|
/** Optional filter for observations with a specific level (e.g. "DEBUG", "DEFAULT", "WARNING", "ERROR"). */
|
|
@@ -3280,6 +3387,13 @@ interface GetObservationsRequest {
|
|
|
3280
3387
|
* - `level` (string) - Log level (DEBUG, DEFAULT, WARNING, ERROR)
|
|
3281
3388
|
* - `statusMessage` (string) - Status message
|
|
3282
3389
|
* - `version` (string) - Version tag
|
|
3390
|
+
* - `userId` (string) - User ID
|
|
3391
|
+
* - `sessionId` (string) - Session ID
|
|
3392
|
+
*
|
|
3393
|
+
* ### Trace-Related Fields
|
|
3394
|
+
* - `traceName` (string) - Name of the parent trace
|
|
3395
|
+
* - `traceTags` (arrayOptions) - Tags from the parent trace
|
|
3396
|
+
* - `tags` (arrayOptions) - Alias for traceTags
|
|
3283
3397
|
*
|
|
3284
3398
|
* ### Performance Metrics
|
|
3285
3399
|
* - `latency` (number) - Latency in seconds (calculated: end_time - start_time)
|
|
@@ -3297,19 +3411,13 @@ interface GetObservationsRequest {
|
|
|
3297
3411
|
* - `totalCost` (number) - Total cost in USD
|
|
3298
3412
|
*
|
|
3299
3413
|
* ### Model Information
|
|
3300
|
-
* - `model` (string) - Provided model name
|
|
3414
|
+
* - `model` (string) - Provided model name (alias: `providedModelName`)
|
|
3301
3415
|
* - `promptName` (string) - Associated prompt name
|
|
3302
3416
|
* - `promptVersion` (number) - Associated prompt version
|
|
3303
3417
|
*
|
|
3304
3418
|
* ### Structured Data
|
|
3305
3419
|
* - `metadata` (stringObject/numberObject/categoryOptions) - Metadata key-value pairs. Use `key` parameter to filter on specific metadata keys.
|
|
3306
3420
|
*
|
|
3307
|
-
* ### Associated Trace Fields (requires join with traces table)
|
|
3308
|
-
* - `userId` (string) - User ID from associated trace
|
|
3309
|
-
* - `traceName` (string) - Name from associated trace
|
|
3310
|
-
* - `traceEnvironment` (string) - Environment from associated trace
|
|
3311
|
-
* - `traceTags` (arrayOptions) - Tags from associated trace
|
|
3312
|
-
*
|
|
3313
3421
|
* ## Filter Examples
|
|
3314
3422
|
* ```json
|
|
3315
3423
|
* [
|
|
@@ -3338,10 +3446,11 @@ interface GetObservationsRequest {
|
|
|
3338
3446
|
filter?: string;
|
|
3339
3447
|
}
|
|
3340
3448
|
|
|
3341
|
-
type index$
|
|
3342
|
-
type index$
|
|
3343
|
-
|
|
3344
|
-
|
|
3449
|
+
type index$c_GetObservationsV2Request = GetObservationsV2Request;
|
|
3450
|
+
type index$c_ObservationsV2Meta = ObservationsV2Meta;
|
|
3451
|
+
type index$c_ObservationsV2Response = ObservationsV2Response;
|
|
3452
|
+
declare namespace index$c {
|
|
3453
|
+
export type { index$c_GetObservationsV2Request as GetObservationsV2Request, index$c_ObservationsV2Meta as ObservationsV2Meta, index$c_ObservationsV2Response as ObservationsV2Response };
|
|
3345
3454
|
}
|
|
3346
3455
|
|
|
3347
3456
|
/**
|
|
@@ -3518,17 +3627,17 @@ interface OtelTraceRequest {
|
|
|
3518
3627
|
resourceSpans: OtelResourceSpan[];
|
|
3519
3628
|
}
|
|
3520
3629
|
|
|
3521
|
-
type index$
|
|
3522
|
-
type index$
|
|
3523
|
-
type index$
|
|
3524
|
-
type index$
|
|
3525
|
-
type index$
|
|
3526
|
-
type index$
|
|
3527
|
-
type index$
|
|
3528
|
-
type index$
|
|
3529
|
-
type index$
|
|
3530
|
-
declare namespace index$
|
|
3531
|
-
export type { index$
|
|
3630
|
+
type index$b_OtelAttribute = OtelAttribute;
|
|
3631
|
+
type index$b_OtelAttributeValue = OtelAttributeValue;
|
|
3632
|
+
type index$b_OtelResource = OtelResource;
|
|
3633
|
+
type index$b_OtelResourceSpan = OtelResourceSpan;
|
|
3634
|
+
type index$b_OtelScope = OtelScope;
|
|
3635
|
+
type index$b_OtelScopeSpan = OtelScopeSpan;
|
|
3636
|
+
type index$b_OtelSpan = OtelSpan;
|
|
3637
|
+
type index$b_OtelTraceRequest = OtelTraceRequest;
|
|
3638
|
+
type index$b_OtelTraceResponse = OtelTraceResponse;
|
|
3639
|
+
declare namespace index$b {
|
|
3640
|
+
export type { index$b_OtelAttribute as OtelAttribute, index$b_OtelAttributeValue as OtelAttributeValue, index$b_OtelResource as OtelResource, index$b_OtelResourceSpan as OtelResourceSpan, index$b_OtelScope as OtelScope, index$b_OtelScopeSpan as OtelScopeSpan, index$b_OtelSpan as OtelSpan, index$b_OtelTraceRequest as OtelTraceRequest, index$b_OtelTraceResponse as OtelTraceResponse };
|
|
3532
3641
|
}
|
|
3533
3642
|
|
|
3534
3643
|
/**
|
|
@@ -3625,18 +3734,18 @@ interface OrganizationApiKeysResponse {
|
|
|
3625
3734
|
apiKeys: OrganizationApiKey[];
|
|
3626
3735
|
}
|
|
3627
3736
|
|
|
3628
|
-
type index$
|
|
3629
|
-
type index$
|
|
3630
|
-
type index$
|
|
3631
|
-
type index$
|
|
3632
|
-
declare const index$
|
|
3633
|
-
type index$
|
|
3634
|
-
type index$
|
|
3635
|
-
type index$
|
|
3636
|
-
type index$
|
|
3637
|
-
type index$
|
|
3638
|
-
declare namespace index$
|
|
3639
|
-
export { type index$
|
|
3737
|
+
type index$a_DeleteMembershipRequest = DeleteMembershipRequest;
|
|
3738
|
+
type index$a_MembershipDeletionResponse = MembershipDeletionResponse;
|
|
3739
|
+
type index$a_MembershipRequest = MembershipRequest;
|
|
3740
|
+
type index$a_MembershipResponse = MembershipResponse;
|
|
3741
|
+
declare const index$a_MembershipRole: typeof MembershipRole;
|
|
3742
|
+
type index$a_MembershipsResponse = MembershipsResponse;
|
|
3743
|
+
type index$a_OrganizationApiKey = OrganizationApiKey;
|
|
3744
|
+
type index$a_OrganizationApiKeysResponse = OrganizationApiKeysResponse;
|
|
3745
|
+
type index$a_OrganizationProject = OrganizationProject;
|
|
3746
|
+
type index$a_OrganizationProjectsResponse = OrganizationProjectsResponse;
|
|
3747
|
+
declare namespace index$a {
|
|
3748
|
+
export { type index$a_DeleteMembershipRequest as DeleteMembershipRequest, type index$a_MembershipDeletionResponse as MembershipDeletionResponse, type index$a_MembershipRequest as MembershipRequest, type index$a_MembershipResponse as MembershipResponse, index$a_MembershipRole as MembershipRole, type index$a_MembershipsResponse as MembershipsResponse, type index$a_OrganizationApiKey as OrganizationApiKey, type index$a_OrganizationApiKeysResponse as OrganizationApiKeysResponse, type index$a_OrganizationProject as OrganizationProject, type index$a_OrganizationProjectsResponse as OrganizationProjectsResponse };
|
|
3640
3749
|
}
|
|
3641
3750
|
|
|
3642
3751
|
/**
|
|
@@ -3795,18 +3904,18 @@ interface CreateApiKeyRequest {
|
|
|
3795
3904
|
secretKey?: string;
|
|
3796
3905
|
}
|
|
3797
3906
|
|
|
3798
|
-
type index$
|
|
3799
|
-
type index$
|
|
3800
|
-
type index$
|
|
3801
|
-
type index$
|
|
3802
|
-
type index$
|
|
3803
|
-
type index$
|
|
3804
|
-
type index$
|
|
3805
|
-
type index$
|
|
3806
|
-
type index$
|
|
3807
|
-
type index$
|
|
3808
|
-
declare namespace index$
|
|
3809
|
-
export type { index$
|
|
3907
|
+
type index$9_ApiKeyDeletionResponse = ApiKeyDeletionResponse;
|
|
3908
|
+
type index$9_ApiKeyList = ApiKeyList;
|
|
3909
|
+
type index$9_ApiKeyResponse = ApiKeyResponse;
|
|
3910
|
+
type index$9_ApiKeySummary = ApiKeySummary;
|
|
3911
|
+
type index$9_CreateApiKeyRequest = CreateApiKeyRequest;
|
|
3912
|
+
type index$9_CreateProjectRequest = CreateProjectRequest;
|
|
3913
|
+
type index$9_Organization = Organization;
|
|
3914
|
+
type index$9_Project = Project;
|
|
3915
|
+
type index$9_ProjectDeletionResponse = ProjectDeletionResponse;
|
|
3916
|
+
type index$9_UpdateProjectRequest = UpdateProjectRequest;
|
|
3917
|
+
declare namespace index$9 {
|
|
3918
|
+
export type { index$9_ApiKeyDeletionResponse as ApiKeyDeletionResponse, index$9_ApiKeyList as ApiKeyList, index$9_ApiKeyResponse as ApiKeyResponse, index$9_ApiKeySummary as ApiKeySummary, index$9_CreateApiKeyRequest as CreateApiKeyRequest, index$9_CreateProjectRequest as CreateProjectRequest, index$9_Organization as Organization, index$9_Project as Project, index$9_ProjectDeletionResponse as ProjectDeletionResponse, Projects$1 as Projects, index$9_UpdateProjectRequest as UpdateProjectRequest };
|
|
3810
3919
|
}
|
|
3811
3920
|
|
|
3812
3921
|
/**
|
|
@@ -4036,28 +4145,28 @@ interface DeletePromptRequest {
|
|
|
4036
4145
|
version?: number;
|
|
4037
4146
|
}
|
|
4038
4147
|
|
|
4039
|
-
type index$
|
|
4040
|
-
type index$
|
|
4041
|
-
declare const index$
|
|
4042
|
-
type index$
|
|
4043
|
-
type index$
|
|
4044
|
-
type index$
|
|
4045
|
-
declare const index$
|
|
4046
|
-
type index$
|
|
4047
|
-
type index$
|
|
4048
|
-
declare const index$
|
|
4049
|
-
type index$
|
|
4050
|
-
type index$
|
|
4051
|
-
type index$
|
|
4052
|
-
type index$
|
|
4053
|
-
declare const index$
|
|
4054
|
-
declare const index$
|
|
4055
|
-
type index$
|
|
4056
|
-
type index$
|
|
4057
|
-
declare const index$
|
|
4058
|
-
type index$
|
|
4059
|
-
declare namespace index$
|
|
4060
|
-
export { type index$
|
|
4148
|
+
type index$8_BasePrompt = BasePrompt;
|
|
4149
|
+
type index$8_ChatMessage = ChatMessage;
|
|
4150
|
+
declare const index$8_ChatMessageType: typeof ChatMessageType;
|
|
4151
|
+
type index$8_ChatMessageWithPlaceholders = ChatMessageWithPlaceholders;
|
|
4152
|
+
type index$8_ChatPrompt = ChatPrompt;
|
|
4153
|
+
type index$8_CreateChatPromptRequest = CreateChatPromptRequest;
|
|
4154
|
+
declare const index$8_CreateChatPromptType: typeof CreateChatPromptType;
|
|
4155
|
+
type index$8_CreatePromptRequest = CreatePromptRequest;
|
|
4156
|
+
type index$8_CreateTextPromptRequest = CreateTextPromptRequest;
|
|
4157
|
+
declare const index$8_CreateTextPromptType: typeof CreateTextPromptType;
|
|
4158
|
+
type index$8_DeletePromptRequest = DeletePromptRequest;
|
|
4159
|
+
type index$8_GetPromptRequest = GetPromptRequest;
|
|
4160
|
+
type index$8_ListPromptsMetaRequest = ListPromptsMetaRequest;
|
|
4161
|
+
type index$8_PlaceholderMessage = PlaceholderMessage;
|
|
4162
|
+
declare const index$8_PlaceholderMessageType: typeof PlaceholderMessageType;
|
|
4163
|
+
declare const index$8_Prompt: typeof Prompt;
|
|
4164
|
+
type index$8_PromptMeta = PromptMeta;
|
|
4165
|
+
type index$8_PromptMetaListResponse = PromptMetaListResponse;
|
|
4166
|
+
declare const index$8_PromptType: typeof PromptType;
|
|
4167
|
+
type index$8_TextPrompt = TextPrompt;
|
|
4168
|
+
declare namespace index$8 {
|
|
4169
|
+
export { type index$8_BasePrompt as BasePrompt, type index$8_ChatMessage as ChatMessage, index$8_ChatMessageType as ChatMessageType, type index$8_ChatMessageWithPlaceholders as ChatMessageWithPlaceholders, type index$8_ChatPrompt as ChatPrompt, type index$8_CreateChatPromptRequest as CreateChatPromptRequest, index$8_CreateChatPromptType as CreateChatPromptType, type index$8_CreatePromptRequest as CreatePromptRequest, type index$8_CreateTextPromptRequest as CreateTextPromptRequest, index$8_CreateTextPromptType as CreateTextPromptType, type index$8_DeletePromptRequest as DeletePromptRequest, type index$8_GetPromptRequest as GetPromptRequest, type index$8_ListPromptsMetaRequest as ListPromptsMetaRequest, type index$8_PlaceholderMessage as PlaceholderMessage, index$8_PlaceholderMessageType as PlaceholderMessageType, index$8_Prompt as Prompt, type index$8_PromptMeta as PromptMeta, type index$8_PromptMetaListResponse as PromptMetaListResponse, index$8_PromptType as PromptType, type index$8_TextPrompt as TextPrompt };
|
|
4061
4170
|
}
|
|
4062
4171
|
|
|
4063
4172
|
/**
|
|
@@ -4279,27 +4388,27 @@ interface CreateUserRequest {
|
|
|
4279
4388
|
password?: string;
|
|
4280
4389
|
}
|
|
4281
4390
|
|
|
4282
|
-
type index$
|
|
4283
|
-
type index$
|
|
4284
|
-
type index$
|
|
4285
|
-
type index$
|
|
4286
|
-
type index$
|
|
4287
|
-
type index$
|
|
4288
|
-
type index$
|
|
4289
|
-
type index$
|
|
4290
|
-
type index$
|
|
4291
|
-
type index$
|
|
4292
|
-
type index$
|
|
4293
|
-
type index$
|
|
4294
|
-
type index$
|
|
4295
|
-
type index$
|
|
4296
|
-
type index$
|
|
4297
|
-
type index$
|
|
4298
|
-
type index$
|
|
4299
|
-
type index$
|
|
4300
|
-
type index$
|
|
4301
|
-
declare namespace index$
|
|
4302
|
-
export type { index$
|
|
4391
|
+
type index$7_AuthenticationScheme = AuthenticationScheme;
|
|
4392
|
+
type index$7_BulkConfig = BulkConfig;
|
|
4393
|
+
type index$7_CreateUserRequest = CreateUserRequest;
|
|
4394
|
+
type index$7_EmptyResponse = EmptyResponse;
|
|
4395
|
+
type index$7_FilterConfig = FilterConfig;
|
|
4396
|
+
type index$7_ListUsersRequest = ListUsersRequest;
|
|
4397
|
+
type index$7_ResourceMeta = ResourceMeta;
|
|
4398
|
+
type index$7_ResourceType = ResourceType;
|
|
4399
|
+
type index$7_ResourceTypesResponse = ResourceTypesResponse;
|
|
4400
|
+
type index$7_SchemaExtension = SchemaExtension;
|
|
4401
|
+
type index$7_SchemaResource = SchemaResource;
|
|
4402
|
+
type index$7_SchemasResponse = SchemasResponse;
|
|
4403
|
+
type index$7_ScimEmail = ScimEmail;
|
|
4404
|
+
type index$7_ScimFeatureSupport = ScimFeatureSupport;
|
|
4405
|
+
type index$7_ScimName = ScimName;
|
|
4406
|
+
type index$7_ScimUser = ScimUser;
|
|
4407
|
+
type index$7_ScimUsersListResponse = ScimUsersListResponse;
|
|
4408
|
+
type index$7_ServiceProviderConfig = ServiceProviderConfig;
|
|
4409
|
+
type index$7_UserMeta = UserMeta;
|
|
4410
|
+
declare namespace index$7 {
|
|
4411
|
+
export type { index$7_AuthenticationScheme as AuthenticationScheme, index$7_BulkConfig as BulkConfig, index$7_CreateUserRequest as CreateUserRequest, index$7_EmptyResponse as EmptyResponse, index$7_FilterConfig as FilterConfig, index$7_ListUsersRequest as ListUsersRequest, index$7_ResourceMeta as ResourceMeta, index$7_ResourceType as ResourceType, index$7_ResourceTypesResponse as ResourceTypesResponse, index$7_SchemaExtension as SchemaExtension, index$7_SchemaResource as SchemaResource, index$7_SchemasResponse as SchemasResponse, index$7_ScimEmail as ScimEmail, index$7_ScimFeatureSupport as ScimFeatureSupport, index$7_ScimName as ScimName, index$7_ScimUser as ScimUser, index$7_ScimUsersListResponse as ScimUsersListResponse, index$7_ServiceProviderConfig as ServiceProviderConfig, index$7_UserMeta as UserMeta };
|
|
4303
4412
|
}
|
|
4304
4413
|
|
|
4305
4414
|
/**
|
|
@@ -4361,11 +4470,11 @@ interface GetScoreConfigsRequest {
|
|
|
4361
4470
|
limit?: number;
|
|
4362
4471
|
}
|
|
4363
4472
|
|
|
4364
|
-
type index$
|
|
4365
|
-
type index$
|
|
4366
|
-
type index$
|
|
4367
|
-
declare namespace index$
|
|
4368
|
-
export type { index$
|
|
4473
|
+
type index$6_CreateScoreConfigRequest = CreateScoreConfigRequest;
|
|
4474
|
+
type index$6_GetScoreConfigsRequest = GetScoreConfigsRequest;
|
|
4475
|
+
type index$6_UpdateScoreConfigRequest = UpdateScoreConfigRequest;
|
|
4476
|
+
declare namespace index$6 {
|
|
4477
|
+
export type { index$6_CreateScoreConfigRequest as CreateScoreConfigRequest, index$6_GetScoreConfigsRequest as GetScoreConfigsRequest, ScoreConfigs$1 as ScoreConfigs, index$6_UpdateScoreConfigRequest as UpdateScoreConfigRequest };
|
|
4369
4478
|
}
|
|
4370
4479
|
|
|
4371
4480
|
/**
|
|
@@ -4465,146 +4574,47 @@ interface GetScoresRequest {
|
|
|
4465
4574
|
/** Optional filter to only include scores created before a certain datetime (ISO 8601) */
|
|
4466
4575
|
toTimestamp?: string;
|
|
4467
4576
|
/** Optional filter for scores where the environment is one of the provided values. */
|
|
4468
|
-
environment?: string | string[];
|
|
4469
|
-
/** Retrieve only scores from a specific source. */
|
|
4470
|
-
source?: ScoreSource;
|
|
4471
|
-
/** Retrieve only scores with <operator> value. */
|
|
4472
|
-
operator?: string;
|
|
4473
|
-
/** Retrieve only scores with <operator> value. */
|
|
4474
|
-
value?: number;
|
|
4475
|
-
/** Comma-separated list of score IDs to limit the results to. */
|
|
4476
|
-
scoreIds?: string;
|
|
4477
|
-
/** Retrieve only scores with a specific configId. */
|
|
4478
|
-
configId?: string;
|
|
4479
|
-
/** Retrieve only scores with a specific sessionId. */
|
|
4480
|
-
sessionId?: string;
|
|
4481
|
-
/** Retrieve only scores with a specific datasetRunId. */
|
|
4482
|
-
datasetRunId?: string;
|
|
4483
|
-
/** Retrieve only scores with a specific traceId. */
|
|
4484
|
-
traceId?: string;
|
|
4485
|
-
/** Comma-separated list of observation IDs to filter scores by. */
|
|
4486
|
-
observationId?: string;
|
|
4487
|
-
/** Retrieve only scores with a specific annotation queueId. */
|
|
4488
|
-
queueId?: string;
|
|
4489
|
-
/** Retrieve only scores with a specific dataType. */
|
|
4490
|
-
dataType?: ScoreDataType;
|
|
4491
|
-
/** Only scores linked to traces that include all of these tags will be returned. */
|
|
4492
|
-
traceTags?: string | string[];
|
|
4493
|
-
/** Comma-separated list of field groups to include in the response. Available field groups: 'score' (core score fields), 'trace' (trace properties: userId, tags, environment, sessionId). If not specified, both 'score' and 'trace' are returned by default. Example: 'score' to exclude trace data, 'score,trace' to include both. Note: When filtering by trace properties (using userId or traceTags parameters), the 'trace' field group must be included, otherwise a 400 error will be returned. */
|
|
4494
|
-
fields?: string;
|
|
4495
|
-
/** A JSON stringified array of filter objects. Each object requires type, column, operator, and value. Supports filtering by score metadata using the stringObject type. Example: [{"type":"stringObject","column":"metadata","key":"user_id","operator":"=","value":"abc123"}]. Supported types: stringObject (metadata key-value filtering), string, number, datetime, stringOptions, arrayOptions. Supported operators for stringObject: =, contains, does not contain, starts with, ends with. */
|
|
4496
|
-
filter?: string;
|
|
4497
|
-
}
|
|
4498
|
-
|
|
4499
|
-
type index$6_GetScoresRequest = GetScoresRequest;
|
|
4500
|
-
type index$6_GetScoresResponse = GetScoresResponse;
|
|
4501
|
-
declare const index$6_GetScoresResponseData: typeof GetScoresResponseData;
|
|
4502
|
-
type index$6_GetScoresResponseDataBoolean = GetScoresResponseDataBoolean;
|
|
4503
|
-
type index$6_GetScoresResponseDataCategorical = GetScoresResponseDataCategorical;
|
|
4504
|
-
type index$6_GetScoresResponseDataCorrection = GetScoresResponseDataCorrection;
|
|
4505
|
-
type index$6_GetScoresResponseDataNumeric = GetScoresResponseDataNumeric;
|
|
4506
|
-
type index$6_GetScoresResponseTraceData = GetScoresResponseTraceData;
|
|
4507
|
-
declare namespace index$6 {
|
|
4508
|
-
export { type index$6_GetScoresRequest as GetScoresRequest, type index$6_GetScoresResponse as GetScoresResponse, index$6_GetScoresResponseData as GetScoresResponseData, type index$6_GetScoresResponseDataBoolean as GetScoresResponseDataBoolean, type index$6_GetScoresResponseDataCategorical as GetScoresResponseDataCategorical, type index$6_GetScoresResponseDataCorrection as GetScoresResponseDataCorrection, type index$6_GetScoresResponseDataNumeric as GetScoresResponseDataNumeric, type index$6_GetScoresResponseTraceData as GetScoresResponseTraceData };
|
|
4509
|
-
}
|
|
4510
|
-
|
|
4511
|
-
/**
|
|
4512
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
4513
|
-
*/
|
|
4514
|
-
|
|
4515
|
-
/**
|
|
4516
|
-
* @example
|
|
4517
|
-
* {
|
|
4518
|
-
* name: "novelty",
|
|
4519
|
-
* value: 0.9,
|
|
4520
|
-
* traceId: "cdef-1234-5678-90ab"
|
|
4521
|
-
* }
|
|
4522
|
-
*
|
|
4523
|
-
* @example
|
|
4524
|
-
* {
|
|
4525
|
-
* name: "consistency",
|
|
4526
|
-
* value: 1.2,
|
|
4527
|
-
* dataType: LangfuseAPI.ScoreDataType.Numeric,
|
|
4528
|
-
* traceId: "cdef-1234-5678-90ab"
|
|
4529
|
-
* }
|
|
4530
|
-
*
|
|
4531
|
-
* @example
|
|
4532
|
-
* {
|
|
4533
|
-
* name: "accuracy",
|
|
4534
|
-
* value: 0.9,
|
|
4535
|
-
* dataType: LangfuseAPI.ScoreDataType.Numeric,
|
|
4536
|
-
* configId: "9203-4567-89ab-cdef",
|
|
4537
|
-
* traceId: "cdef-1234-5678-90ab",
|
|
4538
|
-
* environment: "test"
|
|
4539
|
-
* }
|
|
4540
|
-
*
|
|
4541
|
-
* @example
|
|
4542
|
-
* {
|
|
4543
|
-
* name: "toxicity",
|
|
4544
|
-
* value: "not toxic",
|
|
4545
|
-
* traceId: "cdef-1234-5678-90ab",
|
|
4546
|
-
* environment: "production"
|
|
4547
|
-
* }
|
|
4548
|
-
*
|
|
4549
|
-
* @example
|
|
4550
|
-
* {
|
|
4551
|
-
* name: "correctness",
|
|
4552
|
-
* value: "partially correct",
|
|
4553
|
-
* dataType: LangfuseAPI.ScoreDataType.Categorical,
|
|
4554
|
-
* configId: "1234-5678-90ab-cdef",
|
|
4555
|
-
* traceId: "cdef-1234-5678-90ab"
|
|
4556
|
-
* }
|
|
4557
|
-
*
|
|
4558
|
-
* @example
|
|
4559
|
-
* {
|
|
4560
|
-
* name: "hallucination",
|
|
4561
|
-
* value: 0,
|
|
4562
|
-
* dataType: LangfuseAPI.ScoreDataType.Boolean,
|
|
4563
|
-
* traceId: "cdef-1234-5678-90ab"
|
|
4564
|
-
* }
|
|
4565
|
-
*
|
|
4566
|
-
* @example
|
|
4567
|
-
* {
|
|
4568
|
-
* name: "helpfulness",
|
|
4569
|
-
* value: 1,
|
|
4570
|
-
* dataType: LangfuseAPI.ScoreDataType.Boolean,
|
|
4571
|
-
* configId: "1234-5678-90ab-cdef",
|
|
4572
|
-
* traceId: "cdef-1234-5678-90ab"
|
|
4573
|
-
* }
|
|
4574
|
-
*/
|
|
4575
|
-
interface CreateScoreRequest {
|
|
4576
|
-
id?: string;
|
|
4577
|
-
traceId?: string;
|
|
4577
|
+
environment?: string | string[];
|
|
4578
|
+
/** Retrieve only scores from a specific source. */
|
|
4579
|
+
source?: ScoreSource;
|
|
4580
|
+
/** Retrieve only scores with <operator> value. */
|
|
4581
|
+
operator?: string;
|
|
4582
|
+
/** Retrieve only scores with <operator> value. */
|
|
4583
|
+
value?: number;
|
|
4584
|
+
/** Comma-separated list of score IDs to limit the results to. */
|
|
4585
|
+
scoreIds?: string;
|
|
4586
|
+
/** Retrieve only scores with a specific configId. */
|
|
4587
|
+
configId?: string;
|
|
4588
|
+
/** Retrieve only scores with a specific sessionId. */
|
|
4578
4589
|
sessionId?: string;
|
|
4579
|
-
|
|
4590
|
+
/** Retrieve only scores with a specific datasetRunId. */
|
|
4580
4591
|
datasetRunId?: string;
|
|
4581
|
-
|
|
4582
|
-
|
|
4583
|
-
|
|
4584
|
-
|
|
4585
|
-
|
|
4586
|
-
/** The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'. */
|
|
4587
|
-
environment?: string;
|
|
4588
|
-
/** The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue. */
|
|
4592
|
+
/** Retrieve only scores with a specific traceId. */
|
|
4593
|
+
traceId?: string;
|
|
4594
|
+
/** Comma-separated list of observation IDs to filter scores by. */
|
|
4595
|
+
observationId?: string;
|
|
4596
|
+
/** Retrieve only scores with a specific annotation queueId. */
|
|
4589
4597
|
queueId?: string;
|
|
4590
|
-
/**
|
|
4598
|
+
/** Retrieve only scores with a specific dataType. */
|
|
4591
4599
|
dataType?: ScoreDataType;
|
|
4592
|
-
/**
|
|
4593
|
-
|
|
4594
|
-
|
|
4595
|
-
|
|
4596
|
-
/**
|
|
4597
|
-
|
|
4598
|
-
*/
|
|
4599
|
-
interface CreateScoreResponse {
|
|
4600
|
-
/** The id of the created object in Langfuse */
|
|
4601
|
-
id: string;
|
|
4600
|
+
/** Only scores linked to traces that include all of these tags will be returned. */
|
|
4601
|
+
traceTags?: string | string[];
|
|
4602
|
+
/** Comma-separated list of field groups to include in the response. Available field groups: 'score' (core score fields), 'trace' (trace properties: userId, tags, environment, sessionId). If not specified, both 'score' and 'trace' are returned by default. Example: 'score' to exclude trace data, 'score,trace' to include both. Note: When filtering by trace properties (using userId or traceTags parameters), the 'trace' field group must be included, otherwise a 400 error will be returned. */
|
|
4603
|
+
fields?: string;
|
|
4604
|
+
/** A JSON stringified array of filter objects. Each object requires type, column, operator, and value. Supports filtering by score metadata using the stringObject type. Example: [{"type":"stringObject","column":"metadata","key":"user_id","operator":"=","value":"abc123"}]. Supported types: stringObject (metadata key-value filtering), string, number, datetime, stringOptions, arrayOptions. Supported operators for stringObject: =, contains, does not contain, starts with, ends with. */
|
|
4605
|
+
filter?: string;
|
|
4602
4606
|
}
|
|
4603
4607
|
|
|
4604
|
-
type index$
|
|
4605
|
-
type index$
|
|
4608
|
+
type index$5_GetScoresRequest = GetScoresRequest;
|
|
4609
|
+
type index$5_GetScoresResponse = GetScoresResponse;
|
|
4610
|
+
declare const index$5_GetScoresResponseData: typeof GetScoresResponseData;
|
|
4611
|
+
type index$5_GetScoresResponseDataBoolean = GetScoresResponseDataBoolean;
|
|
4612
|
+
type index$5_GetScoresResponseDataCategorical = GetScoresResponseDataCategorical;
|
|
4613
|
+
type index$5_GetScoresResponseDataCorrection = GetScoresResponseDataCorrection;
|
|
4614
|
+
type index$5_GetScoresResponseDataNumeric = GetScoresResponseDataNumeric;
|
|
4615
|
+
type index$5_GetScoresResponseTraceData = GetScoresResponseTraceData;
|
|
4606
4616
|
declare namespace index$5 {
|
|
4607
|
-
export type
|
|
4617
|
+
export { type index$5_GetScoresRequest as GetScoresRequest, type index$5_GetScoresResponse as GetScoresResponse, index$5_GetScoresResponseData as GetScoresResponseData, type index$5_GetScoresResponseDataBoolean as GetScoresResponseDataBoolean, type index$5_GetScoresResponseDataCategorical as GetScoresResponseDataCategorical, type index$5_GetScoresResponseDataCorrection as GetScoresResponseDataCorrection, type index$5_GetScoresResponseDataNumeric as GetScoresResponseDataNumeric, type index$5_GetScoresResponseTraceData as GetScoresResponseTraceData };
|
|
4608
4618
|
}
|
|
4609
4619
|
|
|
4610
4620
|
/**
|
|
@@ -5880,6 +5890,280 @@ declare class Ingestion {
|
|
|
5880
5890
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
5881
5891
|
}
|
|
5882
5892
|
|
|
5893
|
+
/**
|
|
5894
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
5895
|
+
*/
|
|
5896
|
+
|
|
5897
|
+
declare namespace MetricsV1 {
|
|
5898
|
+
interface Options {
|
|
5899
|
+
environment: Supplier<string>;
|
|
5900
|
+
/** Specify a custom URL to connect the client to. */
|
|
5901
|
+
baseUrl?: Supplier<string>;
|
|
5902
|
+
username?: Supplier<string | undefined>;
|
|
5903
|
+
password?: Supplier<string | undefined>;
|
|
5904
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
5905
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
5906
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
5907
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
5908
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
5909
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
5910
|
+
/** Additional headers to include in requests. */
|
|
5911
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
5912
|
+
}
|
|
5913
|
+
interface RequestOptions {
|
|
5914
|
+
/** The maximum time to wait for a response in seconds. */
|
|
5915
|
+
timeoutInSeconds?: number;
|
|
5916
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
5917
|
+
maxRetries?: number;
|
|
5918
|
+
/** A hook to abort the request. */
|
|
5919
|
+
abortSignal?: AbortSignal;
|
|
5920
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
5921
|
+
xLangfuseSdkName?: string | undefined;
|
|
5922
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
5923
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
5924
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
5925
|
+
xLangfusePublicKey?: string | undefined;
|
|
5926
|
+
/** Additional query string parameters to include in the request. */
|
|
5927
|
+
queryParams?: Record<string, unknown>;
|
|
5928
|
+
/** Additional headers to include in the request. */
|
|
5929
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
5930
|
+
}
|
|
5931
|
+
}
|
|
5932
|
+
declare class MetricsV1 {
|
|
5933
|
+
protected readonly _options: MetricsV1.Options;
|
|
5934
|
+
constructor(_options: MetricsV1.Options);
|
|
5935
|
+
/**
|
|
5936
|
+
* Get metrics from the Langfuse project using a query object.
|
|
5937
|
+
*
|
|
5938
|
+
* Consider using the [v2 metrics endpoint](/api-reference#tag/metricsv2/GET/api/public/v2/metrics) for better performance.
|
|
5939
|
+
*
|
|
5940
|
+
* For more details, see the [Metrics API documentation](https://langfuse.com/docs/metrics/features/metrics-api).
|
|
5941
|
+
*
|
|
5942
|
+
* @param {LangfuseAPI.legacy.GetMetricsRequest} request
|
|
5943
|
+
* @param {MetricsV1.RequestOptions} requestOptions - Request-specific configuration.
|
|
5944
|
+
*
|
|
5945
|
+
* @throws {@link LangfuseAPI.Error}
|
|
5946
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
5947
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
5948
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
5949
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
5950
|
+
*
|
|
5951
|
+
* @example
|
|
5952
|
+
* await client.legacy.metricsV1.metrics({
|
|
5953
|
+
* query: "query"
|
|
5954
|
+
* })
|
|
5955
|
+
*/
|
|
5956
|
+
metrics(request: GetMetricsRequest, requestOptions?: MetricsV1.RequestOptions): HttpResponsePromise<MetricsResponse>;
|
|
5957
|
+
private __metrics;
|
|
5958
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
5959
|
+
}
|
|
5960
|
+
|
|
5961
|
+
/**
|
|
5962
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
5963
|
+
*/
|
|
5964
|
+
|
|
5965
|
+
declare namespace ObservationsV1 {
|
|
5966
|
+
interface Options {
|
|
5967
|
+
environment: Supplier<string>;
|
|
5968
|
+
/** Specify a custom URL to connect the client to. */
|
|
5969
|
+
baseUrl?: Supplier<string>;
|
|
5970
|
+
username?: Supplier<string | undefined>;
|
|
5971
|
+
password?: Supplier<string | undefined>;
|
|
5972
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
5973
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
5974
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
5975
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
5976
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
5977
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
5978
|
+
/** Additional headers to include in requests. */
|
|
5979
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
5980
|
+
}
|
|
5981
|
+
interface RequestOptions {
|
|
5982
|
+
/** The maximum time to wait for a response in seconds. */
|
|
5983
|
+
timeoutInSeconds?: number;
|
|
5984
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
5985
|
+
maxRetries?: number;
|
|
5986
|
+
/** A hook to abort the request. */
|
|
5987
|
+
abortSignal?: AbortSignal;
|
|
5988
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
5989
|
+
xLangfuseSdkName?: string | undefined;
|
|
5990
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
5991
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
5992
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
5993
|
+
xLangfusePublicKey?: string | undefined;
|
|
5994
|
+
/** Additional query string parameters to include in the request. */
|
|
5995
|
+
queryParams?: Record<string, unknown>;
|
|
5996
|
+
/** Additional headers to include in the request. */
|
|
5997
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
5998
|
+
}
|
|
5999
|
+
}
|
|
6000
|
+
declare class ObservationsV1 {
|
|
6001
|
+
protected readonly _options: ObservationsV1.Options;
|
|
6002
|
+
constructor(_options: ObservationsV1.Options);
|
|
6003
|
+
/**
|
|
6004
|
+
* Get a observation
|
|
6005
|
+
*
|
|
6006
|
+
* @param {string} observationId - The unique langfuse identifier of an observation, can be an event, span or generation
|
|
6007
|
+
* @param {ObservationsV1.RequestOptions} requestOptions - Request-specific configuration.
|
|
6008
|
+
*
|
|
6009
|
+
* @throws {@link LangfuseAPI.Error}
|
|
6010
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
6011
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
6012
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
6013
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
6014
|
+
*
|
|
6015
|
+
* @example
|
|
6016
|
+
* await client.legacy.observationsV1.get("observationId")
|
|
6017
|
+
*/
|
|
6018
|
+
get(observationId: string, requestOptions?: ObservationsV1.RequestOptions): HttpResponsePromise<ObservationsView>;
|
|
6019
|
+
private __get;
|
|
6020
|
+
/**
|
|
6021
|
+
* Get a list of observations.
|
|
6022
|
+
*
|
|
6023
|
+
* Consider using the [v2 observations endpoint](/api-reference#tag/observationsv2/GET/api/public/v2/observations) for cursor-based pagination and field selection.
|
|
6024
|
+
*
|
|
6025
|
+
* @param {LangfuseAPI.legacy.GetObservationsRequest} request
|
|
6026
|
+
* @param {ObservationsV1.RequestOptions} requestOptions - Request-specific configuration.
|
|
6027
|
+
*
|
|
6028
|
+
* @throws {@link LangfuseAPI.Error}
|
|
6029
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
6030
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
6031
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
6032
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
6033
|
+
*
|
|
6034
|
+
* @example
|
|
6035
|
+
* await client.legacy.observationsV1.getMany()
|
|
6036
|
+
*/
|
|
6037
|
+
getMany(request?: GetObservationsRequest, requestOptions?: ObservationsV1.RequestOptions): HttpResponsePromise<ObservationsViews>;
|
|
6038
|
+
private __getMany;
|
|
6039
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
6040
|
+
}
|
|
6041
|
+
|
|
6042
|
+
/**
|
|
6043
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6044
|
+
*/
|
|
6045
|
+
|
|
6046
|
+
declare namespace ScoreV1 {
|
|
6047
|
+
interface Options {
|
|
6048
|
+
environment: Supplier<string>;
|
|
6049
|
+
/** Specify a custom URL to connect the client to. */
|
|
6050
|
+
baseUrl?: Supplier<string>;
|
|
6051
|
+
username?: Supplier<string | undefined>;
|
|
6052
|
+
password?: Supplier<string | undefined>;
|
|
6053
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
6054
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
6055
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
6056
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
6057
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
6058
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
6059
|
+
/** Additional headers to include in requests. */
|
|
6060
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6061
|
+
}
|
|
6062
|
+
interface RequestOptions {
|
|
6063
|
+
/** The maximum time to wait for a response in seconds. */
|
|
6064
|
+
timeoutInSeconds?: number;
|
|
6065
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
6066
|
+
maxRetries?: number;
|
|
6067
|
+
/** A hook to abort the request. */
|
|
6068
|
+
abortSignal?: AbortSignal;
|
|
6069
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
6070
|
+
xLangfuseSdkName?: string | undefined;
|
|
6071
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
6072
|
+
xLangfuseSdkVersion?: string | undefined;
|
|
6073
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
6074
|
+
xLangfusePublicKey?: string | undefined;
|
|
6075
|
+
/** Additional query string parameters to include in the request. */
|
|
6076
|
+
queryParams?: Record<string, unknown>;
|
|
6077
|
+
/** Additional headers to include in the request. */
|
|
6078
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6079
|
+
}
|
|
6080
|
+
}
|
|
6081
|
+
declare class ScoreV1 {
|
|
6082
|
+
protected readonly _options: ScoreV1.Options;
|
|
6083
|
+
constructor(_options: ScoreV1.Options);
|
|
6084
|
+
/**
|
|
6085
|
+
* Create a score (supports both trace and session scores)
|
|
6086
|
+
*
|
|
6087
|
+
* @param {LangfuseAPI.legacy.CreateScoreRequest} request
|
|
6088
|
+
* @param {ScoreV1.RequestOptions} requestOptions - Request-specific configuration.
|
|
6089
|
+
*
|
|
6090
|
+
* @throws {@link LangfuseAPI.Error}
|
|
6091
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
6092
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
6093
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
6094
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
6095
|
+
*
|
|
6096
|
+
* @example
|
|
6097
|
+
* await client.legacy.scoreV1.create({
|
|
6098
|
+
* id: undefined,
|
|
6099
|
+
* traceId: undefined,
|
|
6100
|
+
* sessionId: undefined,
|
|
6101
|
+
* observationId: undefined,
|
|
6102
|
+
* datasetRunId: undefined,
|
|
6103
|
+
* name: "name",
|
|
6104
|
+
* value: 1.1,
|
|
6105
|
+
* comment: undefined,
|
|
6106
|
+
* metadata: undefined,
|
|
6107
|
+
* environment: undefined,
|
|
6108
|
+
* queueId: undefined,
|
|
6109
|
+
* dataType: undefined,
|
|
6110
|
+
* configId: undefined
|
|
6111
|
+
* })
|
|
6112
|
+
*/
|
|
6113
|
+
create(request: CreateScoreRequest, requestOptions?: ScoreV1.RequestOptions): HttpResponsePromise<CreateScoreResponse>;
|
|
6114
|
+
private __create;
|
|
6115
|
+
/**
|
|
6116
|
+
* Delete a score (supports both trace and session scores)
|
|
6117
|
+
*
|
|
6118
|
+
* @param {string} scoreId - The unique langfuse identifier of a score
|
|
6119
|
+
* @param {ScoreV1.RequestOptions} requestOptions - Request-specific configuration.
|
|
6120
|
+
*
|
|
6121
|
+
* @throws {@link LangfuseAPI.Error}
|
|
6122
|
+
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
6123
|
+
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
6124
|
+
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
6125
|
+
* @throws {@link LangfuseAPI.NotFoundError}
|
|
6126
|
+
*
|
|
6127
|
+
* @example
|
|
6128
|
+
* await client.legacy.scoreV1.delete("scoreId")
|
|
6129
|
+
*/
|
|
6130
|
+
delete(scoreId: string, requestOptions?: ScoreV1.RequestOptions): HttpResponsePromise<void>;
|
|
6131
|
+
private __delete;
|
|
6132
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
6133
|
+
}
|
|
6134
|
+
|
|
6135
|
+
/**
|
|
6136
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
6137
|
+
*/
|
|
6138
|
+
|
|
6139
|
+
declare namespace Legacy {
|
|
6140
|
+
interface Options {
|
|
6141
|
+
environment: Supplier<string>;
|
|
6142
|
+
/** Specify a custom URL to connect the client to. */
|
|
6143
|
+
baseUrl?: Supplier<string>;
|
|
6144
|
+
username?: Supplier<string | undefined>;
|
|
6145
|
+
password?: Supplier<string | undefined>;
|
|
6146
|
+
/** Override the X-Langfuse-Sdk-Name header */
|
|
6147
|
+
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
6148
|
+
/** Override the X-Langfuse-Sdk-Version header */
|
|
6149
|
+
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
6150
|
+
/** Override the X-Langfuse-Public-Key header */
|
|
6151
|
+
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
6152
|
+
/** Additional headers to include in requests. */
|
|
6153
|
+
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6154
|
+
}
|
|
6155
|
+
}
|
|
6156
|
+
declare class Legacy {
|
|
6157
|
+
protected readonly _options: Legacy.Options;
|
|
6158
|
+
protected _metricsV1: MetricsV1 | undefined;
|
|
6159
|
+
protected _observationsV1: ObservationsV1 | undefined;
|
|
6160
|
+
protected _scoreV1: ScoreV1 | undefined;
|
|
6161
|
+
constructor(_options: Legacy.Options);
|
|
6162
|
+
get metricsV1(): MetricsV1;
|
|
6163
|
+
get observationsV1(): ObservationsV1;
|
|
6164
|
+
get scoreV1(): ScoreV1;
|
|
6165
|
+
}
|
|
6166
|
+
|
|
5883
6167
|
/**
|
|
5884
6168
|
* This file was auto-generated by Fern from our API Definition.
|
|
5885
6169
|
*/
|
|
@@ -6081,7 +6365,7 @@ declare class Media {
|
|
|
6081
6365
|
* This file was auto-generated by Fern from our API Definition.
|
|
6082
6366
|
*/
|
|
6083
6367
|
|
|
6084
|
-
declare namespace
|
|
6368
|
+
declare namespace Metrics {
|
|
6085
6369
|
interface Options {
|
|
6086
6370
|
environment: Supplier<string>;
|
|
6087
6371
|
/** Specify a custom URL to connect the client to. */
|
|
@@ -6116,9 +6400,9 @@ declare namespace MetricsV2 {
|
|
|
6116
6400
|
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6117
6401
|
}
|
|
6118
6402
|
}
|
|
6119
|
-
declare class
|
|
6120
|
-
protected readonly _options:
|
|
6121
|
-
constructor(_options:
|
|
6403
|
+
declare class Metrics {
|
|
6404
|
+
protected readonly _options: Metrics.Options;
|
|
6405
|
+
constructor(_options: Metrics.Options);
|
|
6122
6406
|
/**
|
|
6123
6407
|
* Get metrics from the Langfuse project using a query object. V2 endpoint with optimized performance.
|
|
6124
6408
|
*
|
|
@@ -6223,74 +6507,6 @@ declare class MetricsV2 {
|
|
|
6223
6507
|
* - `auto` bins the data into approximately 50 buckets based on the time range
|
|
6224
6508
|
*
|
|
6225
6509
|
* @param {LangfuseAPI.GetMetricsV2Request} request
|
|
6226
|
-
* @param {MetricsV2.RequestOptions} requestOptions - Request-specific configuration.
|
|
6227
|
-
*
|
|
6228
|
-
* @throws {@link LangfuseAPI.Error}
|
|
6229
|
-
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
6230
|
-
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
6231
|
-
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
6232
|
-
* @throws {@link LangfuseAPI.NotFoundError}
|
|
6233
|
-
*
|
|
6234
|
-
* @example
|
|
6235
|
-
* await client.metricsV2.metrics({
|
|
6236
|
-
* query: "query"
|
|
6237
|
-
* })
|
|
6238
|
-
*/
|
|
6239
|
-
metrics(request: GetMetricsV2Request, requestOptions?: MetricsV2.RequestOptions): HttpResponsePromise<MetricsV2Response>;
|
|
6240
|
-
private __metrics;
|
|
6241
|
-
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
6242
|
-
}
|
|
6243
|
-
|
|
6244
|
-
/**
|
|
6245
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
6246
|
-
*/
|
|
6247
|
-
|
|
6248
|
-
declare namespace Metrics {
|
|
6249
|
-
interface Options {
|
|
6250
|
-
environment: Supplier<string>;
|
|
6251
|
-
/** Specify a custom URL to connect the client to. */
|
|
6252
|
-
baseUrl?: Supplier<string>;
|
|
6253
|
-
username?: Supplier<string | undefined>;
|
|
6254
|
-
password?: Supplier<string | undefined>;
|
|
6255
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
6256
|
-
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
6257
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
6258
|
-
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
6259
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
6260
|
-
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
6261
|
-
/** Additional headers to include in requests. */
|
|
6262
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6263
|
-
}
|
|
6264
|
-
interface RequestOptions {
|
|
6265
|
-
/** The maximum time to wait for a response in seconds. */
|
|
6266
|
-
timeoutInSeconds?: number;
|
|
6267
|
-
/** The number of times to retry the request. Defaults to 2. */
|
|
6268
|
-
maxRetries?: number;
|
|
6269
|
-
/** A hook to abort the request. */
|
|
6270
|
-
abortSignal?: AbortSignal;
|
|
6271
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
6272
|
-
xLangfuseSdkName?: string | undefined;
|
|
6273
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
6274
|
-
xLangfuseSdkVersion?: string | undefined;
|
|
6275
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
6276
|
-
xLangfusePublicKey?: string | undefined;
|
|
6277
|
-
/** Additional query string parameters to include in the request. */
|
|
6278
|
-
queryParams?: Record<string, unknown>;
|
|
6279
|
-
/** Additional headers to include in the request. */
|
|
6280
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6281
|
-
}
|
|
6282
|
-
}
|
|
6283
|
-
declare class Metrics {
|
|
6284
|
-
protected readonly _options: Metrics.Options;
|
|
6285
|
-
constructor(_options: Metrics.Options);
|
|
6286
|
-
/**
|
|
6287
|
-
* Get metrics from the Langfuse project using a query object.
|
|
6288
|
-
*
|
|
6289
|
-
* Consider using the [v2 metrics endpoint](/api-reference#tag/metricsv2/GET/api/public/v2/metrics) for better performance.
|
|
6290
|
-
*
|
|
6291
|
-
* For more details, see the [Metrics API documentation](https://langfuse.com/docs/metrics/features/metrics-api).
|
|
6292
|
-
*
|
|
6293
|
-
* @param {LangfuseAPI.GetMetricsRequest} request
|
|
6294
6510
|
* @param {Metrics.RequestOptions} requestOptions - Request-specific configuration.
|
|
6295
6511
|
*
|
|
6296
6512
|
* @throws {@link LangfuseAPI.Error}
|
|
@@ -6304,7 +6520,7 @@ declare class Metrics {
|
|
|
6304
6520
|
* query: "query"
|
|
6305
6521
|
* })
|
|
6306
6522
|
*/
|
|
6307
|
-
metrics(request:
|
|
6523
|
+
metrics(request: GetMetricsV2Request, requestOptions?: Metrics.RequestOptions): HttpResponsePromise<MetricsV2Response>;
|
|
6308
6524
|
private __metrics;
|
|
6309
6525
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
6310
6526
|
}
|
|
@@ -6437,7 +6653,7 @@ declare class Models {
|
|
|
6437
6653
|
* This file was auto-generated by Fern from our API Definition.
|
|
6438
6654
|
*/
|
|
6439
6655
|
|
|
6440
|
-
declare namespace
|
|
6656
|
+
declare namespace Observations {
|
|
6441
6657
|
interface Options {
|
|
6442
6658
|
environment: Supplier<string>;
|
|
6443
6659
|
/** Specify a custom URL to connect the client to. */
|
|
@@ -6472,9 +6688,9 @@ declare namespace ObservationsV2 {
|
|
|
6472
6688
|
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6473
6689
|
}
|
|
6474
6690
|
}
|
|
6475
|
-
declare class
|
|
6476
|
-
protected readonly _options:
|
|
6477
|
-
constructor(_options:
|
|
6691
|
+
declare class Observations {
|
|
6692
|
+
protected readonly _options: Observations.Options;
|
|
6693
|
+
constructor(_options: Observations.Options);
|
|
6478
6694
|
/**
|
|
6479
6695
|
* Get a list of observations with cursor-based pagination and flexible field selection.
|
|
6480
6696
|
*
|
|
@@ -6502,87 +6718,6 @@ declare class ObservationsV2 {
|
|
|
6502
6718
|
* When using the `filter` parameter, it takes precedence over individual query parameter filters.
|
|
6503
6719
|
*
|
|
6504
6720
|
* @param {LangfuseAPI.GetObservationsV2Request} request
|
|
6505
|
-
* @param {ObservationsV2.RequestOptions} requestOptions - Request-specific configuration.
|
|
6506
|
-
*
|
|
6507
|
-
* @throws {@link LangfuseAPI.Error}
|
|
6508
|
-
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
6509
|
-
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
6510
|
-
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
6511
|
-
* @throws {@link LangfuseAPI.NotFoundError}
|
|
6512
|
-
*
|
|
6513
|
-
* @example
|
|
6514
|
-
* await client.observationsV2.getMany()
|
|
6515
|
-
*/
|
|
6516
|
-
getMany(request?: GetObservationsV2Request, requestOptions?: ObservationsV2.RequestOptions): HttpResponsePromise<ObservationsV2Response>;
|
|
6517
|
-
private __getMany;
|
|
6518
|
-
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
6519
|
-
}
|
|
6520
|
-
|
|
6521
|
-
/**
|
|
6522
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
6523
|
-
*/
|
|
6524
|
-
|
|
6525
|
-
declare namespace Observations {
|
|
6526
|
-
interface Options {
|
|
6527
|
-
environment: Supplier<string>;
|
|
6528
|
-
/** Specify a custom URL to connect the client to. */
|
|
6529
|
-
baseUrl?: Supplier<string>;
|
|
6530
|
-
username?: Supplier<string | undefined>;
|
|
6531
|
-
password?: Supplier<string | undefined>;
|
|
6532
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
6533
|
-
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
6534
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
6535
|
-
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
6536
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
6537
|
-
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
6538
|
-
/** Additional headers to include in requests. */
|
|
6539
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6540
|
-
}
|
|
6541
|
-
interface RequestOptions {
|
|
6542
|
-
/** The maximum time to wait for a response in seconds. */
|
|
6543
|
-
timeoutInSeconds?: number;
|
|
6544
|
-
/** The number of times to retry the request. Defaults to 2. */
|
|
6545
|
-
maxRetries?: number;
|
|
6546
|
-
/** A hook to abort the request. */
|
|
6547
|
-
abortSignal?: AbortSignal;
|
|
6548
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
6549
|
-
xLangfuseSdkName?: string | undefined;
|
|
6550
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
6551
|
-
xLangfuseSdkVersion?: string | undefined;
|
|
6552
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
6553
|
-
xLangfusePublicKey?: string | undefined;
|
|
6554
|
-
/** Additional query string parameters to include in the request. */
|
|
6555
|
-
queryParams?: Record<string, unknown>;
|
|
6556
|
-
/** Additional headers to include in the request. */
|
|
6557
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
6558
|
-
}
|
|
6559
|
-
}
|
|
6560
|
-
declare class Observations {
|
|
6561
|
-
protected readonly _options: Observations.Options;
|
|
6562
|
-
constructor(_options: Observations.Options);
|
|
6563
|
-
/**
|
|
6564
|
-
* Get a observation
|
|
6565
|
-
*
|
|
6566
|
-
* @param {string} observationId - The unique langfuse identifier of an observation, can be an event, span or generation
|
|
6567
|
-
* @param {Observations.RequestOptions} requestOptions - Request-specific configuration.
|
|
6568
|
-
*
|
|
6569
|
-
* @throws {@link LangfuseAPI.Error}
|
|
6570
|
-
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
6571
|
-
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
6572
|
-
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
6573
|
-
* @throws {@link LangfuseAPI.NotFoundError}
|
|
6574
|
-
*
|
|
6575
|
-
* @example
|
|
6576
|
-
* await client.observations.get("observationId")
|
|
6577
|
-
*/
|
|
6578
|
-
get(observationId: string, requestOptions?: Observations.RequestOptions): HttpResponsePromise<ObservationsView>;
|
|
6579
|
-
private __get;
|
|
6580
|
-
/**
|
|
6581
|
-
* Get a list of observations.
|
|
6582
|
-
*
|
|
6583
|
-
* Consider using the [v2 observations endpoint](/api-reference#tag/observationsv2/GET/api/public/v2/observations) for cursor-based pagination and field selection.
|
|
6584
|
-
*
|
|
6585
|
-
* @param {LangfuseAPI.GetObservationsRequest} request
|
|
6586
6721
|
* @param {Observations.RequestOptions} requestOptions - Request-specific configuration.
|
|
6587
6722
|
*
|
|
6588
6723
|
* @throws {@link LangfuseAPI.Error}
|
|
@@ -6594,7 +6729,7 @@ declare class Observations {
|
|
|
6594
6729
|
* @example
|
|
6595
6730
|
* await client.observations.getMany()
|
|
6596
6731
|
*/
|
|
6597
|
-
getMany(request?:
|
|
6732
|
+
getMany(request?: GetObservationsV2Request, requestOptions?: Observations.RequestOptions): HttpResponsePromise<ObservationsV2Response>;
|
|
6598
6733
|
private __getMany;
|
|
6599
6734
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
6600
6735
|
}
|
|
@@ -7581,7 +7716,7 @@ declare class ScoreConfigs {
|
|
|
7581
7716
|
* This file was auto-generated by Fern from our API Definition.
|
|
7582
7717
|
*/
|
|
7583
7718
|
|
|
7584
|
-
declare namespace
|
|
7719
|
+
declare namespace Scores {
|
|
7585
7720
|
interface Options {
|
|
7586
7721
|
environment: Supplier<string>;
|
|
7587
7722
|
/** Specify a custom URL to connect the client to. */
|
|
@@ -7616,14 +7751,14 @@ declare namespace ScoreV2 {
|
|
|
7616
7751
|
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
7617
7752
|
}
|
|
7618
7753
|
}
|
|
7619
|
-
declare class
|
|
7620
|
-
protected readonly _options:
|
|
7621
|
-
constructor(_options:
|
|
7754
|
+
declare class Scores {
|
|
7755
|
+
protected readonly _options: Scores.Options;
|
|
7756
|
+
constructor(_options: Scores.Options);
|
|
7622
7757
|
/**
|
|
7623
7758
|
* Get a list of scores (supports both trace and session scores)
|
|
7624
7759
|
*
|
|
7625
7760
|
* @param {LangfuseAPI.GetScoresRequest} request
|
|
7626
|
-
* @param {
|
|
7761
|
+
* @param {Scores.RequestOptions} requestOptions - Request-specific configuration.
|
|
7627
7762
|
*
|
|
7628
7763
|
* @throws {@link LangfuseAPI.Error}
|
|
7629
7764
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
@@ -7632,15 +7767,15 @@ declare class ScoreV2 {
|
|
|
7632
7767
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
7633
7768
|
*
|
|
7634
7769
|
* @example
|
|
7635
|
-
* await client.
|
|
7770
|
+
* await client.scores.getMany()
|
|
7636
7771
|
*/
|
|
7637
|
-
|
|
7638
|
-
private
|
|
7772
|
+
getMany(request?: GetScoresRequest, requestOptions?: Scores.RequestOptions): HttpResponsePromise<GetScoresResponse>;
|
|
7773
|
+
private __getMany;
|
|
7639
7774
|
/**
|
|
7640
7775
|
* Get a score (supports both trace and session scores)
|
|
7641
7776
|
*
|
|
7642
7777
|
* @param {string} scoreId - The unique langfuse identifier of a score
|
|
7643
|
-
* @param {
|
|
7778
|
+
* @param {Scores.RequestOptions} requestOptions - Request-specific configuration.
|
|
7644
7779
|
*
|
|
7645
7780
|
* @throws {@link LangfuseAPI.Error}
|
|
7646
7781
|
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
@@ -7649,106 +7784,13 @@ declare class ScoreV2 {
|
|
|
7649
7784
|
* @throws {@link LangfuseAPI.NotFoundError}
|
|
7650
7785
|
*
|
|
7651
7786
|
* @example
|
|
7652
|
-
* await client.
|
|
7787
|
+
* await client.scores.getById("scoreId")
|
|
7653
7788
|
*/
|
|
7654
|
-
getById(scoreId: string, requestOptions?:
|
|
7789
|
+
getById(scoreId: string, requestOptions?: Scores.RequestOptions): HttpResponsePromise<Score>;
|
|
7655
7790
|
private __getById;
|
|
7656
7791
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
7657
7792
|
}
|
|
7658
7793
|
|
|
7659
|
-
/**
|
|
7660
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
7661
|
-
*/
|
|
7662
|
-
|
|
7663
|
-
declare namespace Score {
|
|
7664
|
-
interface Options {
|
|
7665
|
-
environment: Supplier<string>;
|
|
7666
|
-
/** Specify a custom URL to connect the client to. */
|
|
7667
|
-
baseUrl?: Supplier<string>;
|
|
7668
|
-
username?: Supplier<string | undefined>;
|
|
7669
|
-
password?: Supplier<string | undefined>;
|
|
7670
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
7671
|
-
xLangfuseSdkName?: Supplier<string | undefined>;
|
|
7672
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
7673
|
-
xLangfuseSdkVersion?: Supplier<string | undefined>;
|
|
7674
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
7675
|
-
xLangfusePublicKey?: Supplier<string | undefined>;
|
|
7676
|
-
/** Additional headers to include in requests. */
|
|
7677
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
7678
|
-
}
|
|
7679
|
-
interface RequestOptions {
|
|
7680
|
-
/** The maximum time to wait for a response in seconds. */
|
|
7681
|
-
timeoutInSeconds?: number;
|
|
7682
|
-
/** The number of times to retry the request. Defaults to 2. */
|
|
7683
|
-
maxRetries?: number;
|
|
7684
|
-
/** A hook to abort the request. */
|
|
7685
|
-
abortSignal?: AbortSignal;
|
|
7686
|
-
/** Override the X-Langfuse-Sdk-Name header */
|
|
7687
|
-
xLangfuseSdkName?: string | undefined;
|
|
7688
|
-
/** Override the X-Langfuse-Sdk-Version header */
|
|
7689
|
-
xLangfuseSdkVersion?: string | undefined;
|
|
7690
|
-
/** Override the X-Langfuse-Public-Key header */
|
|
7691
|
-
xLangfusePublicKey?: string | undefined;
|
|
7692
|
-
/** Additional query string parameters to include in the request. */
|
|
7693
|
-
queryParams?: Record<string, unknown>;
|
|
7694
|
-
/** Additional headers to include in the request. */
|
|
7695
|
-
headers?: Record<string, string | Supplier<string | null | undefined> | null | undefined>;
|
|
7696
|
-
}
|
|
7697
|
-
}
|
|
7698
|
-
declare class Score {
|
|
7699
|
-
protected readonly _options: Score.Options;
|
|
7700
|
-
constructor(_options: Score.Options);
|
|
7701
|
-
/**
|
|
7702
|
-
* Create a score (supports both trace and session scores)
|
|
7703
|
-
*
|
|
7704
|
-
* @param {LangfuseAPI.CreateScoreRequest} request
|
|
7705
|
-
* @param {Score.RequestOptions} requestOptions - Request-specific configuration.
|
|
7706
|
-
*
|
|
7707
|
-
* @throws {@link LangfuseAPI.Error}
|
|
7708
|
-
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
7709
|
-
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
7710
|
-
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
7711
|
-
* @throws {@link LangfuseAPI.NotFoundError}
|
|
7712
|
-
*
|
|
7713
|
-
* @example
|
|
7714
|
-
* await client.score.create({
|
|
7715
|
-
* id: undefined,
|
|
7716
|
-
* traceId: undefined,
|
|
7717
|
-
* sessionId: undefined,
|
|
7718
|
-
* observationId: undefined,
|
|
7719
|
-
* datasetRunId: undefined,
|
|
7720
|
-
* name: "name",
|
|
7721
|
-
* value: 1.1,
|
|
7722
|
-
* comment: undefined,
|
|
7723
|
-
* metadata: undefined,
|
|
7724
|
-
* environment: undefined,
|
|
7725
|
-
* queueId: undefined,
|
|
7726
|
-
* dataType: undefined,
|
|
7727
|
-
* configId: undefined
|
|
7728
|
-
* })
|
|
7729
|
-
*/
|
|
7730
|
-
create(request: CreateScoreRequest, requestOptions?: Score.RequestOptions): HttpResponsePromise<CreateScoreResponse>;
|
|
7731
|
-
private __create;
|
|
7732
|
-
/**
|
|
7733
|
-
* Delete a score (supports both trace and session scores)
|
|
7734
|
-
*
|
|
7735
|
-
* @param {string} scoreId - The unique langfuse identifier of a score
|
|
7736
|
-
* @param {Score.RequestOptions} requestOptions - Request-specific configuration.
|
|
7737
|
-
*
|
|
7738
|
-
* @throws {@link LangfuseAPI.Error}
|
|
7739
|
-
* @throws {@link LangfuseAPI.UnauthorizedError}
|
|
7740
|
-
* @throws {@link LangfuseAPI.AccessDeniedError}
|
|
7741
|
-
* @throws {@link LangfuseAPI.MethodNotAllowedError}
|
|
7742
|
-
* @throws {@link LangfuseAPI.NotFoundError}
|
|
7743
|
-
*
|
|
7744
|
-
* @example
|
|
7745
|
-
* await client.score.delete("scoreId")
|
|
7746
|
-
*/
|
|
7747
|
-
delete(scoreId: string, requestOptions?: Score.RequestOptions): HttpResponsePromise<void>;
|
|
7748
|
-
private __delete;
|
|
7749
|
-
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
7750
|
-
}
|
|
7751
|
-
|
|
7752
7794
|
/**
|
|
7753
7795
|
* This file was auto-generated by Fern from our API Definition.
|
|
7754
7796
|
*/
|
|
@@ -7992,12 +8034,11 @@ declare class LangfuseAPIClient {
|
|
|
7992
8034
|
protected _datasets: Datasets | undefined;
|
|
7993
8035
|
protected _health: Health | undefined;
|
|
7994
8036
|
protected _ingestion: Ingestion | undefined;
|
|
8037
|
+
protected _legacy: Legacy | undefined;
|
|
7995
8038
|
protected _llmConnections: LlmConnections | undefined;
|
|
7996
8039
|
protected _media: Media | undefined;
|
|
7997
|
-
protected _metricsV2: MetricsV2 | undefined;
|
|
7998
8040
|
protected _metrics: Metrics | undefined;
|
|
7999
8041
|
protected _models: Models | undefined;
|
|
8000
|
-
protected _observationsV2: ObservationsV2 | undefined;
|
|
8001
8042
|
protected _observations: Observations | undefined;
|
|
8002
8043
|
protected _opentelemetry: Opentelemetry | undefined;
|
|
8003
8044
|
protected _organizations: Organizations | undefined;
|
|
@@ -8006,8 +8047,7 @@ declare class LangfuseAPIClient {
|
|
|
8006
8047
|
protected _prompts: Prompts | undefined;
|
|
8007
8048
|
protected _scim: Scim | undefined;
|
|
8008
8049
|
protected _scoreConfigs: ScoreConfigs | undefined;
|
|
8009
|
-
protected
|
|
8010
|
-
protected _score: Score | undefined;
|
|
8050
|
+
protected _scores: Scores | undefined;
|
|
8011
8051
|
protected _sessions: Sessions | undefined;
|
|
8012
8052
|
protected _trace: Trace | undefined;
|
|
8013
8053
|
constructor(_options: LangfuseAPIClient.Options);
|
|
@@ -8019,12 +8059,11 @@ declare class LangfuseAPIClient {
|
|
|
8019
8059
|
get datasets(): Datasets;
|
|
8020
8060
|
get health(): Health;
|
|
8021
8061
|
get ingestion(): Ingestion;
|
|
8062
|
+
get legacy(): Legacy;
|
|
8022
8063
|
get llmConnections(): LlmConnections;
|
|
8023
8064
|
get media(): Media;
|
|
8024
|
-
get metricsV2(): MetricsV2;
|
|
8025
8065
|
get metrics(): Metrics;
|
|
8026
8066
|
get models(): Models;
|
|
8027
|
-
get observationsV2(): ObservationsV2;
|
|
8028
8067
|
get observations(): Observations;
|
|
8029
8068
|
get opentelemetry(): Opentelemetry;
|
|
8030
8069
|
get organizations(): Organizations;
|
|
@@ -8033,8 +8072,7 @@ declare class LangfuseAPIClient {
|
|
|
8033
8072
|
get prompts(): Prompts;
|
|
8034
8073
|
get scim(): Scim;
|
|
8035
8074
|
get scoreConfigs(): ScoreConfigs;
|
|
8036
|
-
get
|
|
8037
|
-
get score(): Score;
|
|
8075
|
+
get scores(): Scores;
|
|
8038
8076
|
get sessions(): Sessions;
|
|
8039
8077
|
get trace(): Trace;
|
|
8040
8078
|
}
|
|
@@ -8406,4 +8444,4 @@ interface PropagateAttributesParams {
|
|
|
8406
8444
|
declare function propagateAttributes<A extends unknown[], F extends (...args: A) => ReturnType<F>>(params: PropagateAttributesParams, fn: F): ReturnType<F>;
|
|
8407
8445
|
declare function getPropagatedAttributesFromContext(context: Context): Record<string, string | string[]>;
|
|
8408
8446
|
|
|
8409
|
-
export { 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, BlobStorageExportFrequency, BlobStorageExportMode, type BlobStorageIntegrationDeletionResponse, BlobStorageIntegrationFileType, type BlobStorageIntegrationResponse, BlobStorageIntegrationType, type BlobStorageIntegrationsResponse, type BooleanScore, type BooleanScoreV1, type BulkConfig, type CategoricalScore, type CategoricalScoreV1, type ChatMessage, ChatMessageType, type ChatMessageWithPlaceholders, type ChatPrompt, type Comment, CommentObjectType, type ConfigCategory, type CorrectionScore, 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
|
|
8447
|
+
export { 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, BlobStorageExportFrequency, BlobStorageExportMode, type BlobStorageIntegrationDeletionResponse, BlobStorageIntegrationFileType, type BlobStorageIntegrationResponse, BlobStorageIntegrationType, type BlobStorageIntegrationsResponse, type BooleanScore, type BooleanScoreV1, type BulkConfig, type CategoricalScore, type CategoricalScoreV1, type ChatMessage, ChatMessageType, type ChatMessageWithPlaceholders, type ChatPrompt, type Comment, CommentObjectType, type ConfigCategory, type CorrectionScore, 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 DatasetRun, type DatasetRunItem, type DatasetRunWithItems, DatasetStatus, type DeleteAnnotationQueueAssignmentResponse, type DeleteAnnotationQueueItemResponse, type DeleteDatasetItemResponse, type DeleteDatasetRunResponse, 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 GetScoresResponseTraceData, type GetSessionsRequest, 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, LangfuseAPIClient, LangfuseAPIError, LangfuseAPITimeoutError, LangfuseMedia, type LangfuseMediaParams, 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, type MetricsV2Response, type Model, type ModelPrice, ModelUsageUnit, NotFoundError, type NumericScore, type NumericScoreV1, 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, ScoreV1$1 as ScoreV1, type SdkLogBody, type SdkLogEvent, type ServiceProviderConfig, ServiceUnavailableError, type Session, type SessionWithTraces, type Sort, type TextPrompt, type Trace$1 as Trace, type TraceBody, type TraceEvent, type TraceWithDetails, type TraceWithFullDetails, type Traces, UnauthorizedError, type UpdateAnnotationQueueItemRequest, type UpdateEventBody, type UpdateGenerationBody, type UpdateGenerationEvent, type UpdateObservationEvent, type UpdateProjectRequest, type UpdatePromptRequest, type UpdateScoreConfigRequest, type UpdateSpanBody, type UpdateSpanEvent, type UpsertLlmConnectionRequest, type Usage, type UsageDetails, type UserMeta, index$t as annotationQueues, base64Decode, base64Encode, base64ToBytes, index$s as blobStorageIntegrations, bytesToBase64, index$r as comments, index$q as commons, configureGlobalLogger, createExperimentId, createExperimentItemId, createLogger, index$p as datasetItems, index$o as datasetRunItems, index$n as datasets, generateUUID, getEnv, getGlobalLogger, getPropagatedAttributesFromContext, index$m as health, index$l as ingestion, index$h as legacy, index$g as llmConnections, LoggerSingleton as logger, index$f as media, index$e as metrics, index$d as models, index$c as observations, index$b as opentelemetry, index$a as organizations, index$9 as projects, index as promptVersion, index$8 as prompts, propagateAttributes, resetGlobalLogger, safeSetTimeout, index$7 as scim, index$6 as scoreConfigs, index$5 as scores, serializeValue, index$4 as sessions, index$3 as trace, index$1 as utils };
|