@arizeai/phoenix-evals 0.6.0 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/dist/esm/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
  2. package/dist/esm/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
  3. package/dist/esm/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js +37 -0
  4. package/dist/esm/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
  5. package/dist/esm/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
  6. package/dist/esm/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
  7. package/dist/esm/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js +43 -0
  8. package/dist/esm/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
  9. package/dist/esm/__generated__/default_templates/index.d.ts +3 -0
  10. package/dist/esm/__generated__/default_templates/index.d.ts.map +1 -0
  11. package/dist/esm/__generated__/default_templates/index.js +4 -0
  12. package/dist/esm/__generated__/default_templates/index.js.map +1 -0
  13. package/dist/esm/__generated__/types.d.ts +9 -0
  14. package/dist/esm/__generated__/types.d.ts.map +1 -0
  15. package/dist/esm/__generated__/types.js +3 -0
  16. package/dist/esm/__generated__/types.js.map +1 -0
  17. package/dist/esm/llm/{createDocumentRelevancyEvaluator.d.ts → createDocumentRelevanceEvaluator.d.ts} +11 -11
  18. package/dist/esm/llm/{createDocumentRelevancyEvaluator.d.ts.map → createDocumentRelevanceEvaluator.d.ts.map} +1 -1
  19. package/dist/esm/llm/{createDocumentRelevancyEvaluator.js → createDocumentRelevanceEvaluator.js} +10 -10
  20. package/dist/esm/llm/createDocumentRelevanceEvaluator.js.map +1 -0
  21. package/dist/esm/llm/createHallucinationEvaluator.d.ts +0 -1
  22. package/dist/esm/llm/createHallucinationEvaluator.d.ts.map +1 -1
  23. package/dist/esm/llm/createHallucinationEvaluator.js +2 -2
  24. package/dist/esm/llm/createHallucinationEvaluator.js.map +1 -1
  25. package/dist/esm/llm/index.d.ts +1 -1
  26. package/dist/esm/llm/index.js +1 -1
  27. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  28. package/dist/esm/utils/bindEvaluator.d.ts +1 -1
  29. package/dist/esm/utils/bindEvaluator.js +1 -1
  30. package/dist/src/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
  31. package/dist/src/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
  32. package/dist/src/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js +40 -0
  33. package/dist/src/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
  34. package/dist/src/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts +3 -0
  35. package/dist/src/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map +1 -0
  36. package/dist/src/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js +46 -0
  37. package/dist/src/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js.map +1 -0
  38. package/dist/src/__generated__/default_templates/index.d.ts +3 -0
  39. package/dist/src/__generated__/default_templates/index.d.ts.map +1 -0
  40. package/dist/src/__generated__/default_templates/index.js +9 -0
  41. package/dist/src/__generated__/default_templates/index.js.map +1 -0
  42. package/dist/src/__generated__/types.d.ts +9 -0
  43. package/dist/src/__generated__/types.d.ts.map +1 -0
  44. package/dist/src/__generated__/types.js +4 -0
  45. package/dist/src/__generated__/types.js.map +1 -0
  46. package/dist/src/llm/{createDocumentRelevancyEvaluator.d.ts → createDocumentRelevanceEvaluator.d.ts} +11 -11
  47. package/dist/src/llm/{createDocumentRelevancyEvaluator.d.ts.map → createDocumentRelevanceEvaluator.d.ts.map} +1 -1
  48. package/dist/src/llm/{createDocumentRelevancyEvaluator.js → createDocumentRelevanceEvaluator.js} +11 -11
  49. package/dist/src/llm/createDocumentRelevanceEvaluator.js.map +1 -0
  50. package/dist/src/llm/createHallucinationEvaluator.d.ts +0 -1
  51. package/dist/src/llm/createHallucinationEvaluator.d.ts.map +1 -1
  52. package/dist/src/llm/createHallucinationEvaluator.js +2 -2
  53. package/dist/src/llm/createHallucinationEvaluator.js.map +1 -1
  54. package/dist/src/llm/index.d.ts +1 -1
  55. package/dist/src/llm/index.js +1 -1
  56. package/dist/src/utils/bindEvaluator.d.ts +1 -1
  57. package/dist/src/utils/bindEvaluator.js +1 -1
  58. package/dist/tsconfig.tsbuildinfo +1 -1
  59. package/package.json +1 -1
  60. package/src/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.ts +39 -0
  61. package/src/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.ts +45 -0
  62. package/src/__generated__/default_templates/index.ts +4 -0
  63. package/src/__generated__/types.ts +11 -0
  64. package/src/llm/{createDocumentRelevancyEvaluator.ts → createDocumentRelevanceEvaluator.ts} +18 -21
  65. package/src/llm/createHallucinationEvaluator.ts +5 -9
  66. package/src/llm/index.ts +1 -1
  67. package/src/utils/bindEvaluator.ts +1 -1
  68. package/dist/esm/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.d.ts +0 -6
  69. package/dist/esm/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.d.ts.map +0 -1
  70. package/dist/esm/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.js +0 -25
  71. package/dist/esm/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.js.map +0 -1
  72. package/dist/esm/default_templates/HALLUCINATION_TEMPLATE.d.ts +0 -6
  73. package/dist/esm/default_templates/HALLUCINATION_TEMPLATE.d.ts.map +0 -1
  74. package/dist/esm/default_templates/HALLUCINATION_TEMPLATE.js +0 -31
  75. package/dist/esm/default_templates/HALLUCINATION_TEMPLATE.js.map +0 -1
  76. package/dist/esm/default_templates/index.d.ts +0 -3
  77. package/dist/esm/default_templates/index.d.ts.map +0 -1
  78. package/dist/esm/default_templates/index.js +0 -3
  79. package/dist/esm/default_templates/index.js.map +0 -1
  80. package/dist/esm/llm/createDocumentRelevancyEvaluator.js.map +0 -1
  81. package/dist/src/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.d.ts +0 -6
  82. package/dist/src/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.d.ts.map +0 -1
  83. package/dist/src/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.js +0 -28
  84. package/dist/src/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.js.map +0 -1
  85. package/dist/src/default_templates/HALLUCINATION_TEMPLATE.d.ts +0 -6
  86. package/dist/src/default_templates/HALLUCINATION_TEMPLATE.d.ts.map +0 -1
  87. package/dist/src/default_templates/HALLUCINATION_TEMPLATE.js +0 -34
  88. package/dist/src/default_templates/HALLUCINATION_TEMPLATE.js.map +0 -1
  89. package/dist/src/default_templates/index.d.ts +0 -3
  90. package/dist/src/default_templates/index.d.ts.map +0 -1
  91. package/dist/src/default_templates/index.js +0 -19
  92. package/dist/src/default_templates/index.js.map +0 -1
  93. package/dist/src/llm/createDocumentRelevancyEvaluator.js.map +0 -1
  94. package/src/default_templates/DOCUMENT_RELEVANCY_TEMPLATE.ts +0 -25
  95. package/src/default_templates/HALLUCINATION_TEMPLATE.ts +0 -31
  96. package/src/default_templates/index.ts +0 -2
