Index
Evaluation modules.
BaseEvaluator #
Bases: PromptMixin
Base Evaluator class.
Source code in llama-index-core/llama_index/core/evaluation/base.py
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 121 122 123 124 125 126 127 |
|
evaluate #
evaluate(query: Optional[str] = None, response: Optional[str] = None, contexts: Optional[Sequence[str]] = None, **kwargs: Any) -> EvaluationResult
Run evaluation with query string, retrieved contexts, and generated response string.
Subclasses can override this method to provide custom evaluation logic and take in additional arguments.
Source code in llama-index-core/llama_index/core/evaluation/base.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
|
aevaluate
abstractmethod
async
#
aevaluate(query: Optional[str] = None, response: Optional[str] = None, contexts: Optional[Sequence[str]] = None, **kwargs: Any) -> EvaluationResult
Run evaluation with query string, retrieved contexts, and generated response string.
Subclasses can override this method to provide custom evaluation logic and take in additional arguments.
Source code in llama-index-core/llama_index/core/evaluation/base.py
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
|
evaluate_response #
evaluate_response(query: Optional[str] = None, response: Optional[Response] = None, **kwargs: Any) -> EvaluationResult
Run evaluation with query string and generated Response object.
Subclasses can override this method to provide custom evaluation logic and take in additional arguments.
Source code in llama-index-core/llama_index/core/evaluation/base.py
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
|
aevaluate_response
async
#
aevaluate_response(query: Optional[str] = None, response: Optional[Response] = None, **kwargs: Any) -> EvaluationResult
Run evaluation with query string and generated Response object.
Subclasses can override this method to provide custom evaluation logic and take in additional arguments.
Source code in llama-index-core/llama_index/core/evaluation/base.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
|
EvaluationResult #
Bases: BaseModel
Evaluation result.
Output of an BaseEvaluator.
Source code in llama-index-core/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 39 |
|
BatchEvalRunner #
Batch evaluation runner.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
evaluators |
Dict[str, BaseEvaluator]
|
Dictionary of evaluators. |
required |
workers |
int
|
Number of workers to use for parallelization. Defaults to 2. |
2
|
show_progress |
bool
|
Whether to show progress bars. Defaults to False. |
False
|
Source code in llama-index-core/llama_index/core/evaluation/batch_runner.py
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 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 |
|
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]]
Evaluate query, response pairs.
This evaluates queries, responses, contexts as string inputs. Can supply additional kwargs to the evaluator in eval_kwargs_lists.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
queries |
Optional[List[str]]
|
List of query strings. Defaults to None. |
None
|
response_strs |
Optional[List[str]]
|
List of response strings. Defaults to None. |
None
|
contexts_list |
Optional[List[List[str]]]
|
List of context lists. Defaults to None. |
None
|
**eval_kwargs_lists |
Dict[str, Any]
|
Dict of either dicts or lists of kwargs to pass to evaluator. Defaults to None. multiple evaluators: {evaluator: {kwarg: [list of values]},...} single evaluator: {kwarg: [list of values]} |
{}
|
Source code in llama-index-core/llama_index/core/evaluation/batch_runner.py
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 |
|
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]]
Evaluate query, response pairs.
This evaluates queries and response objects.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
queries |
Optional[List[str]]
|
List of query strings. Defaults to None. |
None
|
responses |
Optional[List[Response]]
|
List of response objects. Defaults to None. |
None
|
**eval_kwargs_lists |
Dict[str, Any]
|
Dict of either dicts or lists of kwargs to pass to evaluator. Defaults to None. multiple evaluators: {evaluator: {kwarg: [list of values]},...} single evaluator: {kwarg: [list of values]} |
{}
|
Source code in llama-index-core/llama_index/core/evaluation/batch_runner.py
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 |
|
aevaluate_queries
async
#
aevaluate_queries(query_engine: BaseQueryEngine, queries: Optional[List[str]] = None, **eval_kwargs_lists: Dict[str, Any]) -> Dict[str, List[EvaluationResult]]
Evaluate queries.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
query_engine |
BaseQueryEngine
|
Query engine. |
required |
queries |
Optional[List[str]]
|
List of query strings. Defaults to None. |
None
|
**eval_kwargs_lists |
Dict[str, Any]
|
Dict of lists of kwargs to pass to evaluator. Defaults to None. |
{}
|
Source code in llama-index-core/llama_index/core/evaluation/batch_runner.py
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 |
|
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]]
Evaluate query, response pairs.
Sync version of aevaluate_response_strs.
Source code in llama-index-core/llama_index/core/evaluation/batch_runner.py
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
|
evaluate_responses #
evaluate_responses(queries: Optional[List[str]] = None, responses: Optional[List[Response]] = None, **eval_kwargs_lists: Dict[str, Any]) -> Dict[str, List[EvaluationResult]]
Evaluate query, response objs.
Sync version of aevaluate_responses.
Source code in llama-index-core/llama_index/core/evaluation/batch_runner.py
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 |
|
evaluate_queries #
evaluate_queries(query_engine: BaseQueryEngine, queries: Optional[List[str]] = None, **eval_kwargs_lists: Dict[str, Any]) -> Dict[str, List[EvaluationResult]]
Evaluate queries.
Sync version of aevaluate_queries.
Source code in llama-index-core/llama_index/core/evaluation/batch_runner.py
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
|