Evaluators

import { listEvaluators } from "@arizeai/ax-client";

const { data: evaluators, pagination } = await listEvaluators({
  space: "my-space",  // space name or ID (optional)
  name: "Relevance",  // substring filter on evaluator name (optional)
  limit: 10,
});

import { createEvaluator } from "@arizeai/ax-client";

const evaluator = await createEvaluator({
  name: "Relevance",
  space: "my-space",  // space name or ID
  type: "template",
  version: {
    commitMessage: "Initial version",
    templateConfig: {
      name: "Relevance",
      template: "Is the following response relevant to the query?\nQuery: {{query}}\nResponse: {{response}}",
      includeExplanations: true,
      useFunctionCallingIfAvailable: true,
      classificationChoices: { relevant: 1, irrelevant: 0 },
      direction: "maximize",
      llmConfig: {
        aiIntegrationId: "your_ai_integration_id",
        modelName: "gpt-4o",
        invocationParameters: { temperature: 0 },
        providerParameters: {},
      },
    },
  },
});

import { getEvaluator } from "@arizeai/ax-client";

// Get with the latest version
const evaluator = await getEvaluator({ evaluator: "your_evaluator_id" });

// Get with a specific version
const byVersion = await getEvaluator({
  evaluator: "your_evaluator_id",
  versionId: "your_version_id",
});

import { getEvaluatorVersion } from "@arizeai/ax-client";

const version = await getEvaluatorVersion({ versionId: "your_version_id" });

import { updateEvaluator } from "@arizeai/ax-client";

const updated = await updateEvaluator({
  evaluator: "your_evaluator_id",
  name: "Updated Evaluator Name",
  description: "Updated description",
});

import { deleteEvaluator } from "@arizeai/ax-client";

await deleteEvaluator({ evaluator: "your_evaluator_id" });

import { listEvaluatorVersions } from "@arizeai/ax-client";

const { data: versions, pagination } = await listEvaluatorVersions({
  evaluator: "your_evaluator_id",
});

import { createEvaluatorVersion } from "@arizeai/ax-client";

const version = await createEvaluatorVersion({
  evaluator: "your_evaluator_id",
  commitMessage: "Updated prompt template for better precision",
  templateConfig: {
    name: "Relevance",
    template: "Rate the relevance of the response on a scale of 0-1.\nQuery: {{query}}\nResponse: {{response}}",
    includeExplanations: true,
    useFunctionCallingIfAvailable: true,
    classificationChoices: { relevant: 1, irrelevant: 0 },
    direction: "maximize",
    llmConfig: {
      aiIntegrationId: "your_ai_integration_id",
      modelName: "gpt-4o",
      invocationParameters: { temperature: 0 },
      providerParameters: {},
    },
  },
});