scorecard-ai 0.5.3 → 0.6.0

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,5 +1,7 @@
 import { ScorecardClient as FernClient } from "../Client";
 export declare namespace ScorecardClient {
+    interface Options extends Omit<FernClient.Options, "fetcher"> {
+    }
     interface RequestOptions extends FernClient.RequestOptions {
     }
     interface RunTestArgs {
@@ -18,6 +20,7 @@ export declare namespace ScorecardClient {
     }
 }
 export declare class ScorecardClient extends FernClient {
+    constructor(options: ScorecardClient.Options);
     /**
      * Runs all tests within a testset
      */

package/wrapper/ScorecardClient.js

@@ -33,9 +33,20 @@ 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) {
+        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/api/resources/traces/client/Client.d.ts

@@ -1,40 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as Scorecard from "../../../index";
-export declare namespace Traces {
-    interface Options {
-        environment?: core.Supplier<environments.ScorecardEnvironment | string>;
-        apiKey: core.Supplier<string>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        timeoutInSeconds?: number;
-        maxRetries?: number;
-        abortSignal?: AbortSignal;
-    }
-}
-export declare class Traces {
-    protected readonly _options: Traces.Options;
-    constructor(_options: Traces.Options);
-    /**
-     * Retrieve trace spans
-     *
-     * @param {string} traceId - The ID of the trace to retrieve spans from.
-     * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Scorecard.UnauthorizedError}
-     * @throws {@link Scorecard.ForbiddenError}
-     * @throws {@link Scorecard.NotFoundError}
-     * @throws {@link Scorecard.UnprocessableEntityError}
-     *
-     * @example
-     *     await scorecard.traces.get("trace_id")
-     */
-    get(traceId: string, requestOptions?: Traces.RequestOptions): Promise<Scorecard.Span[]>;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-API-Key": string;
-    }>;
-}

package/api/types/TestCaseCreate.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface TestCaseCreate {
-    testsetId: number;
-    userQuery: string;
-    context?: string;
-    response?: string;
-    ideal?: string;
-}

package/dist/api/resources/traces/client/Client.d.ts

@@ -1,40 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as Scorecard from "../../../index";
-export declare namespace Traces {
-    interface Options {
-        environment?: core.Supplier<environments.ScorecardEnvironment | string>;
-        apiKey: core.Supplier<string>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        timeoutInSeconds?: number;
-        maxRetries?: number;
-        abortSignal?: AbortSignal;
-    }
-}
-export declare class Traces {
-    protected readonly _options: Traces.Options;
-    constructor(_options: Traces.Options);
-    /**
-     * Retrieve trace spans
-     *
-     * @param {string} traceId - The ID of the trace to retrieve spans from.
-     * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Scorecard.UnauthorizedError}
-     * @throws {@link Scorecard.ForbiddenError}
-     * @throws {@link Scorecard.NotFoundError}
-     * @throws {@link Scorecard.UnprocessableEntityError}
-     *
-     * @example
-     *     await scorecard.traces.get("trace_id")
-     */
-    get(traceId: string, requestOptions?: Traces.RequestOptions): Promise<Scorecard.Span[]>;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "X-API-Key": string;
-    }>;
-}

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

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface TestCaseCreate {
-    testsetId: number;
-    userQuery: string;
-    context?: string;
-    response?: string;
-    ideal?: string;
-}

package/dist/serialization/resources/traces/client/index.d.ts

@@ -1 +0,0 @@
-export * as get from "./get";

package/dist/serialization/types/TestCaseCreate.d.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Scorecard from "../../api/index";
-import * as core from "../../core";
-export declare const TestCaseCreate: core.serialization.ObjectSchema<serializers.TestCaseCreate.Raw, Scorecard.TestCaseCreate>;
-export declare namespace TestCaseCreate {
-    interface Raw {
-        testset_id: number;
-        user_query: string;
-        context?: string | null;
-        response?: string | null;
-        ideal?: string | null;
-    }
-}

package/serialization/resources/traces/client/index.d.ts

@@ -1 +0,0 @@
-export * as get from "./get";

package/serialization/types/TestCaseCreate.d.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Scorecard from "../../api/index";
-import * as core from "../../core";
-export declare const TestCaseCreate: core.serialization.ObjectSchema<serializers.TestCaseCreate.Raw, Scorecard.TestCaseCreate>;
-export declare namespace TestCaseCreate {
-    interface Raw {
-        testset_id: number;
-        user_query: string;
-        context?: string | null;
-        response?: string | null;
-        ideal?: string | null;
-    }
-}