@@ -0,0 +1,3 @@
1
+ import type { ClassificationEvaluatorConfig } from "../types.js";
2
+ export declare const DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG: ClassificationEvaluatorConfig;
3
+ //# sourceMappingURL=DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.d.ts","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAE9D,eAAO,MAAM,kDAAkD,EAAE,6BAkChE,CAAC"}
@@ -0,0 +1,37 @@
1
+ // This file is generated. Do not edit by hand.
2
+ export const DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG = {
3
+ name: "document_relevance",
4
+ description: "A specialized evaluator for determining document relevance to a given question.",
5
+ optimizationDirection: "MAXIMIZE",
6
+ template: [
7
+ {
8
+ role: "user",
9
+ content: `
10
+ You are comparing a document to a question and trying to determine
11
+ if the document text contains information relevant to answering the
12
+ question. Here is the data:
13
+
14
+ [BEGIN DATA]
15
+ ************
16
+ [Question]: {{input}}
17
+ ************
18
+ [Document text]: {{documentText}}
19
+ ************
20
+ [END DATA]
21
+
22
+ Compare the question above to the document text. You must determine
23
+ whether the document text contains information that can answer the
24
+ question. Please focus on whether the very specific question can be
25
+ answered by the information in the document text. Your response must be
26
+ either "relevant" or "unrelated". "unrelated" means that the document
27
+ text does not contain an answer to the question. "relevant" means the
28
+ document text contains an answer to the question.
29
+ `,
30
+ },
31
+ ],
32
+ choices: {
33
+ "relevant": 1,
34
+ "unrelated": 0
35
+ },
36
+ };
37
+ //# sourceMappingURL=DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAI/C,MAAM,CAAC,MAAM,kDAAkD,GAAkC;IAC/F,IAAI,EAAE,oBAAoB;IAC1B,WAAW,EAAE,iFAAiF;IAC9F,qBAAqB,EAAE,UAAU;IACjC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;CAoBd;SACI;KACF;IACD,OAAO,EAAE;QACT,UAAU,EAAE,CAAC;QACb,WAAW,EAAE,CAAC;KACf;CACA,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { ClassificationEvaluatorConfig } from "../types.js";
2
+ export declare const HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG: ClassificationEvaluatorConfig;
3
+ //# sourceMappingURL=HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.d.ts","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAE9D,eAAO,MAAM,6CAA6C,EAAE,6BAwC3D,CAAC"}
@@ -0,0 +1,43 @@
1
+ // This file is generated. Do not edit by hand.
2
+ export const HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG = {
3
+ name: "hallucination",
4
+ description: "A specialized evaluator for detecting hallucinations in grounded LLM responses.",
5
+ optimizationDirection: "MINIMIZE",
6
+ template: [
7
+ {
8
+ role: "user",
9
+ content: `
10
+ In this task, you will be presented with a query, some context and a response. The response
11
+ is generated to the question based on the context. The response may contain false
12
+ information. You must use the context to determine if the response to the question
13
+ contains false information, if the response is a hallucination of facts. Your objective is
14
+ to determine whether the response text contains factual information and is not a
15
+ hallucination. A 'hallucination' refers to a response that is not based on the context or
16
+ assumes information that is not available in the context. Your response should be a single
17
+ word: either 'factual' or 'hallucinated', and it should not include any other text or
18
+ characters. 'hallucinated' indicates that the response provides factually inaccurate
19
+ information to the query based on the context. 'factual' indicates that the response to
20
+ the question is correct relative to the context, and does not contain made up
21
+ information. Please read the query and context carefully before determining your
22
+ response.
23
+
24
+ [BEGIN DATA]
25
+ ************
26
+ [Query]: {{input}}
27
+ ************
28
+ [Context]: {{context}}
29
+ ************
30
+ [Response]: {{output}}
31
+ ************
32
+ [END DATA]
33
+
34
+ Is the response above factual or hallucinated based on the query and context?
35
+ `,
36
+ },
37
+ ],
38
+ choices: {
39
+ "hallucinated": 1,
40
+ "factual": 0
41
+ },
42
+ };
43
+ //# sourceMappingURL=HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAI/C,MAAM,CAAC,MAAM,6CAA6C,GAAkC;IAC1F,IAAI,EAAE,eAAe;IACrB,WAAW,EAAE,iFAAiF;IAC9F,qBAAqB,EAAE,UAAU;IACjC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;CA0Bd;SACI;KACF;IACD,OAAO,EAAE;QACT,cAAc,EAAE,CAAC;QACjB,SAAS,EAAE,CAAC;KACb;CACA,CAAC"}
@@ -0,0 +1,3 @@
1
+ export { DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG } from "./DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js";
2
+ export { HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG } from "./HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js";
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kDAAkD,EAAE,MAAM,sDAAsD,CAAC;AAC1H,OAAO,EAAE,6CAA6C,EAAE,MAAM,iDAAiD,CAAC"}
@@ -0,0 +1,4 @@
1
+ // This file is generated. Do not edit by hand.
2
+ export { DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG } from "./DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.js";
3
+ export { HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG } from "./HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.js";
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/__generated__/default_templates/index.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAE/C,OAAO,EAAE,kDAAkD,EAAE,MAAM,sDAAsD,CAAC;AAC1H,OAAO,EAAE,6CAA6C,EAAE,MAAM,iDAAiD,CAAC"}
@@ -0,0 +1,9 @@
1
+ import type { PromptTemplate } from "../types/templating.js";
2
+ export type ClassificationEvaluatorConfig = {
3
+ name: string;
4
+ description: string;
5
+ optimizationDirection: "MINIMIZE" | "MAXIMIZE";
6
+ template: PromptTemplate;
7
+ choices: Record<string, number>;
8
+ };
9
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/__generated__/types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB,EAAE,UAAU,GAAG,UAAU,CAAC;IAC/C,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC,CAAC"}
@@ -0,0 +1,3 @@
1
+ // This file is generated. Do not edit by hand.
2
+ export {};
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/__generated__/types.ts"],"names":[],"mappings":"AAAA,+CAA+C"}
@@ -1,38 +1,38 @@
1
1
  import { CreateClassificationEvaluatorArgs } from "../types/evals.js";
