Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This extension publishes a `PublishAIEvaluationReport` task that will publish th
- task: PublishAIEvaluationReport@0
displayName: 'Publish AI Evaluation Data'
inputs:
reportFile: '$(build-artifacts)\report.json'
reportFile: '$(build-artifacts)\report.json'
```

If your pipeline restricts uploading attachments from a task, you can disable the attachment upload feature and use a different method to upload the report data. You should still include `PublishAIEvaluationReport` task as it will trigger the display of the reporting tab. When using this method, the attachment must be uploaded to the pipeline with `type=ai-eval-report-json` and `name=ai-eval-report`.
Expand Down Expand Up @@ -68,10 +68,13 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,13 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing

Expand Down
9 changes: 6 additions & 3 deletions src/Libraries/Microsoft.Extensions.AI.Evaluation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,14 @@ You can optionally add the `Microsoft.Extensions.AI.Evaluation.Reporting.Azure`
dotnet tool install Microsoft.Extensions.AI.Evaluation.Console --create-manifest-if-needed
```

## Usage Examples
## Usage examples

For a comprehensive tour of all the functionality, concepts and APIs available in the `Microsoft.Extensions.AI.Evaluation` libraries, check out the [API Usage Examples](https://github.com/dotnet/ai-samples/blob/main/src/microsoft-extensions-ai-evaluation/api/) available in the [dotnet/ai-samples](https://github.com/dotnet/ai-samples) repo. These examples are structured as a collection of unit tests. Each unit test showcases a specific concept or API, and builds on the concepts and APIs showcased in previous unit tests.
For `Microsoft.Extensions.AI.Evaluation` library usage examples, see the following tutorials:

* [Quickstart: Evaluate response quality](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-ai-response)
* [Tutorial: Evaluate response quality with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-with-reporting)
* [Tutorial: Evaluate response safety with caching and reporting](https://learn.microsoft.com/dotnet/ai/evaluation/evaluate-safety)

## Feedback & Contributing
## Feedback & contributing
Comment thread
gewarren marked this conversation as resolved.

We welcome feedback and contributions in [our GitHub repo](https://github.com/dotnet/extensions).
Loading