mistralai-evaluations 0.7.0__tar.gz

mistralai_evaluations-0.7.0/.gitignore

@@ -0,0 +1,2 @@
+training_capture_enriched_data.ndjson
+customer_capture_enriched_data.ndjson

mistralai_evaluations-0.7.0/AGENTS.md

@@ -0,0 +1,96 @@
+# mistralai-evaluations
+
+## Overview
+
+This package sets up the `mistralai.evaluations` namespace, extending the Mistral AI SDK v2 (see [CLAUDE.md](../../openapi/CLAUDE.md)) to allow evaluation features to be developed and released from this repository.
+
+It is an LLM evaluation runner that creates entities and uploads results using Dora endpoints (see `offline_evaluations_router` in [public_routes.py](../dora/api/public_routes.py)). Results are displayed in AI Studio (see [Projects page](<../../ts/apps/la-console/src/app/(basic-layout)/observability/projects>)).
+
+Laperf is a POC that does the same without eval runners. It has an API (see [laperf_routes.py](../dora/api/laperf_routes.py)) and a UI (see [Initiatives page](<../../ts/apps/la-console/src/app/(basic-layout)/observability/initiatives>)).
+
+## TypeScript Mirror
+
+This Python SDK has an idiomatic TypeScript adaptation at `ts/packages/local-observability-sdk/`.
+**Any change here must be replicated in the TypeScript SDK** — adapting to TypeScript conventions rather than translating line-for-line.
+
+See `ts/packages/local-observability-sdk/AGENTS.md` for the full file mapping, adaptation philosophy, and replication workflow.
+
+### Quick checklist after making changes
+
+1. Replicate the change in the TS SDK — see `ts/packages/local-observability-sdk/AGENTS.md` for the full workflow
+
+## Project Structure
+
+This is a **namespace package** — the wheel ships `mistralai/evaluations/` to extend the `mistralai` SDK namespace:
+
+```
+mistralai/evaluations/
+  __init__.py
+  client.py        # Main client interface
+  api.py           # API communication with Dora backend
+  api_models.py    # API request/response models
+  models.py        # Core domain models (evaluations, datasets, etc.)
+  managers.py      # High-level orchestration logic
+  execution.py     # Evaluation execution engine
+  display.py       # Terminal output formatting
+  utils.py         # Shared helpers
+examples/          # Example evaluation scripts (see examples/README.md)
+```
+
+## Development
+
+```sh
+make install     # Install dependencies (uv sync)
+make test        # Run pytest
+make lint        # Format + typecheck + ruff check
+make format      # Auto-format with ruff, use it after each code change
+make typecheck   # Run mypy
+make build       # Build the wheel
+make publish     # Manual Gemfury publish (requires GEMFURY_USERNAME/GEMFURY_PASSWORD)
+```
+
+
+### Releasing
+
+The version is **not** stored in code. This package uses
+[`uv-dynamic-versioning`](https://github.com/ninoseki/uv-dynamic-versioning): the
+published version is derived from the release tag (`evaluations-sdk/vX.Y.Z`), and
+the release workflow stamps the version you pass onto the build via
+`UV_DYNAMIC_VERSIONING_BYPASS`. **There is no version-bump PR** — just run the
+workflow with the version you want. This matches the workflow evaluation plugin.
+
+To release:
+
+1. Run the "Release Evaluations SDK" GitHub workflow from `main` or the relevant
+   `mais-*` release branch.
+2. Set the `version` input (PEP 440, e.g. `0.7.0` or `0.7.0rc1`). The workflow
+   rejects a version whose tag `evaluations-sdk/vX.Y.Z` already exists.
+3. Pick the target registries via the boolean inputs (PyPI on, Gemfury on,
+   Cloudsmith off by default). To dogfood privately first, publish an `rc` to
+   Gemfury only; the rc tag won't collide with the later public release.
+4. The workflow tags `evaluations-sdk/vX.Y.Z` on the released commit as soon as
+   **any** requested registry publishes successfully.
+
+An agent can run and monitor the release with the GitHub CLI:
+
+```sh
+gh workflow run evaluations-sdk-release.yaml --ref main -f version=X.Y.Z
+gh run list --workflow evaluations-sdk-release.yaml --branch main --limit 1
+gh run watch <run-id>
+gh run rerun <run-id> --failed
+```
+
+Use the relevant `mais-*` branch instead of `main` when releasing an on-prem patch line. If one package index succeeds
+and the other fails, do not rerun the full workflow because the already-successful package index may reject the
+duplicate version; use `gh run rerun <run-id> --failed`.
+
+> **TypeScript mirror:** `ts/packages/local-observability-sdk/` still carries its own
+> `package.json` / `cli.ts` version and is not published by this workflow. Keep it in
+> sync when practical; it is not gated by the Python release.
+
+### Run Examples
+
+```sh
+uv run examples/language_detection/code.py
+uv run examples/fact_extraction/code.py
+```

mistralai_evaluations-0.7.0/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

mistralai_evaluations-0.7.0/LICENSE

@@ -0,0 +1,190 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Mistral AI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

mistralai_evaluations-0.7.0/Makefile

@@ -0,0 +1,34 @@
+.PHONY: lint format typecheck test install build clean publish
+
+# Standard targets (per CLAUDE.md convention)
+
+lint: format typecheck
+	uv run ruff check .
+
+format:
+	uv run ruff format .
+	uv run ruff check --fix .
+
+typecheck:
+	uv run mypy mistralai
+
+test:
+	uv run pytest
+
+install:
+	uv sync
+
+# Build and publish targets
+
+clean:
+	rm -rf dist/
+
+build: clean
+	uv build
+
+publish: build
+	@if [ -z "$$GEMFURY_USERNAME" ] || [ -z "$$GEMFURY_PASSWORD" ]; then \
+		echo "Error: GEMFURY_USERNAME and GEMFURY_PASSWORD must be set"; \
+		exit 1; \
+	fi
+	uv publish --publish-url https://push.fury.io/mistralai/ --username $$GEMFURY_USERNAME --password $$GEMFURY_PASSWORD

mistralai_evaluations-0.7.0/PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.5
+Name: mistralai-evaluations
+Version: 0.7.0
+Summary: Mistral AI Studio evaluation tools
+Project-URL: Homepage, https://mistral.ai
+Author-email: Mistral AI <support@mistral.ai>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ai,evaluation,llm,mistral,observability
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: colorama>=0.4.0
+Requires-Dist: mistralai<3.0.0,>=2.4.7
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: structlog>=24.0.0
+Description-Content-Type: text/markdown
+
+# Mistral Evaluations
+
+Namespace package for Mistral AI evaluation (Dora) utilities.
+
+## Overview
+
+This package sets up the `mistralai.evaluations` namespace for Dora-specific utilities. It extends the Mistral AI SDK
+v2 namespace structure to allow evaluation features to be developed and released from this repository.
+
+## SDK v2 Namespace Package
+
+This package follows [PEP 420](https://peps.python.org/pep-0420/) implicit namespace packaging to integrate with the
+Mistral AI SDK v2 structure. The code lives in this repository (Dora) but will be importable from
+`mistralai.evaluations` once SDK v2 is released.
+
+### Package Structure
+
+```
+mistralai/                  # Shared namespace (no __init__.py)
+├── client/                 # Core SDK (mistralai package on PyPI)
+├── workflows/              # Workflows SDK
+├── evaluations/            # This package (Dora utilities)
+└── extra/                  # Extra utilities
+```
+
+The `mistralai/` directory has no `__init__.py`, allowing multiple packages to coexist under the shared `mistralai`
+namespace.
+
+## Installation
+
+This package is currently under development. Once SDK v2 is released, it will be available as part of the `mistralai`
+namespace.
+
+For local development:
+
+```bash
+uv sync
+```
+
+## Usage
+
+### Basic evaluation
+
+```python
+from mistralai.evaluations import Evaluation, Evaluator, Project
+
+run = await client.evaluation.run(
+    project=Project(name="My Project"),
+    evaluation=Evaluation(name="My Evaluation"),
+    dataset=[{"input": "hello", "expected": "greeting"}],
+    task=lambda input_record: classify(input_record["input"]),
+    evaluators=[
+        Evaluator(name="accuracy", scorer=lambda input_record, output: 1 if output == input_record["expected"] else 0),
+    ],
+)
+run.show(level="scores")
+```
+
+### Run-level evaluators
+
+Run evaluators execute after all records are processed and receive the full run context (records, statistics, metrics, metadata). Use them for global assertions or aggregate metrics.
+
+```python
+from mistralai.evaluations import RunEvaluator
+
+run = await client.evaluation.run(
+    ...,
+    evaluators=[
+        Evaluator(name="accuracy", scorer=lambda input_record, output: 1 if output == input_record["expected"] else 0),
+    ],
+    run_evaluators=[
+        RunEvaluator(
+            name="accuracy_above_50pct",
+            scorer=lambda ctx: ctx.statistics["accuracy"].avg > 0.5,
+        ),
+        RunEvaluator(
+            name="all_records_scored",
+            scorer=lambda ctx: all(
+                len(r.output.generations) > 0 for r in ctx.records
+            ),
+        ),
+    ],
+)
+# Results are in run.run_scores
+print(run.run_scores)  # {"accuracy_above_50pct": True, "all_records_scored": True}
+```
+
+The `RunEvaluatorContext` provides:
+
+| Field        | Type                             | Description                                   |
+| ------------ | -------------------------------- | --------------------------------------------- |
+| `records`    | `list[RunEvaluatorRecord]`       | Each record's input and output (with scores). |
+| `statistics` | `dict[str, EvaluatorStatistics]` | Run-level statistics from regular evaluators. |
+| `metrics`    | `dict[str, JsonValue]`           | Run-level `run_aggregator` results.           |
+| `metadata`   | `dict[str, JsonValue]`           | Metadata attached to the run.                 |
+
+### Retrying failed records
+
+If an evaluation only partially fails, use `retry_failed_records` instead of re-running the entire evaluation from
+scratch. It re-runs only the failed records and patches the original run in place, avoiding work on successful records
+when failures came from transient API errors, rate limits, or a bug in the task or scorer.
+
+```python
+from mistralai.evaluations import Evaluation, Evaluator
+
+run = await client.evaluation.run(
+    evaluation=Evaluation(name="My Evaluation"),
+    dataset=dataset,
+    task=flaky_task,
+    evaluators=[Evaluator(name="accuracy", scorer=scorer)],
+)
+
+# Fix the task or scorer if needed, then retry only the failed records.
+result = await client.evaluation.retry_failed_records(
+    run_id=run.run_id,
+    dataset=dataset,
+    task=fixed_task,
+    evaluators=[Evaluator(name="accuracy", scorer=scorer)],
+)
+
+print(f"Retried: {result.retried_count}, Patched: {result.patched_count}")
+```
+
+Pass the same `dataset` used in the original run so the SDK can map failed records back to their inputs. You can pass a
+fixed `task` or updated evaluators before retrying. When run-level evaluators are provided, their scores are recomputed
+after patching.
+
+### `get_score` helper
+
+When writing run evaluators, accessing individual scores requires navigating through generations and score lists. The `get_score` helper simplifies this:
+
+```python
+from mistralai.evaluations import RunEvaluatorContext, Score, get_score
+
+def f1_scorer(ctx: RunEvaluatorContext) -> Score:
+    tp = fp = fn = 0
+    for record in ctx.records:
+        expected = str(record.input["expected"]).lower()
+        # Instead of: record.output.generations[0].scores["accuracy"][0].value
+        is_correct = get_score(record, "accuracy").value == 1
+        ...
+```
+
+Returns a `Score` object (with `value`, `rationale`, `metadata`).
+
+| Parameter        | Type                             | Default | Description                                                 |
+| ---------------- | -------------------------------- | ------- | ----------------------------------------------------------- |
+| `record`         | `RunEvaluatorRecord`             | —       | The record to extract scores from.                          |
+| `evaluator_name` | `str`                            | —       | Name of the evaluator whose scores to retrieve.             |
+| `aggregate`      | `Callable[[list[Score]], Score]` | `None`  | Required when multiple scores exist (multiple generations). |
+
+Raises if no scores are found. When `num_generations > 1`, raises with a helpful message unless an `aggregate` function is provided. For pre-computed aggregations, use `record.output.statistics[evaluator_name]` instead.
+
+## Development
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+uv run pytest
+
+# Lint and format
+uv run ruff check --fix .
+uv run ruff format .
+
+# Type check
+uv run mypy mistralai
+```
+
+## Publishing
+
+### Release from GitHub
+
+The version is **not** stored in code. This package uses
+[`uv-dynamic-versioning`](https://github.com/ninoseki/uv-dynamic-versioning): the published version comes from the
+release tag (`evaluations-sdk/vX.Y.Z`), and the workflow stamps the version you pass onto the build via
+`UV_DYNAMIC_VERSIONING_BYPASS`. **There is no version-bump PR** — just run the workflow with the version you want.
+
+Run the "Release Evaluations SDK" GitHub workflow manually. Choose which registries to publish to via the boolean
+inputs — they're independent, so you can dogfood internally without shipping to clients:
+
+1. **PyPI** (public), via a trusted publisher (OIDC) — the primary channel. Default on.
+2. **Gemfury**, for internal distribution. Default on.
+3. **Cloudsmith** (`mistral-ai/sdk-distribution`), for private-preview client distribution. Default off — opt in when previewing to specific clients.
+
+Run the workflow from `main` for normal SDK releases, or from the relevant `mais-*` release branch for on-prem patch
+lines. Enter the version as the workflow `version` input (PEP 440, e.g. `0.7.0` or `0.7.0rc1`); the workflow fails if
+the tag `evaluations-sdk/vX.Y.Z` already exists.
+
+The git tag `evaluations-sdk/vX.Y.Z` records the released commit for that version, so it is created as soon as **any**
+selected registry publishes successfully (and none of the selected ones failed). To dogfood privately, publish an `rc`
+to Gemfury only; the rc tag won't collide with the later public release.
+
+If one registry succeeds and another fails, rerun the failed GitHub Actions jobs only. Do not rerun the full workflow,
+because the already-successful registry may reject the duplicate version.
+
+The TypeScript mirror (`ts/packages/local-observability-sdk/`) still carries its own `package.json` / `cli.ts` version
+and is not published by this workflow; keep it in sync when practical.
+
+### Manual Gemfury publish
+
+Retrieve the "Gemfury Upload Token - Mistral" credentials from Bitwarden. The `make publish` command expects `GEMFURY_USERNAME` and `GEMFURY_PASSWORD` environment variables.
+
+```bash
+# Publish to Gemfury
+# this will clean up the dist/ directory then build and publish
+make publish
+```
+
+### Installing from PyPI (public)
+
+```bash
+pip install mistralai-evaluations
+```
+
+### Installing from Gemfury (internal)
+
+```bash
+pip install --index-url https://pypi.fury.io/mistralai/ mistralai-evaluations --extra-index-url https://pypi.org/simple/
+```