@inkeep/agents-sdk 0.41.2 → 0.42.0

package/dist/evaluationClient.d.ts

@@ -0,0 +1,78 @@
+//#region src/evaluationClient.d.ts
+interface EvaluationClientConfig {
+  tenantId: string;
+  projectId: string;
+  apiUrl: string;
+  apiKey?: string;
+}
+declare class EvaluationClient {
+  private tenantId;
+  private projectId;
+  private apiUrl;
+  private apiKey?;
+  constructor(config: EvaluationClientConfig);
+  private buildUrl;
+  private buildHeaders;
+  listDatasets(): Promise<unknown[]>;
+  getDataset(datasetId: string): Promise<unknown | null>;
+  createDataset(datasetData: Record<string, unknown>): Promise<unknown>;
+  updateDataset(datasetId: string, updateData: Record<string, unknown>): Promise<unknown>;
+  deleteDataset(datasetId: string): Promise<void>;
+  listDatasetItems(datasetId: string): Promise<unknown[]>;
+  getDatasetItem(datasetId: string, itemId: string): Promise<unknown | null>;
+  createDatasetItem(datasetId: string, itemData: Record<string, unknown>): Promise<unknown>;
+  createDatasetItems(datasetId: string, itemsData: Record<string, unknown>[]): Promise<unknown[]>;
+  updateDatasetItem(datasetId: string, itemId: string, updateData: Record<string, unknown>): Promise<unknown>;
+  deleteDatasetItem(datasetId: string, itemId: string): Promise<void>;
+  listEvaluators(): Promise<unknown[]>;
+  getEvaluator(evaluatorId: string): Promise<unknown | null>;
+  createEvaluator(evaluatorData: Record<string, unknown>): Promise<unknown>;
+  updateEvaluator(evaluatorId: string, updateData: Record<string, unknown>): Promise<unknown>;
+  deleteEvaluator(evaluatorId: string): Promise<void>;
+  listEvaluationSuiteConfigs(): Promise<unknown[]>;
+  getEvaluationSuiteConfig(configId: string): Promise<unknown | null>;
+  createEvaluationSuiteConfig(configData: Record<string, unknown>): Promise<unknown>;
+  updateEvaluationSuiteConfig(configId: string, updateData: Record<string, unknown>): Promise<unknown>;
+  deleteEvaluationSuiteConfig(configId: string): Promise<void>;
+  listEvaluationSuiteConfigEvaluators(configId: string): Promise<unknown[]>;
+  addEvaluatorToSuiteConfig(configId: string, evaluatorId: string): Promise<unknown>;
+  removeEvaluatorFromSuiteConfig(configId: string, evaluatorId: string): Promise<void>;
+  getEvaluationResult(resultId: string): Promise<unknown | null>;
+  createEvaluationResult(resultData: Record<string, unknown>): Promise<unknown>;
+  updateEvaluationResult(resultId: string, updateData: Record<string, unknown>): Promise<unknown>;
+  deleteEvaluationResult(resultId: string): Promise<void>;
+  /**
+  * Trigger batch evaluation of conversations with selected evaluators.
+  * Supports filtering by conversation IDs, date range, or dataset run IDs.
+  */
+  triggerBatchEvaluation(evaluationData: {
+    evaluatorIds: string[];
+    name?: string;
+    conversationIds?: string[];
+    dateRange?: {
+      startDate: string;
+      endDate: string;
+    };
+    datasetRunIds?: string[];
+  }): Promise<{
+    message: string;
+    evaluationJobConfigId: string;
+    evaluatorIds: string[];
+  }>;
+  listDatasetRuns(datasetId: string): Promise<unknown[]>;
+  getDatasetRun(runId: string): Promise<unknown | null>;
+  triggerDatasetRun(datasetId: string, runData: {
+    agentIds: string[];
+    evaluatorIds?: string[];
+  }): Promise<{
+    message: string;
+    datasetRunId: string;
+    datasetId: string;
+  }>;
+}
+/**
+* Helper function to create an EvaluationClient instance
+*/
+declare function evaluationClient(config: EvaluationClientConfig): EvaluationClient;
+//#endregion
+export { EvaluationClient, EvaluationClientConfig, evaluationClient };