2
2
  import { ClassificationEvaluator } from "./ClassificationEvaluator.js";
3
- export interface DocumentRelevancyEvaluatorArgs<RecordType extends Record<string, unknown> = DocumentRelevancyEvaluationRecord> extends Omit<CreateClassificationEvaluatorArgs<RecordType>, "promptTemplate" | "choices" | "optimizationDirection" | "name"> {
3
+ export interface DocumentRelevanceEvaluatorArgs<RecordType extends Record<string, unknown> = DocumentRelevanceEvaluationRecord> extends Omit<CreateClassificationEvaluatorArgs<RecordType>, "promptTemplate" | "choices" | "optimizationDirection" | "name"> {
4
4
  optimizationDirection?: CreateClassificationEvaluatorArgs<RecordType>["optimizationDirection"];
5
5
  name?: CreateClassificationEvaluatorArgs<RecordType>["name"];
6
6
  choices?: CreateClassificationEvaluatorArgs<RecordType>["choices"];
7
7
  promptTemplate?: CreateClassificationEvaluatorArgs<RecordType>["promptTemplate"];
8
8
  }
9
9
  /**
10
- * A record to be evaluated by the document relevancy evaluator.
10
+ * A record to be evaluated by the document relevance evaluator.
11
11
  */
12
- export interface DocumentRelevancyEvaluationRecord {
12
+ export interface DocumentRelevanceEvaluationRecord {
13
13
  input: string;
14
14
  documentText: string;
15
15
  [key: string]: unknown;
16
16
  }
17
17
  /**
18
- * Creates a document relevancy evaluator function.
18
+ * Creates a document relevance evaluator function.
19
19
  *
20
20
  * This function returns an evaluator that determines whether a given document text
21
21
  * is relevant to a provided input question. The evaluator uses a classification model
22
22
  * and a prompt template to make its determination.
23
23
  *
24
- * @param args - The arguments for creating the document relevancy evaluator.
24
+ * @param args - The arguments for creating the document relevance evaluator.
25
25
  * @param args.model - The model to use for classification.
26
- * @param args.choices - The possible classification choices (defaults to DOCUMENT_RELEVANCY_CHOICES).
27
- * @param args.promptTemplate - The prompt template to use (defaults to DOCUMENT_RELEVANCY_TEMPLATE).
26
+ * @param args.choices - The possible classification choices (defaults to DOCUMENT_RELEVANCE_CHOICES).
27
+ * @param args.promptTemplate - The prompt template to use (defaults to DOCUMENT_RELEVANCE_TEMPLATE).
28
28
  * @param args.telemetry - The telemetry to use for the evaluator.
29
29
  *
30
- * @returns An evaluator function that takes a {@link DocumentRelevancyExample} and returns a classification result
30
+ * @returns An evaluator function that takes a {@link DocumentRelevanceExample} and returns a classification result
31
31
  * indicating whether the document is relevant to the input question.
32
32
  *
33
33
  * @example
34
34
  * ```ts
35
- * const evaluator = createDocumentRelevancyEvaluator({ model: openai("gpt-4o-mini") });
35
+ * const evaluator = createDocumentRelevanceEvaluator({ model: openai("gpt-4o-mini") });
36
36
  * const result = await evaluator.evaluate({
37
37
  * input: "What is the capital of France?",
38
38
  * documentText: "Paris is the capital and most populous city of France.",
@@ -40,5 +40,5 @@ export interface DocumentRelevancyEvaluationRecord {
40
40
  * console.log(result.label); // "relevant" or "unrelated"
41
41
  * ```
42
42
  */
43
- export declare function createDocumentRelevancyEvaluator<RecordType extends Record<string, unknown> = DocumentRelevancyEvaluationRecord>(args: DocumentRelevancyEvaluatorArgs<RecordType>): ClassificationEvaluator<RecordType>;
44
- //# sourceMappingURL=createDocumentRelevancyEvaluator.d.ts.map
43
+ export declare function createDocumentRelevanceEvaluator<RecordType extends Record<string, unknown> = DocumentRelevanceEvaluationRecord>(args: DocumentRelevanceEvaluatorArgs<RecordType>): ClassificationEvaluator<RecordType>;
44
+ //# sourceMappingURL=createDocumentRelevanceEvaluator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"createDocumentRelevancyEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createDocumentRelevancyEvaluator.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGpE,MAAM,WAAW,8BAA8B,CAC7C,UAAU,SAAS,MAAM,CACvB,MAAM,EACN,OAAO,CACR,GAAG,iCAAiC,CACrC,SAAQ,IAAI,CACV,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACD,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,SAAS,MAAM,CACvB,MAAM,EACN,OAAO,CACR,GAAG,iCAAiC,EAErC,IAAI,EAAE,8BAA8B,CAAC,UAAU,CAAC,GAC/C,uBAAuB,CAAC,UAAU,CAAC,CAerC"}
1
+ {"version":3,"file":"createDocumentRelevanceEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createDocumentRelevanceEvaluator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGpE,MAAM,WAAW,8BAA8B,CAC7C,UAAU,SAAS,MAAM,CACvB,MAAM,EACN,OAAO,CACR,GAAG,iCAAiC,CACrC,SAAQ,IAAI,CACV,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACD,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,SAAS,MAAM,CACvB,MAAM,EACN,OAAO,CACR,GAAG,iCAAiC,EAErC,IAAI,EAAE,8BAA8B,CAAC,UAAU,CAAC,GAC/C,uBAAuB,CAAC,UAAU,CAAC,CAerC"}
@@ -1,24 +1,24 @@
1
- import { DOCUMENT_RELEVANCY_CHOICES, DOCUMENT_RELEVANCY_TEMPLATE, } from "../default_templates/DOCUMENT_RELEVANCY_TEMPLATE.js";
1
+ import { DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG } from "../__generated__/default_templates/index.js";
2
2
  import { createClassificationEvaluator } from "./createClassificationEvaluator.js";
3
3
  /**
4
- * Creates a document relevancy evaluator function.
4
+ * Creates a document relevance evaluator function.
5
5
  *
6
6
  * This function returns an evaluator that determines whether a given document text
7
7
  * is relevant to a provided input question. The evaluator uses a classification model
8
8
  * and a prompt template to make its determination.
9
9
  *
10
- * @param args - The arguments for creating the document relevancy evaluator.
10
+ * @param args - The arguments for creating the document relevance evaluator.
11
11
  * @param args.model - The model to use for classification.
12
- * @param args.choices - The possible classification choices (defaults to DOCUMENT_RELEVANCY_CHOICES).
13
- * @param args.promptTemplate - The prompt template to use (defaults to DOCUMENT_RELEVANCY_TEMPLATE).
12
+ * @param args.choices - The possible classification choices (defaults to DOCUMENT_RELEVANCE_CHOICES).
13
+ * @param args.promptTemplate - The prompt template to use (defaults to DOCUMENT_RELEVANCE_TEMPLATE).
14
14
  * @param args.telemetry - The telemetry to use for the evaluator.
15
15
  *
16
- * @returns An evaluator function that takes a {@link DocumentRelevancyExample} and returns a classification result
16
+ * @returns An evaluator function that takes a {@link DocumentRelevanceExample} and returns a classification result
17
17
  * indicating whether the document is relevant to the input question.
18
18
  *
19
19
  * @example
20
20
  * ```ts
21
- * const evaluator = createDocumentRelevancyEvaluator({ model: openai("gpt-4o-mini") });
21
+ * const evaluator = createDocumentRelevanceEvaluator({ model: openai("gpt-4o-mini") });
22
22
  * const result = await evaluator.evaluate({
23
23
  * input: "What is the capital of France?",
24
24
  * documentText: "Paris is the capital and most populous city of France.",
@@ -26,8 +26,8 @@ import { createClassificationEvaluator } from "./createClassificationEvaluator.j
26
26
  * console.log(result.label); // "relevant" or "unrelated"
27
27
  * ```
28
28
  */
29
- export function createDocumentRelevancyEvaluator(args) {
30
- const { choices = DOCUMENT_RELEVANCY_CHOICES, promptTemplate = DOCUMENT_RELEVANCY_TEMPLATE, optimizationDirection = "MAXIMIZE", name = "document_relevancy", ...rest } = args;
29
+ export function createDocumentRelevanceEvaluator(args) {
30
+ const { choices = DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.choices, promptTemplate = DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.template, optimizationDirection = DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.optimizationDirection, name = DOCUMENT_RELEVANCE_CLASSIFICATION_EVALUATOR_CONFIG.name, ...rest } = args;
31
31
  return createClassificationEvaluator({
32
32
  ...rest,
33
33
  promptTemplate,
@@ -36,4 +36,4 @@ export function createDocumentRelevancyEvaluator(args) {
36
36
  name,
37
37
  });
38
38
  }
39
- //# sourceMappingURL=createDocumentRelevancyEvaluator.js.map
39
+ //# sourceMappingURL=createDocumentRelevanceEvaluator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createDocumentRelevanceEvaluator.js","sourceRoot":"","sources":["../../../src/llm/createDocumentRelevanceEvaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kDAAkD,EAAE,MAAM,oCAAoC,CAAC;AAIxG,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AA0BhF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,gCAAgC,CAM9C,IAAgD;IAEhD,MAAM,EACJ,OAAO,GAAG,kDAAkD,CAAC,OAAO,EACpE,cAAc,GAAG,kDAAkD,CAAC,QAAQ,EAC5E,qBAAqB,GAAG,kDAAkD,CAAC,qBAAqB,EAChG,IAAI,GAAG,kDAAkD,CAAC,IAAI,EAC9D,GAAG,IAAI,EACR,GAAG,IAAI,CAAC;IACT,OAAO,6BAA6B,CAAa;QAC/C,GAAG,IAAI;QACP,cAAc;QACd,OAAO;QACP,qBAAqB;QACrB,IAAI;KACL,CAAC,CAAC;AACL,CAAC"}
@@ -12,7 +12,6 @@ export interface HallucinationEvaluatorArgs<RecordType extends Record<string, un
12
12
  export type HallucinationEvaluationRecord = {
13
13
  input: string;
14
14
  output: string;
15
- reference?: string;
16
15
  context?: string;
17
16
  };
18
17
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"createHallucinationEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createHallucinationEvaluator.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGpE,MAAM,WAAW,0BAA0B,CACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,6BAA6B,CAC1E,SAAQ,IAAI,CACV,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACD,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,6BAA6B,EAE1E,IAAI,EAAE,0BAA0B,CAAC,UAAU,CAAC,GAC3C,uBAAuB,CAAC,UAAU,CAAC,CAerC"}
1
+ {"version":3,"file":"createHallucinationEvaluator.d.ts","sourceRoot":"","sources":["../../../src/llm/createHallucinationEvaluator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAGpE,MAAM,WAAW,0BAA0B,CACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,6BAA6B,CAC1E,SAAQ,IAAI,CACV,iCAAiC,CAAC,UAAU,CAAC,EAC7C,gBAAgB,GAAG,SAAS,GAAG,uBAAuB,GAAG,MAAM,CAChE;IACD,qBAAqB,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC/F,IAAI,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC7D,OAAO,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC;IACnE,cAAc,CAAC,EAAE,iCAAiC,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAClF;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AACF;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,6BAA6B,EAE1E,IAAI,EAAE,0BAA0B,CAAC,UAAU,CAAC,GAC3C,uBAAuB,CAAC,UAAU,CAAC,CAerC"}
@@ -1,4 +1,4 @@
1
- import { HALLUCINATION_CHOICES, HALLUCINATION_TEMPLATE, } from "../default_templates/HALLUCINATION_TEMPLATE.js";
1
+ import { HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG } from "../__generated__/default_templates/index.js";
2
2
  import { createClassificationEvaluator } from "./createClassificationEvaluator.js";
3
3
  /**
4
4
  * Creates a function that evaluates whether an answer is factual or hallucinated based on a query and reference text.
@@ -7,7 +7,7 @@ import { createClassificationEvaluator } from "./createClassificationEvaluator.j
7
7
  * @returns A function that evaluates whether an answer is factual or hallucinated based on a query and reference text.
8
8
  */
9
9
  export function createHallucinationEvaluator(args) {
10
- const { choices = HALLUCINATION_CHOICES, promptTemplate = HALLUCINATION_TEMPLATE, optimizationDirection = "MINIMIZE", name = "hallucination", ...rest } = args;
10
+ const { choices = HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.choices, promptTemplate = HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.template, optimizationDirection = HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.optimizationDirection, name = HALLUCINATION_CLASSIFICATION_EVALUATOR_CONFIG.name, ...rest } = args;
11
11
  return createClassificationEvaluator({
12
12
  ...rest,
13
13
  promptTemplate,
@@ -1 +1 @@
1
- {"version":3,"file":"createHallucinationEvaluator.js","sourceRoot":"","sources":["../../../src/llm/createHallucinationEvaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,6CAA6C,CAAC;AAIrD,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAuBhF;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAG1C,IAA4C;IAE5C,MAAM,EACJ,OAAO,GAAG,qBAAqB,EAC/B,cAAc,GAAG,sBAAsB,EACvC,qBAAqB,GAAG,UAAU,EAClC,IAAI,GAAG,eAAe,EACtB,GAAG,IAAI,EACR,GAAG,IAAI,CAAC;IACT,OAAO,6BAA6B,CAAa;QAC/C,GAAG,IAAI;QACP,cAAc;QACd,OAAO;QACP,qBAAqB;QACrB,IAAI;KACL,CAAC,CAAC;AACL,CAAC"}
1
+ {"version":3,"file":"createHallucinationEvaluator.js","sourceRoot":"","sources":["../../../src/llm/createHallucinationEvaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6CAA6C,EAAE,MAAM,oCAAoC,CAAC;AAInG,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAsBhF;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAG1C,IAA4C;IAE5C,MAAM,EACJ,OAAO,GAAG,6CAA6C,CAAC,OAAO,EAC/D,cAAc,GAAG,6CAA6C,CAAC,QAAQ,EACvE,qBAAqB,GAAG,6CAA6C,CAAC,qBAAqB,EAC3F,IAAI,GAAG,6CAA6C,CAAC,IAAI,EACzD,GAAG,IAAI,EACR,GAAG,IAAI,CAAC;IACT,OAAO,6BAA6B,CAAa;QAC/C,GAAG,IAAI;QACP,cAAc;QACd,OAAO;QACP,qBAAqB;QACrB,IAAI;KACL,CAAC,CAAC;AACL,CAAC"}
@@ -2,7 +2,7 @@ export * from "./generateClassification.js";
2
2
  export * from "./createClassifierFn.js";
3
3
  export * from "./createClassificationEvaluator.js";
4
4
  export * from "./createHallucinationEvaluator.js";
5
- export * from "./createDocumentRelevancyEvaluator.js";
5
+ export * from "./createDocumentRelevanceEvaluator.js";
6
6
  export * from "./ClassificationEvaluator.js";
7
7
  export * from "./LLMEvaluator.js";
8
8
  //# sourceMappingURL=index.d.ts.map
@@ -2,7 +2,7 @@ export * from "./generateClassification.js";
2
2
  export * from "./createClassifierFn.js";
3
3
  export * from "./createClassificationEvaluator.js";
4
4
  export * from "./createHallucinationEvaluator.js";
5
- export * from "./createDocumentRelevancyEvaluator.js";
5
+ export * from "./createDocumentRelevanceEvaluator.js";
6
6
  export * from "./ClassificationEvaluator.js";
7
7
  export * from "./LLMEvaluator.js";
8
8
  //# sourceMappingURL=index.js.map