Observabilities Data plane API Specs #37357

risinh · 2025-09-11T20:26:24Z

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Design Document:
Previous API Spec Doc:
Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Release planner

A release plan should have been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Getting help

First, please carefully read through this PR description, from top to bottom.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

github-actions · 2025-09-11T20:26:39Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ Your PR requires an API stewardship board review as it introduces a new API version (label: new-api-version). Schedule the review by following aka.ms/azsdk/onboarding/restapischedule.

Comment generated by summarize-checks workflow run.

github-actions · 2025-09-11T20:29:34Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
TypeSpec	Azure.AI.Projects
Java	com.azure:azure-ai-projects
JavaScript	@azure/ai-projects

* Insights API * Fix based on feedback * Remove modelParameters * Fix descriptions * Fix query parameter for GET API * fixing names * Fix model * Fix types to be more intuitive * Fix name * using property directly * Using separate model for modelconfiguration * Putting model configuration within individual request types * Examples added * Prettier fix --------- Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

* Added schedules API * Updated * updated * updated * Updated per review * updated * Updated schedules

* chore: Add an typespec for evaluator * style: Run typespec formatter * refactor: Remove evaluator subtype * refactor: Renamed "Safety" to "Risk and Safety" * refactor: Drop version and name from EvaluatorCreateResult * refactor: Add init_params * refactor: Add EvaluatorVersion.provider * refactor: Change updateVersion verb to PATCH * feat: Add routes to main.tsp * debug: Add todos * chore: Updates from typespec review * refactor: Lower case EvaluatorConfigType values * refactor: Rename CodeEvaluatorConfig -> Container and add CodeConfig * refactor: Remove container_deployment_config * refactor: type -> config_type * feat: Add RegistryScope * refactor: Add container based evaluator * refactor: InitParams -> InputParams + add OutpuParams * refactor: Remove prompty config * refactor: Remove scope * refactor: displayName to display_name * refactor: Add {in,out}put_params to container config * fix * updates * updates * updates * updates * updates * added startPendingUpload and fix * spell * created_at * created_at * created_at * adding pendingUpload Credentials * remove pendingUpload * added prompty and code * added tsv * added tsv * fix after review * fix for 10-15 * resolved conflicts again * fix after Johans comments * fix after Johans comments * fix after Johans comments * fix after Johans comments * fix after Johans comments * fix after Johans comments * updated metrics * updated metrics * Update specification/ai/Azure.AI.Projects/evaluators/models.tsp Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> * Update specification/ai/Azure.AI.Projects/evaluators/models.tsp Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> * Update specification/ai/Azure.AI.Projects/evaluators/models.tsp Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> * Update specification/ai/Azure.AI.Projects/evaluators/models.tsp Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> * Update specification/ai/Azure.AI.Projects/evaluators/models.tsp Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> * Update specification/ai/Azure.AI.Projects/evaluators/models.tsp Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com> * fix paging * remove sorting * remove sorting --------- Co-authored-by: kdestin <101366538+kdestin@users.noreply.github.com> Co-authored-by: aprilk-ms <55356546+aprilk-ms@users.noreply.github.com>

* Compare insights models * Update

Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

@doc

* sync API definition * add testing criteria * add Azure AI evaluator type * add property bag * commit to @docs since its pre-existing convention * update based on comments * clean-up versioning * switch @doc to comments * spelling fix * expected input/output schema * add type for input data * tools to generic object * response optional * latest changes

* Added examples * Updated examples * updated * Updated * Updated per API design change * updated prettier checks * updated to use right routes and methods * Updated npx prettier checks * updated new prettiers * updated * updated taxonomy api * updated * prettified * updated

…37908) * Add new field * Move evaluators back to Azure style * Update description * Update operationId * Updated azure-ai-projects.json * update cspell * Add examples * fixed spec * prettier * fixes * fix * fix * Fix create parameters

specification/ai/Azure.AI.Projects/main.tsp

* WIP * update * Update to 1 event type * Updated typespec * minor * Added examples * prettier * Update * update operation Id and examples * revert unwanted update * minor fixes

* Update examples * Fixed model * Another fix

* Preview version update 10-15 -> 11-15 * Update remaining places * Fix prettier * Fix prettier across all examples --------- Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

* updated examples for taxonomies and schedules * updated * updated * updated

* Fixing Lint diff failures * prettier fix --------- Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

Common changes

bb57994

github-actions bot added data-plane TypeSpec Authored with TypeSpec labels Sep 11, 2025

github-actions bot added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Sep 18, 2025

posaninagendra and others added 6 commits September 25, 2025 20:32

Added Foundry Schedules API (#37470)

73df72a

* Added schedules API * Updated * updated * updated * Updated per review * updated * Updated schedules

Add compare insight type (#37875)

16ad0f5

* Compare insights models * Update

Adding missing properties : Label, suggestion, Usage (#37933)

bdf259e

Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

Merge branch 'main' into observability/features-2025-10-15-preview

9ae69ec

github-actions bot removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 8, 2025

posaninagendra and others added 2 commits October 9, 2025 12:03

dargilco approved these changes Oct 10, 2025

View reviewed changes

specification/ai/Azure.AI.Projects/main.tsp Outdated Show resolved Hide resolved

aprilk-ms and others added 4 commits October 10, 2025 19:03

Add evaluation rules CRUD (#37839)

f9c7a36

* WIP * update * Update to 1 event type * Updated typespec * minor * Added examples * prettier * Update * update operation Id and examples * revert unwanted update * minor fixes

Fix evaluation rule action type and update examples (#38123)

2754ecd

* Update examples * Fixed model * Another fix

Preview version update 10-15 -> 11-15 (#38065)

e517636

* Preview version update 10-15 -> 11-15 * Update remaining places * Fix prettier * Fix prettier across all examples --------- Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

remove sync API PrP (#38144)

1a66ecd

risinh marked this pull request as ready for review October 15, 2025 17:49

github-actions bot added the new-api-version label Oct 15, 2025

risinh and others added 3 commits October 15, 2025 15:17

Not carry Evaluation API to Nov 2025 version (#38214)

0b12e95

Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

Updated examples for taxonomies and schedules (#38211)

7169ea7

* updated examples for taxonomies and schedules * updated * updated * updated

Fixing Lint diff failures (#38216)

b8bbb19

* Fixing Lint diff failures * prettier fix --------- Co-authored-by: Ritesh Kumar Sinha <risinh@microsoft.com>

risinh added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Observabilities Data plane API Specs #37357

Observabilities Data plane API Specs #37357

Uh oh!

risinh commented Sep 11, 2025

Uh oh!

github-actions bot commented Sep 11, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Observabilities Data plane API Specs #37357

Are you sure you want to change the base?

Observabilities Data plane API Specs #37357

Uh oh!

Conversation

risinh commented Sep 11, 2025

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

Release planner

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Getting help

Uh oh!

github-actions bot commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

github-actions bot commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

github-actions bot commented Sep 11, 2025 •

edited

Loading

github-actions bot commented Sep 11, 2025 •

edited

Loading