scorecard-ai 0.5.2 → 0.5.4

package/dist/api/resources/score/client/requests/ScoreCreateParams.d.ts

@@ -10,7 +10,10 @@
 export interface ScoreCreateParams {
     /** The ID of the metric */
     metricId: number;
+    /** Specify integer scores. */
     intScore?: number;
+    /** Specify boolean scores. */
     binaryScore?: boolean;
+    /** The reasoning for the assigned score. */
     reasoning?: string;
 }

package/dist/api/resources/score/client/requests/ScoreUpdateParams.d.ts

@@ -6,7 +6,10 @@
  *     {}
  */
 export interface ScoreUpdateParams {
+    /** The new integer score to assign. */
     intScore?: number;
+    /** The new boolean score to assign. */
     binaryScore?: boolean;
+    /** The reasoning for the score update. */
     reasoning?: string;
 }

package/dist/api/resources/testcase/client/Client.js

@@ -70,7 +70,7 @@ class Testcase {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/testset/${encodeURIComponent(testsetId)}/testcase`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.TestcaseCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -163,7 +163,7 @@ class Testcase {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/testset/${encodeURIComponent(testsetId)}/testcase/${encodeURIComponent(testcaseId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -255,7 +255,7 @@ class Testcase {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/testset/${encodeURIComponent(testsetId)}/testcase/${encodeURIComponent(testcaseId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,

package/dist/api/resources/testcase/client/requests/TestcaseCreateParams.d.ts

@@ -9,7 +9,9 @@ import * as Scorecard from "../../../../index";
 export interface TestcaseCreateParams {
     /** The user query to be executed. */
     userQuery?: string;
+    /** The context to be used while generating the testcase. */
     context?: string;
+    /** The ideal response to the user query. */
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestcaseCreateParamsCustomInputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestcaseCreateParamsCustomLabelsValue | undefined>;

package/dist/api/resources/testrecord/client/Client.js

@@ -70,7 +70,7 @@ class Testrecord {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/run/${encodeURIComponent(runId)}/testrecord/${encodeURIComponent(testrecordId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -162,7 +162,7 @@ class Testrecord {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/run/${encodeURIComponent(runId)}/testrecord`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.TestrecordCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/resources/testrecord/client/requests/TestrecordCreateParams.d.ts

@@ -9,14 +9,21 @@ import * as Scorecard from "../../../../index";
 export interface TestrecordCreateParams {
     testsetId?: number;
     testcaseId?: number;
+    /** The user query that was executed for the testrecord. */
     userQuery?: string;
+    /** The context that was used while generating the testrecord. */
     context?: string;
+    /** The response generated by the model. */
     response?: string;
+    /** The ideal response. */
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestrecordCreateParamsCustomInputsValue | undefined>;
     customOutputs?: Record<string, Scorecard.TestrecordCreateParamsCustomOutputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestrecordCreateParamsCustomLabelsValue | undefined>;
+    /** The prompt used to generate the response. */
     prompt?: string;
+    /** The model parameters used to generate the response. */
     modelParams?: Record<string, Scorecard.TestrecordCreateParamsModelParamsValue | undefined>;
+    /** Debug information generated by Scorecard during the execution of the testrecord. */
     modelDebugInfo?: Record<string, Scorecard.TestrecordCreateParamsModelDebugInfoValue | undefined>;
 }

package/dist/api/resources/testset/client/Client.js

@@ -69,7 +69,7 @@ class Testset {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/testset/${encodeURIComponent(testsetId)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -160,7 +160,7 @@ class Testset {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/testset/${encodeURIComponent(testsetId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -253,7 +253,7 @@ class Testset {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, "v1/testset"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.TestsetCreateParams.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -345,7 +345,7 @@ class Testset {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/testset/${encodeURIComponent(testsetId)}/schema`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
@@ -445,7 +445,7 @@ class Testset {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/testset/${encodeURIComponent(testsetId)}/testcase`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/resources/testset/client/requests/TestsetCreateParams.d.ts

@@ -10,7 +10,9 @@ import * as Scorecard from "../../../../index";
  */
 export interface TestsetCreateParams {
     name: string;
+    /** A description for the testset. */
     description?: string;
+    /** Whether or not the testset uses retrieval. */
     usingRetrieval?: boolean;
     customSchema?: Scorecard.CustomSchema;
 }

package/dist/api/resources/traces/client/Client.js

@@ -69,7 +69,7 @@ class Traces {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ScorecardEnvironment.Default, `v1/traces/${encodeURIComponent(traceId)}/spans`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "scorecard-ai", "X-Fern-SDK-Version": "0.5.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,

package/dist/api/types/Grade.d.ts

@@ -4,19 +4,30 @@
 import * as Scorecard from "../index";
 export interface Grade {
     userId?: string;
+    /** The ID of the grade. */
     id?: number;
+    /** The ID of the run that created the grade. */
     runId?: number;
+    /** The ID of the testcase associated with the grade. */
     testcaseId?: number;
+    /** The ID of the testrecord for which the grade was created. */
     testrecordId?: number;
+    /** The ID of the metric used to compute the grade. */
     metricId?: number;
+    /** The binary score assigned to the grade. */
     binaryScore?: boolean;
+    /** The integer score assigned to the grade. */
     intScore?: number;
+    /** The reasoning for the assigned score. */
     reasoning?: string;
     /** Indicates if a human should assign a grade. */
     humanEval?: boolean;
     /** The status of the grade. */
     status?: Scorecard.ScoreStatus;
+    /** The error message if the grade was not created successfully. */
     errorMessage?: string;
+    /** when the grade was created. */
     createdAt?: Date;
+    /** when the grade was last updated. */
     updatedAt?: Date;
 }

package/dist/api/types/PaginatedTestcaseResponse.d.ts

@@ -4,7 +4,9 @@
 import * as Scorecard from "../index";
 export interface PaginatedTestcaseResponse {
     count: number;
+    /** The URL to fetch the next page of testcases. */
     next?: string;
+    /** The URL to fetch the previous page of testcases. */
     previous?: string;
     /** The list of Testcases retrieved in this page. */
     results: Scorecard.TestCase[];

package/dist/api/types/Prompt.d.ts

@@ -3,7 +3,9 @@
  */
 import * as Scorecard from "../index";
 export interface Prompt {
+    /** The organization this resource belongs to. */
     orgId?: string;
+    /** The user this record belongs to. */
     userId?: string;
     id?: string;
     name?: string;

package/dist/api/types/Run.d.ts

@@ -3,18 +3,32 @@
  */
 export interface Run {
     id?: number;
+    /** The creation date and time of the run. */
     createdAt?: Date;
+    /** The last time the run was updated. */
     updatedAt?: Date;
+    /** The start time of the run. */
     executionStartTime?: Date;
+    /** The end time of the run. */
     executionEndTime?: Date;
+    /** The testset that was executed in this run. */
     testsetId?: number;
+    /** The current status of the run. */
     status?: string;
+    /** The maximum number of testcases to run. */
     limitTestcases?: number;
+    /** How the run was created. */
     source?: string;
+    /** The model parameters used when generating the run. */
     modelParams?: Record<string, unknown>;
+    /** Notes about the run. */
     notes?: string;
+    /** The ID of the scoring configuration the run uses. */
     scoringConfigId?: number;
+    /** The prompt template to be used while executing the run. */
     promptTemplate?: string;
+    /** The start time of scoring the run's results. */
     scoringStartTime?: Date;
+    /** The end time of scoring the run's results. */
     scoringEndTime?: Date;
 }

package/dist/api/types/TestCase.d.ts

@@ -3,13 +3,17 @@
  */
 import * as Scorecard from "../index";
 export interface TestCase {
+    /** The ID of the testcase. */
     id?: number;
+    /** The creation date and time of the testcase. */
     createdAt?: Date;
     /** The ID of the testset the testcase belongs to. */
     testsetId: number;
     /** The user query for the testcase. */
     userQuery: string;
+    /** The context for the testcase. */
     context?: string;
+    /** The ideal response for the testcase. */
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestCaseCustomInputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestCaseCustomLabelsValue | undefined>;

package/dist/api/types/Testrecord.d.ts

@@ -4,19 +4,31 @@
 import * as Scorecard from "../index";
 export interface Testrecord {
     id?: number;
+    /** The creation date and time of the testrecord. */
     createdAt?: Date;
+    /** The ID of the run the testrecord belongs to. */
     runId?: number;
+    /** The ID of the testset the testrecord belongs to. */
     testsetId?: number;
+    /** The ID of the testcase the testrecord belongs to. */
     testcaseId?: number;
+    /** The user query for the testrecord. */
     userQuery?: string;
+    /** The context for the testrecord. */
     context?: string;
+    /** The actual response of the model for the testrecord. */
     modelResponse?: string;
+    /** The ideal response for the testrecord. */
     ideal?: string;
     customInputs?: Record<string, Scorecard.TestrecordCustomInputsValue | undefined>;
     customLabels?: Record<string, Scorecard.TestrecordCustomLabelsValue | undefined>;
     customOutputs?: Record<string, Scorecard.TestrecordCustomOutputsValue | undefined>;
+    /** The current status of the testrecord. */
     status?: string;
+    /** The prompt used to generate the testrecord. */
     prompt?: string;
+    /** The model parameters used when generating the testrecord. */
     modelParams?: Record<string, Scorecard.TestrecordModelParamsValue | undefined>;
+    /** Debug information produced during the testrecord's generation. */
     modelDebugInfo?: Record<string, Scorecard.TestrecordModelDebugInfoValue | undefined>;
 }

package/dist/api/types/Testset.d.ts

@@ -3,16 +3,27 @@
  */
 import * as Scorecard from "../index";
 export interface Testset {
+    /** The ID of the testset. */
     id?: number;
+    /** The creation date and time of the testset. */
     createdAt?: Date;
+    /** A human-readable name for the testset. This will be displayed in the UI. */
     name?: string;
+    /** A description for the testset. */
     description?: string;
+    /** Whether or not the testset uses retrieval. */
     usingRetrieval?: boolean;
+    /** The method used to ingest the testset. */
     ingestionMethod?: string;
+    /** The number of testcases in the testset. */
     numTestcases?: number;
+    /** Whether or not the testset is published. */
     published?: boolean;
+    /** The last time the testset was updated. */
     updatedAt?: Date;
+    /** Whether or not the testset is archived. */
     isArchived?: boolean;
+    /** The ID of the project the testset belongs to. */
     projectId?: number;
     customSchema?: Scorecard.CustomSchema;
 }

package/dist/telemetry.d.ts

@@ -1,6 +1 @@
-declare const trace: any;
-declare const OTLPTraceExporter: any;
-declare const Resource: any;
-declare const BatchSpanProcessor: any, ConsoleSpanExporter: any, NodeTracerProvider: any;
-declare const SEMRESATTRS_SERVICE_NAME: any;
 declare function checkInstalled(...modules: string[]): boolean;

package/dist/telemetry.js

@@ -8,11 +8,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const { trace } = require('@opentelemetry/api');
-const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
-const { Resource } = require('@opentelemetry/resources');
-const { BatchSpanProcessor, ConsoleSpanExporter, NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
-const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 function checkInstalled(...modules) {
     for (let i = 0; i < modules.length; i++) {
         let module = modules[i];
@@ -27,6 +22,23 @@ function checkInstalled(...modules) {
 }
 module.exports = {
     setup(name, scorecardConfig, debug = false) {
+        const required = [
+            '@opentelemetry/api',
+            '@opentelemetry/core',
+            '@opentelemetry/exporter-trace-otlp-http',
+            '@opentelemetry/resources',
+            '@opentelemetry/sdk-trace-node',
+            '@opentelemetry/semantic-conventions'
+        ];
+        if (!checkInstalled(...required)) {
+            throw new Error(`Required OpenTelemetry packages not installed. Please ensure that all necessary peerDependencies are installed:\n${required.map(module => `- ${module}`).join('\n')}`);
+        }
+        const { propagation, trace } = require('@opentelemetry/api');
+        const { CompositePropagator, W3CBaggagePropagator, W3CTraceContextPropagator } = require('@opentelemetry/core');
+        const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
+        const { Resource } = require('@opentelemetry/resources');
+        const { BatchSpanProcessor, ConsoleSpanExporter, NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
+        const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
         const resource = Resource.default().merge(new Resource({
             [SEMRESATTRS_SERVICE_NAME]: name,
         }));
@@ -38,6 +50,12 @@ module.exports = {
             const processor = new BatchSpanProcessor(consoleExporter);
             provider.addSpanProcessor(processor);
         }
+        propagation.setGlobalPropagator(new CompositePropagator({
+            propagators: [
+                new W3CTraceContextPropagator(),
+                new W3CBaggagePropagator()
+            ]
+        }));
         const url = scorecardConfig.telemetryUrl ? scorecardConfig.telemetryUrl : 'https://telemetry.getscorecard.ai';
         const otlpExporter = new OTLPTraceExporter({
             url: `${url}/v1/traces`,
@@ -48,11 +66,11 @@ module.exports = {
         const processor = new BatchSpanProcessor(otlpExporter);
         provider.addSpanProcessor(processor);
         provider.register();
-        if (checkInstalled('@langchain/core')) {
+        if (checkInstalled('@langchain/core', '@arizeai/openinference-instrumentation-langchain', '@opentelemetry/instrumentation')) {
             const { LangChainInstrumentation } = require('@arizeai/openinference-instrumentation-langchain');
             new LangChainInstrumentation().manuallyInstrument(require('@langchain/core/callbacks/manager'));
         }
-        if (checkInstalled('openai')) {
+        if (checkInstalled('openai', '@arizeai/openinference-instrumentation-openai', '@opentelemetry/instrumentation')) {
             const { OpenAIInstrumentation } = require('@arizeai/openinference-instrumentation-openai');
             new OpenAIInstrumentation().manuallyInstrument(require('openai'));
         }

package/dist/wrapper/ScorecardClient.d.ts

@@ -1,14 +1,6 @@
 import { ScorecardClient as FernClient } from "../Client";
-import { ScorecardEnvironment } from "../environments";
-import * as core from "../core";
 export declare namespace ScorecardClient {
-    interface Options {
-        /**
-         * Your Scorecard API Key. Defaults to the environment
-         * variable SCORECARD_API_KEY.
-         */
-        apiKey?: core.Supplier<string>;
-        environment?: core.Supplier<ScorecardEnvironment | string>;
+    interface Options extends Omit<FernClient.Options, "fetcher"> {
     }
     interface RequestOptions extends FernClient.RequestOptions {
     }
@@ -28,7 +20,7 @@ export declare namespace ScorecardClient {
     }
 }
 export declare class ScorecardClient extends FernClient {
-    constructor(options?: ScorecardClient.Options);
+    constructor(options: ScorecardClient.Options);
     /**
      * Runs all tests within a testset
      */

package/dist/wrapper/ScorecardClient.js

@@ -33,18 +33,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScorecardClient = void 0;
+const api_1 = require("@opentelemetry/api");
 const Client_1 = require("../Client");
+const core_1 = require("../core");
 const errors = __importStar(require("../errors"));
 class ScorecardClient extends Client_1.ScorecardClient {
-    constructor(options = {}) {
-        var _a;
-        const apiKey = (_a = options.apiKey) !== null && _a !== void 0 ? _a : process.env["SCORECARD_API_KEY"];
-        if (apiKey !== undefined) {
-            super(Object.assign(Object.assign({}, options), { apiKey }));
-        }
-        throw new errors.ScorecardError({
-            message: "Please pass in your Scorecard API Key or export SCORECARD_API_KEY in your environment.",
-        });
+    constructor(options) {
+        const fetcher = (args) => {
+            var _a;
+            args.headers = (_a = args.headers) !== null && _a !== void 0 ? _a : {};
+            api_1.propagation.inject(api_1.context.active(), args.headers);
+            return (0, core_1.fetcher)(args);
+        };
+        super(Object.assign(Object.assign({}, options), { fetcher }));
     }
     /**
      * Runs all tests within a testset

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "scorecard-ai",
-    "version": "0.5.2",
+    "version": "0.5.4",
     "private": false,
     "repository": "https://github.com/scorecard-ai/scorecard-node",
     "license": "See LICENSE",
@@ -24,6 +24,7 @@
         "@arizeai/openinference-instrumentation-openai": "^0.2.0",
         "@langchain/core": "^0.1.63",
         "@opentelemetry/api": "*",
+        "@opentelemetry/core": "*",
         "@opentelemetry/exporter-trace-otlp-http": "*",
         "@opentelemetry/instrumentation": ">=0.40.0",
         "@opentelemetry/resources": "*",
@@ -44,6 +45,9 @@
         "@opentelemetry/api": {
             "optional": false
         },
+        "@opentelemetry/core": {
+            "optional": false
+        },
         "@opentelemetry/exporter-trace-otlp-http": {
             "optional": false
         },
@@ -78,6 +82,7 @@
         "@arizeai/openinference-instrumentation-openai": "^0.2.0",
         "@langchain/core": "^0.1.63",
         "@opentelemetry/api": "latest",
+        "@opentelemetry/core": "latest",
         "@opentelemetry/exporter-trace-otlp-http": "latest",
         "@opentelemetry/instrumentation": "latest",
         "@opentelemetry/resources": "latest",

package/telemetry.d.ts

@@ -1,6 +1 @@
-declare const trace: any;
-declare const OTLPTraceExporter: any;
-declare const Resource: any;
-declare const BatchSpanProcessor: any, ConsoleSpanExporter: any, NodeTracerProvider: any;
-declare const SEMRESATTRS_SERVICE_NAME: any;
 declare function checkInstalled(...modules: string[]): boolean;

package/telemetry.js

@@ -8,11 +8,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const { trace } = require('@opentelemetry/api');
-const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
-const { Resource } = require('@opentelemetry/resources');
-const { BatchSpanProcessor, ConsoleSpanExporter, NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
-const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 function checkInstalled(...modules) {
     for (let i = 0; i < modules.length; i++) {
         let module = modules[i];
@@ -27,6 +22,23 @@ function checkInstalled(...modules) {
 }
 module.exports = {
     setup(name, scorecardConfig, debug = false) {
+        const required = [
+            '@opentelemetry/api',
+            '@opentelemetry/core',
+            '@opentelemetry/exporter-trace-otlp-http',
+            '@opentelemetry/resources',
+            '@opentelemetry/sdk-trace-node',
+            '@opentelemetry/semantic-conventions'
+        ];
+        if (!checkInstalled(...required)) {
+            throw new Error(`Required OpenTelemetry packages not installed. Please ensure that all necessary peerDependencies are installed:\n${required.map(module => `- ${module}`).join('\n')}`);
+        }
+        const { propagation, trace } = require('@opentelemetry/api');
+        const { CompositePropagator, W3CBaggagePropagator, W3CTraceContextPropagator } = require('@opentelemetry/core');
+        const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
+        const { Resource } = require('@opentelemetry/resources');
+        const { BatchSpanProcessor, ConsoleSpanExporter, NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
+        const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
         const resource = Resource.default().merge(new Resource({
             [SEMRESATTRS_SERVICE_NAME]: name,
         }));
@@ -38,6 +50,12 @@ module.exports = {
             const processor = new BatchSpanProcessor(consoleExporter);
             provider.addSpanProcessor(processor);
         }
+        propagation.setGlobalPropagator(new CompositePropagator({
+            propagators: [
+                new W3CTraceContextPropagator(),
+                new W3CBaggagePropagator()
+            ]
+        }));
         const url = scorecardConfig.telemetryUrl ? scorecardConfig.telemetryUrl : 'https://telemetry.getscorecard.ai';
         const otlpExporter = new OTLPTraceExporter({
             url: `${url}/v1/traces`,
@@ -48,11 +66,11 @@ module.exports = {
         const processor = new BatchSpanProcessor(otlpExporter);
         provider.addSpanProcessor(processor);
         provider.register();
-        if (checkInstalled('@langchain/core')) {
+        if (checkInstalled('@langchain/core', '@arizeai/openinference-instrumentation-langchain', '@opentelemetry/instrumentation')) {
             const { LangChainInstrumentation } = require('@arizeai/openinference-instrumentation-langchain');
             new LangChainInstrumentation().manuallyInstrument(require('@langchain/core/callbacks/manager'));
         }
-        if (checkInstalled('openai')) {
+        if (checkInstalled('openai', '@arizeai/openinference-instrumentation-openai', '@opentelemetry/instrumentation')) {
             const { OpenAIInstrumentation } = require('@arizeai/openinference-instrumentation-openai');
             new OpenAIInstrumentation().manuallyInstrument(require('openai'));
         }

package/wrapper/ScorecardClient.d.ts

@@ -1,14 +1,6 @@
 import { ScorecardClient as FernClient } from "../Client";
-import { ScorecardEnvironment } from "../environments";
-import * as core from "../core";
 export declare namespace ScorecardClient {
-    interface Options {
-        /**
-         * Your Scorecard API Key. Defaults to the environment
-         * variable SCORECARD_API_KEY.
-         */
-        apiKey?: core.Supplier<string>;
-        environment?: core.Supplier<ScorecardEnvironment | string>;
+    interface Options extends Omit<FernClient.Options, "fetcher"> {
     }
     interface RequestOptions extends FernClient.RequestOptions {
     }
@@ -28,7 +20,7 @@ export declare namespace ScorecardClient {
     }
 }
 export declare class ScorecardClient extends FernClient {
-    constructor(options?: ScorecardClient.Options);
+    constructor(options: ScorecardClient.Options);
     /**
      * Runs all tests within a testset
      */