Skip to content

Index

评估模块。

BaseEvaluator #

Bases: PromptMixin

基础评估器类。

Source code in llama_index/core/evaluation/base.py 
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
class BaseEvaluator(PromptMixin):
    """基础评估器类。"""

    def _get_prompt_modules(self) -> PromptMixinType:
        """获取提示模块。"""
        return {}

    def evaluate(
        self,
        query: Optional[str] = None,
        response: Optional[str] = None,
        contexts: Optional[Sequence[str]] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串、检索到的上下文和生成的响应字符串运行评估。

子类可以重写此方法以提供自定义评估逻辑，并接受额外的参数。
"""
        return asyncio_run(
            self.aevaluate(
                query=query,
                response=response,
                contexts=contexts,
                **kwargs,
            )
        )

    @abstractmethod
    async def aevaluate(
        self,
        query: Optional[str] = None,
        response: Optional[str] = None,
        contexts: Optional[Sequence[str]] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串、检索到的上下文和生成的响应字符串运行评估。

子类可以重写此方法以提供自定义评估逻辑，并接受额外的参数。
"""
        raise NotImplementedError

    def evaluate_response(
        self,
        query: Optional[str] = None,
        response: Optional[Response] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串和生成的响应对象运行评估。

子类可以重写此方法以提供自定义评估逻辑并接受额外的参数。
"""
        response_str: Optional[str] = None
        contexts: Optional[Sequence[str]] = None
        if response is not None:
            response_str = response.response
            contexts = [node.get_content() for node in response.source_nodes]

        return self.evaluate(
            query=query, response=response_str, contexts=contexts, **kwargs
        )

    async def aevaluate_response(
        self,
        query: Optional[str] = None,
        response: Optional[Response] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串和生成的响应对象运行评估。

子类可以重写此方法以提供自定义评估逻辑并接受额外的参数。
"""
        response_str: Optional[str] = None
        contexts: Optional[Sequence[str]] = None
        if response is not None:
            response_str = response.response
            contexts = [node.get_content() for node in response.source_nodes]

        return await self.aevaluate(
            query=query, response=response_str, contexts=contexts, **kwargs
        )

evaluate #

evaluate(
    query: Optional[str] = None,
    response: Optional[str] = None,
    contexts: Optional[Sequence[str]] = None,
    **kwargs: Any
) -> EvaluationResult

使用查询字符串、检索到的上下文和生成的响应字符串运行评估。

子类可以重写此方法以提供自定义评估逻辑，并接受额外的参数。

Source code in llama_index/core/evaluation/base.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
    def evaluate(
        self,
        query: Optional[str] = None,
        response: Optional[str] = None,
        contexts: Optional[Sequence[str]] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串、检索到的上下文和生成的响应字符串运行评估。

子类可以重写此方法以提供自定义评估逻辑，并接受额外的参数。
"""
        return asyncio_run(
            self.aevaluate(
                query=query,
                response=response,
                contexts=contexts,
                **kwargs,
            )
        )

aevaluate abstractmethod async #

aevaluate(
    query: Optional[str] = None,
    response: Optional[str] = None,
    contexts: Optional[Sequence[str]] = None,
    **kwargs: Any
) -> EvaluationResult

使用查询字符串、检索到的上下文和生成的响应字符串运行评估。

子类可以重写此方法以提供自定义评估逻辑，并接受额外的参数。

Source code in llama_index/core/evaluation/base.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
    @abstractmethod
    async def aevaluate(
        self,
        query: Optional[str] = None,
        response: Optional[str] = None,
        contexts: Optional[Sequence[str]] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串、检索到的上下文和生成的响应字符串运行评估。

子类可以重写此方法以提供自定义评估逻辑，并接受额外的参数。
"""
        raise NotImplementedError

evaluate_response #

evaluate_response(
    query: Optional[str] = None,
    response: Optional[Response] = None,
    **kwargs: Any
) -> EvaluationResult

使用查询字符串和生成的响应对象运行评估。

子类可以重写此方法以提供自定义评估逻辑并接受额外的参数。

Source code in llama_index/core/evaluation/base.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
    def evaluate_response(
        self,
        query: Optional[str] = None,
        response: Optional[Response] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串和生成的响应对象运行评估。

子类可以重写此方法以提供自定义评估逻辑并接受额外的参数。
"""
        response_str: Optional[str] = None
        contexts: Optional[Sequence[str]] = None
        if response is not None:
            response_str = response.response
            contexts = [node.get_content() for node in response.source_nodes]

        return self.evaluate(
            query=query, response=response_str, contexts=contexts, **kwargs
        )

aevaluate_response async #

aevaluate_response(
    query: Optional[str] = None,
    response: Optional[Response] = None,
    **kwargs: Any
) -> EvaluationResult

使用查询字符串和生成的响应对象运行评估。

子类可以重写此方法以提供自定义评估逻辑并接受额外的参数。

Source code in llama_index/core/evaluation/base.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
    async def aevaluate_response(
        self,
        query: Optional[str] = None,
        response: Optional[Response] = None,
        **kwargs: Any,
    ) -> EvaluationResult:
        """使用查询字符串和生成的响应对象运行评估。

子类可以重写此方法以提供自定义评估逻辑并接受额外的参数。
"""
        response_str: Optional[str] = None
        contexts: Optional[Sequence[str]] = None
        if response is not None:
            response_str = response.response
            contexts = [node.get_content() for node in response.source_nodes]

        return await self.aevaluate(
            query=query, response=response_str, contexts=contexts, **kwargs
        )

EvaluationResult #

Bases: BaseModel

评估结果。

BaseEvaluator的输出。

Source code in llama_index/core/evaluation/base.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class EvaluationResult(BaseModel):
    """评估结果。

    BaseEvaluator的输出。"""

    query: Optional[str] = Field(None, description="Query string")
    contexts: Optional[Sequence[str]] = Field(None, description="Context strings")
    response: Optional[str] = Field(None, description="Response string")
    passing: Optional[bool] = Field(
        None, description="Binary evaluation result (passing or not)"
    )
    feedback: Optional[str] = Field(
        None, description="Feedback or reasoning for the response"
    )
    score: Optional[float] = Field(None, description="Score for the response")
    pairwise_source: Optional[str] = Field(
        None,
        description=(
            "Used only for pairwise and specifies whether it is from original order of"
            " presented answers or flipped order"
        ),
    )
    invalid_result: bool = Field(
        default=False, description="Whether the evaluation result is an invalid one."
    )
    invalid_reason: Optional[str] = Field(
        default=None, description="Reason for invalid evaluation."
    )

BatchEvalRunner #

批量评估运行程序。

Parameters:

Name Type Description Default
evaluators Dict[str, BaseEvaluator]

评估器的字典。

 required
workers int

用于并行化的工作进程数。默认为2。

 2
show_progress bool

是否显示进度条。默认为False。

 False
Source code in llama_index/core/evaluation/batch_runner.py 
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
class BatchEvalRunner:
    """批量评估运行程序。

Args:
    evaluators (Dict[str, BaseEvaluator]): 评估器的字典。
    workers (int): 用于并行化的工作进程数。默认为2。
    show_progress (bool): 是否显示进度条。默认为False。"""

    def __init__(
        self,
        evaluators: Dict[str, BaseEvaluator],
        workers: int = 2,
        show_progress: bool = False,
    ):
        self.evaluators = evaluators
        self.workers = workers
        self.semaphore = asyncio.Semaphore(self.workers)
        self.show_progress = show_progress
        self.asyncio_mod = asyncio_module(show_progress=self.show_progress)

    def _format_results(
        self, results: List[EvaluationResult]
    ) -> Dict[str, List[EvaluationResult]]:
        """格式化结果。"""
        # Format results
        results_dict: Dict[str, List[EvaluationResult]] = {
            name: [] for name in self.evaluators
        }
        for name, result in results:
            results_dict[name].append(result)

        return results_dict

    def _validate_and_clean_inputs(
        self,
        *inputs_list: Any,
    ) -> List[Any]:
        """验证和清理输入列表。

强制要求至少有一个输入不是None。
确保所有输入具有相同的长度。
确保将None输入替换为[None] * len(inputs)。
"""
        assert len(inputs_list) > 0
        # first, make sure at least one of queries or response_strs is not None
        input_len: Optional[int] = None
        for inputs in inputs_list:
            if inputs is not None:
                input_len = len(inputs)
                break
        if input_len is None:
            raise ValueError("At least one item in inputs_list must be provided.")

        new_inputs_list = []
        for inputs in inputs_list:
            if inputs is None:
                new_inputs_list.append([None] * input_len)
            else:
                if len(inputs) != input_len:
                    raise ValueError("All inputs must have the same length.")
                new_inputs_list.append(inputs)
        return new_inputs_list

    def _validate_nested_eval_kwargs_types(
        self, eval_kwargs_lists: Dict[str, Any]
    ) -> Dict[str, Any]:
        """确保评估kwargs的格式是可接受的。
    可以是Dict[str, List]或Dict[str, Dict[str, List]]的格式。

允许在保持单个评估器的向后兼容性的同时，使用不同的kwargs（例如引用）与不同的评估器。
"""
        if not isinstance(eval_kwargs_lists, dict):
            raise ValueError(
                f"eval_kwargs_lists must be a dict. Got {eval_kwargs_lists}"
            )

        for evaluator, eval_kwargs in eval_kwargs_lists.items():
            if isinstance(eval_kwargs, list):
                # maintain backwards compatibility - for use with single evaluator
                eval_kwargs_lists[evaluator] = self._validate_and_clean_inputs(
                    eval_kwargs
                )[0]
            elif isinstance(eval_kwargs, dict):
                # for use with multiple evaluators
                for k in eval_kwargs:
                    v = eval_kwargs[k]
                    if not isinstance(v, list):
                        raise ValueError(
                            f"nested inner values in eval_kwargs must be a list. Got {evaluator}: {k}: {v}"
                        )
                    eval_kwargs_lists[evaluator][k] = self._validate_and_clean_inputs(
                        v
                    )[0]
            else:
                raise ValueError(
                    f"eval_kwargs must be a list or a dict. Got {evaluator}: {eval_kwargs}"
                )
        return eval_kwargs_lists

    def _get_eval_kwargs(
        self, eval_kwargs_lists: Dict[str, Any], idx: int
    ) -> Dict[str, Any]:
        """从给定的索引处的 eval_kwargs_lists 中获取 eval kwargs。

由于 eval_kwargs_lists 是一个列表的字典，我们需要获取每个键的索引处的值。
"""
        return {k: v[idx] for k, v in eval_kwargs_lists.items()}

    async def aevaluate_response_strs(
        self,
        queries: Optional[List[str]] = None,
        response_strs: Optional[List[str]] = None,
        contexts_list: Optional[List[List[str]]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对。

这将评估查询、响应和上下文作为字符串输入。
可以在eval_kwargs_lists中提供额外的kwargs给评估器。

Args:
    queries (Optional[List[str]]): 查询字符串列表。默认为None。
    response_strs (Optional[List[str]]): 响应字符串列表。默认为None。
    contexts_list (Optional[List[List[str]]]): 上下文列表的列表。默认为None。
    **eval_kwargs_lists (Dict[str, Any]): 要传递给评估器的kwargs的字典，可以是字典或列表。
        默认为None。
            多个评估器: {评估器: {kwarg: [值列表]},...}
            单个评估器: {kwarg: [值列表]}
"""
        queries, response_strs, contexts_list = self._validate_and_clean_inputs(
            queries, response_strs, contexts_list
        )
        eval_kwargs_lists = self._validate_nested_eval_kwargs_types(eval_kwargs_lists)

        # boolean to check if using multi kwarg evaluator
        multi_kwargs = len(eval_kwargs_lists) > 0 and isinstance(
            next(iter(eval_kwargs_lists.values())), dict
        )

        # run evaluations
        eval_jobs = []
        for idx, query in enumerate(cast(List[str], queries)):
            response_str = cast(List, response_strs)[idx]
            contexts = cast(List, contexts_list)[idx]
            for name, evaluator in self.evaluators.items():
                if multi_kwargs:
                    # multi-evaluator - get appropriate runtime kwargs if present
                    kwargs = (
                        eval_kwargs_lists[name] if name in eval_kwargs_lists else {}
                    )
                else:
                    # single evaluator (maintain backwards compatibility)
                    kwargs = eval_kwargs_lists
                eval_kwargs = self._get_eval_kwargs(kwargs, idx)
                eval_jobs.append(
                    eval_worker(
                        self.semaphore,
                        evaluator,
                        name,
                        query=query,
                        response_str=response_str,
                        contexts=contexts,
                        eval_kwargs=eval_kwargs,
                    )
                )
        results = await self.asyncio_mod.gather(*eval_jobs)

        # Format results
        return self._format_results(results)

    async def aevaluate_responses(
        self,
        queries: Optional[List[str]] = None,
        responses: Optional[List[Response]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对。

这个函数用来评估查询和响应对象。

Args:
    queries (Optional[List[str]]): 查询字符串的列表。默认为None。
    responses (Optional[List[Response]]): 响应对象的列表。默认为None。
    **eval_kwargs_lists (Dict[str, Any]): 传递给评估器的参数字典，可以是字典或列表。默认为None。
            多个评估器: {评估器: {Args: [值的列表]},...}
            单个评估器: {Args: [值的列表]}
"""
        queries, responses = self._validate_and_clean_inputs(queries, responses)
        eval_kwargs_lists = self._validate_nested_eval_kwargs_types(eval_kwargs_lists)

        # boolean to check if using multi kwarg evaluator
        multi_kwargs = len(eval_kwargs_lists) > 0 and isinstance(
            next(iter(eval_kwargs_lists.values())), dict
        )

        # run evaluations
        eval_jobs = []
        for idx, query in enumerate(cast(List[str], queries)):
            response = cast(List, responses)[idx]
            for name, evaluator in self.evaluators.items():
                if multi_kwargs:
                    # multi-evaluator - get appropriate runtime kwargs if present
                    kwargs = (
                        eval_kwargs_lists[name] if name in eval_kwargs_lists else {}
                    )
                else:
                    # single evaluator (maintain backwards compatibility)
                    kwargs = eval_kwargs_lists
                eval_kwargs = self._get_eval_kwargs(kwargs, idx)
                eval_jobs.append(
                    eval_response_worker(
                        self.semaphore,
                        evaluator,
                        name,
                        query=query,
                        response=response,
                        eval_kwargs=eval_kwargs,
                    )
                )
        results = await self.asyncio_mod.gather(*eval_jobs)

        # Format results
        return self._format_results(results)

    async def aevaluate_queries(
        self,
        query_engine: BaseQueryEngine,
        queries: Optional[List[str]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询。

Args:
    query_engine（BaseQueryEngine）：查询引擎。
    queries（Optional[List[str]]）：查询字符串列表。默认为None。
    **eval_kwargs_lists（Dict[str, Any]）：传递给评估器的kwargs列表的字典。默认为None。
"""
        if queries is None:
            raise ValueError("`queries` must be provided")

        # gather responses
        response_jobs = []
        for query in queries:
            response_jobs.append(response_worker(self.semaphore, query_engine, query))
        responses = await self.asyncio_mod.gather(*response_jobs)

        return await self.aevaluate_responses(
            queries=queries,
            responses=responses,
            **eval_kwargs_lists,
        )

    def evaluate_response_strs(
        self,
        queries: Optional[List[str]] = None,
        response_strs: Optional[List[str]] = None,
        contexts_list: Optional[List[List[str]]] = None,
        **eval_kwargs_lists: List,
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对。

aevaluate_response_strs的同步版本。
"""
        return asyncio_run(
            self.aevaluate_response_strs(
                queries=queries,
                response_strs=response_strs,
                contexts_list=contexts_list,
                **eval_kwargs_lists,
            )
        )

    def evaluate_responses(
        self,
        queries: Optional[List[str]] = None,
        responses: Optional[List[Response]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对象。

aevaluate_responses的同步版本。
"""
        return asyncio_run(
            self.aevaluate_responses(
                queries=queries,
                responses=responses,
                **eval_kwargs_lists,
            )
        )

    def evaluate_queries(
        self,
        query_engine: BaseQueryEngine,
        queries: Optional[List[str]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询。

aevaluate_queries的同步版本。
"""
        return asyncio_run(
            self.aevaluate_queries(
                query_engine=query_engine,
                queries=queries,
                **eval_kwargs_lists,
            )
        )

    def upload_eval_results(
        self,
        project_name: str,
        app_name: str,
        results: Dict[str, List[EvaluationResult]],
    ) -> None:
        """将评估结果上传到LlamaCloud。

Args:
    project_name (str): 项目的名称。
    app_name (str): 应用的名称。
    results (Dict[str, List[EvaluationResult]]):
        评估结果，指标名称到EvaluationResult对象列表的映射。

示例:
    ```python
    results = batch_runner.evaluate_responses(...)

    batch_runner.upload_eval_results(
        project_name="my_project",
        app_name="my_app",
        results=results
    )
    ```
"""
        from llama_index.core.evaluation.eval_utils import upload_eval_results

        upload_eval_results(
            project_name=project_name, app_name=app_name, results=results
        )

aevaluate_response_strs async #

aevaluate_response_strs(
    queries: Optional[List[str]] = None,
    response_strs: Optional[List[str]] = None,
    contexts_list: Optional[List[List[str]]] = None,
    **eval_kwargs_lists: Dict[str, Any]
) -> Dict[str, List[EvaluationResult]]

评估查询和响应对。

这将评估查询、响应和上下文作为字符串输入。 可以在eval_kwargs_lists中提供额外的kwargs给评估器。

Parameters:

Name Type Description Default
queries Optional[List[str]]

查询字符串列表。默认为None。

 None
response_strs Optional[List[str]]

响应字符串列表。默认为None。

 None
contexts_list Optional[List[List[str]]]

上下文列表的列表。默认为None。

 None
**eval_kwargs_lists Dict[str, Any]

要传递给评估器的kwargs的字典，可以是字典或列表。 默认为None。 多个评估器: {评估器: {kwarg: [值列表]},...} 单个评估器: {kwarg: [值列表]}

 {}
Source code in llama_index/core/evaluation/batch_runner.py 
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    async def aevaluate_response_strs(
        self,
        queries: Optional[List[str]] = None,
        response_strs: Optional[List[str]] = None,
        contexts_list: Optional[List[List[str]]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对。

这将评估查询、响应和上下文作为字符串输入。
可以在eval_kwargs_lists中提供额外的kwargs给评估器。

Args:
    queries (Optional[List[str]]): 查询字符串列表。默认为None。
    response_strs (Optional[List[str]]): 响应字符串列表。默认为None。
    contexts_list (Optional[List[List[str]]]): 上下文列表的列表。默认为None。
    **eval_kwargs_lists (Dict[str, Any]): 要传递给评估器的kwargs的字典，可以是字典或列表。
        默认为None。
            多个评估器: {评估器: {kwarg: [值列表]},...}
            单个评估器: {kwarg: [值列表]}
"""
        queries, response_strs, contexts_list = self._validate_and_clean_inputs(
            queries, response_strs, contexts_list
        )
        eval_kwargs_lists = self._validate_nested_eval_kwargs_types(eval_kwargs_lists)

        # boolean to check if using multi kwarg evaluator
        multi_kwargs = len(eval_kwargs_lists) > 0 and isinstance(
            next(iter(eval_kwargs_lists.values())), dict
        )

        # run evaluations
        eval_jobs = []
        for idx, query in enumerate(cast(List[str], queries)):
            response_str = cast(List, response_strs)[idx]
            contexts = cast(List, contexts_list)[idx]
            for name, evaluator in self.evaluators.items():
                if multi_kwargs:
                    # multi-evaluator - get appropriate runtime kwargs if present
                    kwargs = (
                        eval_kwargs_lists[name] if name in eval_kwargs_lists else {}
                    )
                else:
                    # single evaluator (maintain backwards compatibility)
                    kwargs = eval_kwargs_lists
                eval_kwargs = self._get_eval_kwargs(kwargs, idx)
                eval_jobs.append(
                    eval_worker(
                        self.semaphore,
                        evaluator,
                        name,
                        query=query,
                        response_str=response_str,
                        contexts=contexts,
                        eval_kwargs=eval_kwargs,
                    )
                )
        results = await self.asyncio_mod.gather(*eval_jobs)

        # Format results
        return self._format_results(results)

aevaluate_responses async #

aevaluate_responses(
    queries: Optional[List[str]] = None,
    responses: Optional[List[Response]] = None,
    **eval_kwargs_lists: Dict[str, Any]
) -> Dict[str, List[EvaluationResult]]

评估查询和响应对。

这个函数用来评估查询和响应对象。

Parameters:

Name Type Description Default
queries Optional[List[str]]

查询字符串的列表。默认为None。

 None
responses Optional[List[Response]]

响应对象的列表。默认为None。

 None
**eval_kwargs_lists Dict[str, Any]

传递给评估器的参数字典，可以是字典或列表。默认为None。 多个评估器: {评估器: {Args: [值的列表]},...} 单个评估器: {Args: [值的列表]}

 {}
Source code in llama_index/core/evaluation/batch_runner.py 
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
    async def aevaluate_responses(
        self,
        queries: Optional[List[str]] = None,
        responses: Optional[List[Response]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对。

这个函数用来评估查询和响应对象。

Args:
    queries (Optional[List[str]]): 查询字符串的列表。默认为None。
    responses (Optional[List[Response]]): 响应对象的列表。默认为None。
    **eval_kwargs_lists (Dict[str, Any]): 传递给评估器的参数字典，可以是字典或列表。默认为None。
            多个评估器: {评估器: {Args: [值的列表]},...}
            单个评估器: {Args: [值的列表]}
"""
        queries, responses = self._validate_and_clean_inputs(queries, responses)
        eval_kwargs_lists = self._validate_nested_eval_kwargs_types(eval_kwargs_lists)

        # boolean to check if using multi kwarg evaluator
        multi_kwargs = len(eval_kwargs_lists) > 0 and isinstance(
            next(iter(eval_kwargs_lists.values())), dict
        )

        # run evaluations
        eval_jobs = []
        for idx, query in enumerate(cast(List[str], queries)):
            response = cast(List, responses)[idx]
            for name, evaluator in self.evaluators.items():
                if multi_kwargs:
                    # multi-evaluator - get appropriate runtime kwargs if present
                    kwargs = (
                        eval_kwargs_lists[name] if name in eval_kwargs_lists else {}
                    )
                else:
                    # single evaluator (maintain backwards compatibility)
                    kwargs = eval_kwargs_lists
                eval_kwargs = self._get_eval_kwargs(kwargs, idx)
                eval_jobs.append(
                    eval_response_worker(
                        self.semaphore,
                        evaluator,
                        name,
                        query=query,
                        response=response,
                        eval_kwargs=eval_kwargs,
                    )
                )
        results = await self.asyncio_mod.gather(*eval_jobs)

        # Format results
        return self._format_results(results)

aevaluate_queries async #

aevaluate_queries(
    query_engine: BaseQueryEngine,
    queries: Optional[List[str]] = None,
    **eval_kwargs_lists: Dict[str, Any]
) -> Dict[str, List[EvaluationResult]]

评估查询。

Source code in llama_index/core/evaluation/batch_runner.py 
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
    async def aevaluate_queries(
        self,
        query_engine: BaseQueryEngine,
        queries: Optional[List[str]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询。

Args:
    query_engine（BaseQueryEngine）：查询引擎。
    queries（Optional[List[str]]）：查询字符串列表。默认为None。
    **eval_kwargs_lists（Dict[str, Any]）：传递给评估器的kwargs列表的字典。默认为None。
"""
        if queries is None:
            raise ValueError("`queries` must be provided")

        # gather responses
        response_jobs = []
        for query in queries:
            response_jobs.append(response_worker(self.semaphore, query_engine, query))
        responses = await self.asyncio_mod.gather(*response_jobs)

        return await self.aevaluate_responses(
            queries=queries,
            responses=responses,
            **eval_kwargs_lists,
        )

evaluate_response_strs #

evaluate_response_strs(
    queries: Optional[List[str]] = None,
    response_strs: Optional[List[str]] = None,
    contexts_list: Optional[List[List[str]]] = None,
    **eval_kwargs_lists: List
) -> Dict[str, List[EvaluationResult]]

评估查询和响应对。

aevaluate_response_strs的同步版本。

Source code in llama_index/core/evaluation/batch_runner.py 
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
    def evaluate_response_strs(
        self,
        queries: Optional[List[str]] = None,
        response_strs: Optional[List[str]] = None,
        contexts_list: Optional[List[List[str]]] = None,
        **eval_kwargs_lists: List,
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对。

aevaluate_response_strs的同步版本。
"""
        return asyncio_run(
            self.aevaluate_response_strs(
                queries=queries,
                response_strs=response_strs,
                contexts_list=contexts_list,
                **eval_kwargs_lists,
            )
        )

evaluate_responses #

evaluate_responses(
    queries: Optional[List[str]] = None,
    responses: Optional[List[Response]] = None,
    **eval_kwargs_lists: Dict[str, Any]
) -> Dict[str, List[EvaluationResult]]

评估查询和响应对象。

aevaluate_responses的同步版本。

Source code in llama_index/core/evaluation/batch_runner.py 
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
    def evaluate_responses(
        self,
        queries: Optional[List[str]] = None,
        responses: Optional[List[Response]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询和响应对象。

aevaluate_responses的同步版本。
"""
        return asyncio_run(
            self.aevaluate_responses(
                queries=queries,
                responses=responses,
                **eval_kwargs_lists,
            )
        )

evaluate_queries #

evaluate_queries(
    query_engine: BaseQueryEngine,
    queries: Optional[List[str]] = None,
    **eval_kwargs_lists: Dict[str, Any]
) -> Dict[str, List[EvaluationResult]]

评估查询。

aevaluate_queries的同步版本。

Source code in llama_index/core/evaluation/batch_runner.py 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
    def evaluate_queries(
        self,
        query_engine: BaseQueryEngine,
        queries: Optional[List[str]] = None,
        **eval_kwargs_lists: Dict[str, Any],
    ) -> Dict[str, List[EvaluationResult]]:
        """评估查询。

aevaluate_queries的同步版本。
"""
        return asyncio_run(
            self.aevaluate_queries(
                query_engine=query_engine,
                queries=queries,
                **eval_kwargs_lists,
            )
        )

upload_eval_results #

upload_eval_results(
    project_name: str,
    app_name: str,
    results: Dict[str, List[EvaluationResult]],
) -> None

将评估结果上传到LlamaCloud。

Parameters:

Name Type Description Default
project_name str

项目的名称。

 required
app_name str

应用的名称。

 required
results Dict[str, List[EvaluationResult]]

评估结果，指标名称到EvaluationResult对象列表的映射。

 required
示例 
results = batch_runner.evaluate_responses(...)

batch_runner.upload_eval_results(
    project_name="my_project",
    app_name="my_app",
    results=results
)
Source code in llama_index/core/evaluation/batch_runner.py 
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
    def upload_eval_results(
        self,
        project_name: str,
        app_name: str,
        results: Dict[str, List[EvaluationResult]],
    ) -> None:
        """将评估结果上传到LlamaCloud。

Args:
    project_name (str): 项目的名称。
    app_name (str): 应用的名称。
    results (Dict[str, List[EvaluationResult]]):
        评估结果，指标名称到EvaluationResult对象列表的映射。

示例:
    ```python
    results = batch_runner.evaluate_responses(...)

    batch_runner.upload_eval_results(
        project_name="my_project",
        app_name="my_app",
        results=results
    )
    ```
"""
        from llama_index.core.evaluation.eval_utils import upload_eval_results

        upload_eval_results(
            project_name=project_name, app_name=app_name, results=results
        )