Initial draft of guidance for teams implementing a language port #3181
+189
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
markwallace-microsoft
added
the
documentation
| - Implement error handling in a way that is considered standard for the target language. | ||
| 3. Testing | ||
| - Implement a comprehensive suite of unit tests for all functionalities, the target for GA is to have 80% unit test coverage. | ||
| - Provide integration tests ensure the SDK works correctly with external dependencies or services. |
There was a problem hiding this comment.
Grammatical error: Missing "to" before "ensure". Should be "to ensure".
Suggested change
| - Provide integration tests ensure the SDK works correctly with external dependencies or services. | |
| - Provide integration tests to ensure the SDK works correctly with external dependencies or services. |
| 3. Testing | ||
| - Implement a comprehensive suite of unit tests for all functionalities, the target for GA is to have 80% unit test coverage. | ||
| - Provide integration tests ensure the SDK works correctly with external dependencies or services. | ||
| - Unit tests **must** run on all PR's when they are created our updated. |
There was a problem hiding this comment.
Spelling error: "our" should be "or".
Suggested change
| - Unit tests **must** run on all PR's when they are created our updated. | |
| - Unit tests **must** run on all PR's when they are created or updated. |
|
|
||
| #### Declarative Workflows | ||
|
|
||
| Microsoft Agent Framework supports a delcartive format for workflows which is shared with other teams within Microsoft e.g. Foundry Workflows. The declarative format uses YAML as the file format and the schema is implemented by the Agent Object Model. |
There was a problem hiding this comment.
Spelling error: "delcartive" should be "declarative".
Comment on lines
+83
to
+89
| Microsoft Agent Framework supports a delcartive format for workflows which is shared with other teams within Microsoft e.g. Foundry Workflows. The declarative format uses YAML as the file format and the schema is implemented by the Agent Object Model. | ||
|
|
||
| For examples of declarative workflows go [here](https://github.com/microsoft/agent-framework/tree/main/workflow-samples) | ||
|
|
||
| #### Declarative Agents | ||
|
|
||
| Microsoft Agent Framework supports a delcartive format for agents which is shared with other teams within Microsoft e.g. Copilot Studio agents. The declarative format uses YAML as the file format and the schema is implemented by the Agent Object Model. |
There was a problem hiding this comment.
Spelling error: "delcartive" should be "declarative".
Suggested change
| Microsoft Agent Framework supports a delcartive format for workflows which is shared with other teams within Microsoft e.g. Foundry Workflows. The declarative format uses YAML as the file format and the schema is implemented by the Agent Object Model. | |
| For examples of declarative workflows go [here](https://github.com/microsoft/agent-framework/tree/main/workflow-samples) | |
| #### Declarative Agents | |
| Microsoft Agent Framework supports a delcartive format for agents which is shared with other teams within Microsoft e.g. Copilot Studio agents. The declarative format uses YAML as the file format and the schema is implemented by the Agent Object Model. | |
| Microsoft Agent Framework supports a declarative format for workflows which is shared with other teams within Microsoft e.g. Foundry Workflows. The declarative format uses YAML as the file format and the schema is implemented by the Agent Object Model. | |
| For examples of declarative workflows go [here](https://github.com/microsoft/agent-framework/tree/main/workflow-samples) | |
| #### Declarative Agents | |
| Microsoft Agent Framework supports a declarative format for agents which is shared with other teams within Microsoft e.g. Copilot Studio agents. The declarative format uses YAML as the file format and the schema is implemented by the Agent Object Model. |
| - API Documentation: | ||
| - Create detailed API documentation as components are developed, using tools that support the target language. | ||
| - User Guides: | ||
| - Extend existing docuiemntation to cover the new language by adding a language pivot. |
There was a problem hiding this comment.
Spelling error: "docuiemntation" should be "documentation".
Suggested change
| - Extend existing docuiemntation to cover the new language by adding a language pivot. | |
| - Extend existing documentation to cover the new language by adding a language pivot. |
|
|
||
| - Provide an idiomatic API i.e., they should avoid being just a port from .NET or Python. | ||
| - Keep in sync with the main implementations, in particular a developer should be able to run a declarative agent or workflow in any language version and have cosnsistent behavior. | ||
| - Provide all of the production read features e.g. observability using the OTel semantic AI conventions. |
There was a problem hiding this comment.
Spelling error: "read" should be "ready".
Suggested change
| - Provide all of the production read features e.g. observability using the OTel semantic AI conventions. | |
| - Provide all of the production ready features e.g. observability using the OTel semantic AI conventions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Description
Contribution Checklist