@anyway-sh/node-server-sdk 0.22.8

package/dist/src/lib/generated/evaluators/types.d.ts

@@ -0,0 +1,401 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export type paths = Record<string, never>;
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        "request.AgentEfficiencyRequest": {
+            input: components["schemas"]["request.AgentEfficiencyInput"];
+        };
+        "request.AgentEfficiencyInput": {
+            /** @example ["User found", "Email updated", "Changes saved"] */
+            trajectory_completions: string;
+            /** @example ["Find user info", "Update email", "Save changes"] */
+            trajectory_prompts: string;
+        };
+        "request.AgentFlowQualityRequest": {
+            config: components["schemas"]["request.AgentFlowQualityConfigRequest"];
+            input: components["schemas"]["request.AgentFlowQualityInput"];
+        };
+        "request.AgentFlowQualityConfigRequest": {
+            /**
+             * @example [
+             *       "no tools called",
+             *       "agent completed task"
+             *     ]
+             */
+            conditions: string[];
+            /** @example 0.5 */
+            threshold: number;
+        };
+        "request.AgentFlowQualityInput": {
+            /** @example ["Found 5 flights", "Selected $299 flight", "Booking confirmed"] */
+            trajectory_completions: string;
+            /** @example ["Search for flights", "Select the cheapest option", "Confirm booking"] */
+            trajectory_prompts: string;
+        };
+        "request.AgentGoalAccuracyRequest": {
+            input: components["schemas"]["request.AgentGoalAccuracyInput"];
+        };
+        "request.AgentGoalAccuracyInput": {
+            /** @example I have booked your flight from New York to Los Angeles departing Monday at 9am. */
+            completion: string;
+            /** @example Book a flight from NYC to LA for next Monday */
+            question: string;
+            /** @example Flight booked: NYC to LA, Monday departure */
+            reference: string;
+        };
+        "request.AgentGoalCompletenessRequest": {
+            config?: components["schemas"]["request.AgentGoalCompletenessConfigRequest"];
+            input: components["schemas"]["request.AgentGoalCompletenessInput"];
+        };
+        "request.AgentGoalCompletenessConfigRequest": {
+            /** @example 0.5 */
+            threshold: number;
+        };
+        "request.AgentGoalCompletenessInput": {
+            /** @example ["Account created", "Preferences saved", "Notifications enabled"] */
+            trajectory_completions: string;
+            /** @example ["Create new account", "Set preferences", "Enable notifications"] */
+            trajectory_prompts: string;
+        };
+        "request.AgentToolErrorDetectorRequest": {
+            input: components["schemas"]["request.AgentToolErrorDetectorInput"];
+        };
+        "request.AgentToolErrorDetectorInput": {
+            /** @example {"action": "search", "query": "flights to Paris"} */
+            tool_input: string;
+            /** @example {"status": "success", "results": [{"flight": "AF123", "price": 450}]} */
+            tool_output: string;
+        };
+        "request.AgentToolTrajectoryRequest": {
+            config?: components["schemas"]["request.AgentToolTrajectoryConfigRequest"];
+            input: components["schemas"]["request.AgentToolTrajectoryInput"];
+        };
+        "request.AgentToolTrajectoryConfigRequest": {
+            /** @example true */
+            input_params_sensitive?: boolean;
+            /** @example false */
+            mismatch_sensitive?: boolean;
+            /** @example false */
+            order_sensitive?: boolean;
+            /** @example 0.5 */
+            threshold?: number;
+        };
+        "request.AgentToolTrajectoryInput": {
+            /** @example [{"name": "search", "input": {"query": "weather"}}] */
+            executed_tool_calls: string;
+            /** @example [{"name": "search", "input": {"query": "weather"}}] */
+            expected_tool_calls: string;
+        };
+        "request.AnswerCompletenessRequest": {
+            input: components["schemas"]["request.AnswerCompletenessInput"];
+        };
+        "request.AnswerCompletenessInput": {
+            /** @example Paris. */
+            completion: string;
+            /** @example The capital of France is Paris. */
+            context: string;
+            /** @example What is the capital of France? */
+            question: string;
+        };
+        "request.AnswerCorrectnessRequest": {
+            input: components["schemas"]["request.AnswerCorrectnessInput"];
+        };
+        "request.AnswerCorrectnessInput": {
+            /** @example World War II ended in 1945. */
+            completion: string;
+            /** @example 1945 */
+            ground_truth: string;
+            /** @example What year did World War II end? */
+            question: string;
+        };
+        "request.AnswerRelevancyRequest": {
+            input: components["schemas"]["request.AnswerRelevancyInput"];
+        };
+        "request.AnswerRelevancyInput": {
+            /** @example The capital of France is Paris. */
+            answer: string;
+            /** @example What is the capital of France? */
+            question: string;
+        };
+        "request.CharCountRequest": {
+            input: components["schemas"]["request.CharCountInput"];
+        };
+        "request.CharCountInput": {
+            /** @example Hello, world! This is a sample text. */
+            text: string;
+        };
+        "request.CharCountRatioRequest": {
+            input: components["schemas"]["request.CharCountRatioInput"];
+        };
+        "request.CharCountRatioInput": {
+            /** @example This is a longer text for comparison */
+            denominator_text: string;
+            /** @example Short text */
+            numerator_text: string;
+        };
+        "request.ContextRelevanceRequest": {
+            config?: components["schemas"]["request.ContextRelevanceConfigRequest"];
+            input: components["schemas"]["request.ContextRelevanceInput"];
+        };
+        "request.ContextRelevanceConfigRequest": {
+            /** @example gpt-4o */
+            model?: string;
+        };
+        "request.ContextRelevanceInput": {
+            /** @example Our store is open Monday to Friday from 9am to 6pm, and Saturday from 10am to 4pm. We are closed on Sundays. */
+            context: string;
+            /** @example What are the business hours? */
+            query: string;
+        };
+        "request.ConversationQualityRequest": {
+            input: components["schemas"]["request.ConversationQualityInput"];
+        };
+        "request.ConversationQualityInput": {
+            /** @example ["Hi! I'd be happy to assist you today.", "We offer consulting, development, and support services."] */
+            completions: string;
+            /** @example ["Hello, how can I help?", "What services do you offer?"] */
+            prompts: string;
+        };
+        "request.FaithfulnessRequest": {
+            input: components["schemas"]["request.FaithfulnessInput"];
+        };
+        "request.FaithfulnessInput": {
+            /** @example The Eiffel Tower is located in Paris and was built in 1889. */
+            completion: string;
+            /** @example The Eiffel Tower is a wrought-iron lattice tower on the Champ de Mars in Paris, France. It was constructed from 1887 to 1889. */
+            context: string;
+            /** @example When was the Eiffel Tower built? */
+            question: string;
+        };
+        "request.HtmlComparisonRequest": {
+            input: components["schemas"]["request.HtmlComparisonInput"];
+        };
+        "request.HtmlComparisonInput": {
+            /** @example <html><body><h1>Hello, world!</h1></body></html> */
+            html1: string;
+            /** @example <html><body><h1>Hello, world!</h1></body></html> */
+            html2: string;
+        };
+        "request.InstructionAdherenceRequest": {
+            input: components["schemas"]["request.InstructionAdherenceInput"];
+        };
+        "request.InstructionAdherenceInput": {
+            /** @example Respond in exactly 3 bullet points and use formal language. */
+            instructions: string;
+            /**
+             * @example - First point about the topic
+             *     - Second relevant consideration
+             *     - Final concluding thought
+             */
+            response: string;
+        };
+        "request.IntentChangeRequest": {
+            input: components["schemas"]["request.IntentChangeInput"];
+        };
+        "request.IntentChangeInput": {
+            /** @example ["Sure, I can help with hotel booking", "No problem, let me search for flights"] */
+            completions: string;
+            /** @example ["I want to book a hotel", "Actually, I need a flight instead"] */
+            prompts: string;
+        };
+        "request.JSONValidatorRequest": {
+            config?: components["schemas"]["request.JSONValidatorConfigRequest"];
+            input: components["schemas"]["request.JSONValidatorInput"];
+        };
+        "request.JSONValidatorConfigRequest": {
+            /** @example true */
+            enable_schema_validation?: boolean;
+            /** @example {} */
+            schema_string?: string;
+        };
+        "request.JSONValidatorInput": {
+            /** @example {"name": "John", "age": 30} */
+            text: string;
+        };
+        "request.PerplexityRequest": {
+            input: components["schemas"]["request.PerplexityInput"];
+        };
+        "request.PerplexityInput": {
+            /** @example [-2.3, -1.5, -0.8, -1.2, -0.5] */
+            logprobs: string;
+        };
+        "request.PIIDetectorRequest": {
+            config?: components["schemas"]["request.PIIDetectorConfigRequest"];
+            input: components["schemas"]["request.PIIDetectorInput"];
+        };
+        "request.PIIDetectorConfigRequest": {
+            /** @example 0.8 */
+            probability_threshold?: number;
+        };
+        "request.PIIDetectorInput": {
+            /** @example Please contact John Smith at john.smith@email.com or call 555-123-4567. */
+            text: string;
+        };
+        "request.PlaceholderRegexRequest": {
+            config?: components["schemas"]["request.PlaceholderRegexConfigRequest"];
+            input: components["schemas"]["request.PlaceholderRegexInput"];
+        };
+        "request.PlaceholderRegexConfigRequest": {
+            /** @example true */
+            case_sensitive?: boolean;
+            /** @example true */
+            dot_include_nl?: boolean;
+            /** @example true */
+            multi_line?: boolean;
+            /** @example true */
+            should_match?: boolean;
+        };
+        "request.PlaceholderRegexInput": {
+            /** @example [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,} */
+            placeholder_value: string;
+            /** @example user@example.com */
+            text: string;
+        };
+        "request.ProfanityDetectorRequest": {
+            input: components["schemas"]["request.ProfanityDetectorInput"];
+        };
+        "request.ProfanityDetectorInput": {
+            /** @example This is a clean and professional message. */
+            text: string;
+        };
+        "request.PromptInjectionRequest": {
+            config?: components["schemas"]["request.PromptInjectionConfigRequest"];
+            input: components["schemas"]["request.PromptInjectionInput"];
+        };
+        "request.PromptInjectionConfigRequest": {
+            /** @example 0.5 */
+            threshold?: number;
+        };
+        "request.PromptInjectionInput": {
+            /** @example What is the weather like today? */
+            prompt: string;
+        };
+        "request.PromptPerplexityRequest": {
+            input: components["schemas"]["request.PromptPerplexityInput"];
+        };
+        "request.PromptPerplexityInput": {
+            /** @example What is the capital of France? */
+            prompt: string;
+        };
+        "request.RegexValidatorRequest": {
+            config?: components["schemas"]["request.RegexValidatorConfigRequest"];
+            input: components["schemas"]["request.RegexValidatorInput"];
+        };
+        "request.RegexValidatorConfigRequest": {
+            /** @example true */
+            case_sensitive?: boolean;
+            /** @example true */
+            dot_include_nl?: boolean;
+            /** @example true */
+            multi_line?: boolean;
+            /** @example .* */
+            regex?: string;
+            /** @example true */
+            should_match?: boolean;
+        };
+        "request.RegexValidatorInput": {
+            /** @example user@example.com */
+            text: string;
+        };
+        "request.SecretsDetectorRequest": {
+            input: components["schemas"]["request.SecretsDetectorInput"];
+        };
+        "request.SecretsDetectorInput": {
+            /** @example Here is some text without any API keys or passwords. */
+            text: string;
+        };
+        "request.SemanticSimilarityRequest": {
+            input: components["schemas"]["request.SemanticSimilarityInput"];
+        };
+        "request.SemanticSimilarityInput": {
+            /** @example The cat sat on the mat. */
+            completion: string;
+            /** @example A feline was resting on the rug. */
+            reference: string;
+        };
+        "request.SexismDetectorRequest": {
+            config?: components["schemas"]["request.SexismDetectorConfigRequest"];
+            input: components["schemas"]["request.SexismDetectorInput"];
+        };
+        "request.SexismDetectorConfigRequest": {
+            /** @example 0.5 */
+            threshold?: number;
+        };
+        "request.SexismDetectorInput": {
+            /** @example All team members should be treated equally regardless of gender. */
+            text: string;
+        };
+        "request.SQLValidatorRequest": {
+            input: components["schemas"]["request.SQLValidatorInput"];
+        };
+        "request.SQLValidatorInput": {
+            /** @example SELECT * FROM users WHERE id = 1; */
+            text: string;
+        };
+        "request.ToneDetectionRequest": {
+            input: components["schemas"]["request.ToneDetectionInput"];
+        };
+        "request.ToneDetectionInput": {
+            /** @example The capital of France is Paris. */
+            text: string;
+        };
+        "request.TopicAdherenceRequest": {
+            input: components["schemas"]["request.TopicAdherenceInput"];
+        };
+        "request.TopicAdherenceInput": {
+            /** @example Machine learning is a subset of AI that enables systems to learn from data. */
+            completion: string;
+            /** @example Tell me about machine learning */
+            question: string;
+            /** @example artificial intelligence, data science, algorithms */
+            reference_topics: string;
+        };
+        "request.ToxicityDetectorRequest": {
+            config?: components["schemas"]["request.ToxicityDetectorConfigRequest"];
+            input: components["schemas"]["request.ToxicityDetectorInput"];
+        };
+        "request.ToxicityDetectorConfigRequest": {
+            /** @example 0.5 */
+            threshold?: number;
+        };
+        "request.ToxicityDetectorInput": {
+            /** @example Thank you for your help with this project. */
+            text: string;
+        };
+        "request.UncertaintyDetectorRequest": {
+            input: components["schemas"]["request.UncertaintyDetectorInput"];
+        };
+        "request.UncertaintyDetectorInput": {
+            /** @example I am not sure, I think the capital of France is Paris. */
+            prompt: string;
+        };
+        "request.WordCountRequest": {
+            input: components["schemas"]["request.WordCountInput"];
+        };
+        "request.WordCountInput": {
+            /** @example This is a sample text with several words. */
+            text: string;
+        };
+        "request.WordCountRatioRequest": {
+            input: components["schemas"]["request.WordCountRatioInput"];
+        };
+        "request.WordCountRatioInput": {
+            /** @example This is a longer input text for comparison */
+            denominator_text: string;
+            /** @example Short response */
+            numerator_text: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;
+//# sourceMappingURL=types.d.ts.map

package/dist/src/lib/images/image-uploader.d.ts

@@ -0,0 +1,15 @@
+export interface ImageUploadResponse {
+    url: string;
+}
+export interface ImageUploadPayload {
+    image_data: string;
+}
+export declare class ImageUploader {
+    private baseUrl;
+    private apiKey;
+    constructor(baseUrl: string, apiKey: string);
+    uploadBase64Image(traceId: string, spanId: string, imageName: string, base64ImageData: string): Promise<string>;
+    private getImageUrl;
+    private uploadImageData;
+}
+//# sourceMappingURL=image-uploader.d.ts.map

package/dist/src/lib/images/index.d.ts

@@ -0,0 +1,2 @@
+export { ImageUploader } from "./image-uploader";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/lib/interfaces/annotations.interface.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Represents an entity in the system that can be annotated.
+ * An entity is typically a unit of content or interaction that needs to be tracked or evaluated.
+ * It is reported as an association property before the annotation is created.
+ */
+export interface Entity {
+    /**
+     * Unique identifier for the entity.
+     * This could be a user ID, conversation ID, or any other unique identifier in your system.
+     */
+    id: string;
+}
+/**
+ * Configuration options for creating a new annotation.
+ * Annotations are used to attach metadata, feedback, or evaluation results to specific entities.
+ */
+export interface AnnotationCreateOptions {
+    /**
+     * The identifier of the annotation task.
+     * The ID or slug of the annotation task, Can be found at app.traceloop.com/annotation_tasks/:annotationTaskId   */
+    annotationTask: string;
+    /**
+     * The entity to be annotated.
+     * Contains the entity's identifier and optional type information.
+     * Be sure to report the entity instance ID as the association property before
+     * in order to correctly correlate the annotation to the relevant context.
+     */
+    entity: Entity;
+    /**
+     * Key-value pairs of annotation data, should match the tags defined in the annotation task
+     */
+    tags: Record<string, TagValue>;
+}
+export type TagValue = string | number | string[];
+//# sourceMappingURL=annotations.interface.d.ts.map

package/dist/src/lib/interfaces/dataset.interface.d.ts

@@ -0,0 +1,105 @@
+export interface DatasetCreateOptions {
+    name: string;
+    slug?: string;
+    description?: string;
+}
+export interface DatasetUpdateOptions {
+    name?: string;
+    description?: string;
+}
+export interface DatasetResponse {
+    id: string;
+    slug: string;
+    name: string;
+    description?: string;
+    version?: string;
+    published?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+    columns?: Record<string, any>;
+    rows?: RowResponse[];
+}
+export interface ColumnDefinition {
+    name: string;
+    type: "string" | "number" | "boolean" | "date" | "file";
+    slug?: string;
+    required?: boolean;
+    description?: string;
+}
+export interface ColumnResponse extends ColumnDefinition {
+    slug: string;
+    datasetId: string;
+    datasetSlug: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ColumnUpdateOptions {
+    name?: string;
+    type?: "string" | "number" | "boolean" | "date" | "file";
+    required?: boolean;
+    description?: string;
+}
+export interface RowData {
+    [key: string]: string | number | boolean | null | object;
+}
+export interface RowResponse {
+    id: string;
+    datasetId: string;
+    datasetSlug: string;
+    data: RowData;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface RowUpdateOptions {
+    data: Partial<RowData>;
+}
+export interface DatasetListResponse {
+    datasets: DatasetResponse[];
+    total: number;
+}
+export interface DatasetPublishOptions {
+    version?: string;
+    description?: string;
+}
+export interface CSVImportOptions {
+    hasHeader?: boolean;
+    delimiter?: string;
+    encoding?: string;
+}
+export interface DatasetVersion {
+    version: string;
+    publishedBy: string;
+    publishedAt: string;
+}
+export interface DatasetVersionsResponse {
+    datasetId: string;
+    datasetSlug: string;
+    versions: DatasetVersion[];
+    total: number;
+}
+export type DatasetColumnValue = string | number | boolean | null | undefined;
+/**
+ * Response from the upload URL endpoint
+ */
+export interface UploadUrlResponse {
+    uploadUrl: string;
+    storageKey: string;
+    expiresAt?: string;
+    method?: string;
+}
+/**
+ * Request to confirm upload status
+ */
+export interface UploadStatusRequest {
+    status: "success" | "failed";
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Request to register an external URL
+ */
+export interface ExternalUrlRequest {
+    type: string;
+    url: string;
+    metadata?: Record<string, unknown>;
+}
+//# sourceMappingURL=dataset.interface.d.ts.map

package/dist/src/lib/interfaces/evaluator.interface.d.ts

@@ -0,0 +1,83 @@
+import type { EvaluatorDetails } from "./experiment.interface";
+export interface StreamEvent {
+    type: "progress" | "result" | "error" | "complete";
+    data: any;
+    timestamp: string;
+    id?: string;
+    event?: string;
+}
+export interface EvaluatorRunOptions {
+    experimentId: string;
+    experimentRunId?: string;
+    taskId: string;
+    taskResult: Record<string, any>;
+    evaluator: EvaluatorDetails;
+    waitForResults?: boolean;
+    timeout?: number;
+}
+export interface EvaluatorResult {
+    evaluatorName: string;
+    taskId?: string;
+    score?: number;
+    result?: any;
+    metadata?: Record<string, any>;
+    error?: string;
+}
+export interface TriggerEvaluatorRequest {
+    experimentId: string;
+    experimentRunId?: string;
+    taskId?: string;
+    evaluator: EvaluatorDetails;
+    taskResult: Record<string, any>;
+    metadata?: Record<string, any>;
+}
+export interface TriggerEvaluatorResponse {
+    executionId: string;
+    streamUrl: string;
+}
+export interface SSEClientOptions {
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+export interface StreamProgressEvent {
+    type: "progress";
+    data: {
+        completed: number;
+        total: number;
+        percentage: number;
+        currentTask?: string;
+    };
+}
+export interface StreamResultEvent {
+    type: "result";
+    data: {
+        taskId: string;
+        evaluatorName: string;
+        result: EvaluatorResult;
+    };
+}
+export interface StreamErrorEvent {
+    type: "error";
+    data: {
+        error: string;
+        taskId?: string;
+        evaluatorName?: string;
+    };
+}
+export interface StreamCompleteEvent {
+    type: "complete";
+    data: {
+        executionId: string;
+        totalResults: number;
+        totalErrors: number;
+        duration: number;
+    };
+}
+export type SSEStreamEvent = StreamProgressEvent | StreamResultEvent | StreamErrorEvent | StreamCompleteEvent;
+export interface InputExtractor {
+    source: string;
+}
+export interface InputSchemaMapping {
+    [key: string]: InputExtractor;
+}
+//# sourceMappingURL=evaluator.interface.d.ts.map