docs(core): correct project-type marker and I/O typing for functions/…#1706
Open
AlexBizon wants to merge 3 commits into
Open
docs(core): correct project-type marker and I/O typing for functions/…#1706AlexBizon wants to merge 3 commits into
AlexBizon wants to merge 3 commits into
Conversation
…agents The functions/agents guides (added in #1675) claim a `[tool.uipath] type = "function"|"agent"` marker in pyproject.toml is required to identify the project type. It isn't — `uipath new` scaffolds pyproject without it and no sample carries it. The project type is determined by the `functions` / `agents` map in `uipath.json`. Remove the marker from the examples and the "is required" claims. Also broaden the I/O guidance: Input/Output can be a stdlib @DataClass, a pydantic BaseModel, or pydantic.dataclasses.dataclass (the samples use pydantic), and the entry point may be sync `def` or `async def`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the core documentation for coded functions and coded agents to reflect the actual project-type detection mechanism (via uipath.json entrypoints) and to broaden the documented options for defining typed input/output models.
Changes:
- Removes the (incorrect) requirement for a
[tool.uipath] type = "function"|"agent"marker inpyproject.tomlexamples. - Updates generated-file and I/O guidance to refer to
Input/Output“models” (not only stdlib dataclasses) and notes broader supported modeling styles / entrypoint forms.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/uipath/docs/core/functions.md | Removes pyproject.toml project-type marker guidance; broadens and rephrases I/O modeling guidance and generated schema wording. |
| packages/uipath/docs/core/agents.md | Removes pyproject.toml project-type marker guidance; aligns agent I/O modeling guidance with functions docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
A coded agent is identified by its framework graph file (langgraph.json for LangChain/LangGraph, llamaindex.json for LlamaIndex, etc.) plus the framework dependency — not by an `agents` map in uipath.json. uipath.json is empty/absent for agents (confirmed against uipath-langchain samples and the `uipath new` templates, which scaffold langgraph.json + main.py and no uipath.json). Replace the bogus uipath.json `agents` example with langgraph.json, update the project structure, and drop the marker claim. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Squash of two Copilot Autofix suggestions on functions.md into a conventional-commit message so commit-lint passes: - `uipath init` executes the entrypoint file(s) declared in uipath.json (e.g. main.py), not literally always main.py. - the runtime uses the Input/Output type hints to parse the invocation payload (rather than "validates against these"). Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
AlexBizon
force-pushed
the
fix/coded-function-docs-detection-typing
branch
from
20fa47e to
fe943a1
Compare
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…agents
The functions/agents guides (added in #1675) claim a
[tool.uipath] type = "function"|"agent"marker in pyproject.toml is required to identify the project type. It isn't —uipath newscaffolds pyproject without it and no sample carries it. The project type is determined by thefunctions/agentsmap inuipath.json. Remove the marker from the examples and the "is required" claims.Also broaden the I/O guidance: Input/Output can be a stdlib @DataClass, a pydantic BaseModel, or pydantic.dataclasses.dataclass (the samples use pydantic), and the entry point may be sync
deforasync def.