docs: add dapr-agents operations page with docs on Agent Metadata Schema #5006
Conversation
Signed-off-by: Casper Nielsen <casper@diagrid.io>
daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-operations.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Casper Nielsen <casper@diagrid.io>
msfussell
left a comment
msfussell
left a comment
There was a problem hiding this comment.
Leave comments. This needs more explanation.
daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-operations.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-operations.md
Outdated
Show resolved
Hide resolved
|
|
||
| In order to facilitate easier handling of version changes to the agent metadata, Dapr Agents supplies versioned JSON schemas. Within the [dapr agents repository] you'll find 3 types of JSON schema files: | ||
|
|
||
| - [index.json](https://raw.githubusercontent.com/dapr/dapr-agents/main/schemas/agent-metadata/index.json) |
There was a problem hiding this comment.
These URLS do not resolve. What are they intending to show?
There was a problem hiding this comment.
This Agents PR needs to be merged first: dapr/dapr-agents#373
Added the waiting-on-code-pr label.
There was a problem hiding this comment.
Yes. Once 373 is in main the links will resolve properly
daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-operations.md
Outdated
Show resolved
Hide resolved
|
|
||
| Dapr Agents utilizes an Agent Registry (often referenced as `agent-registry` statestore) to communicate Agent capabilities. The Agent Registry contains Agent metadata, including the agent's name, description, version and much more. | ||
|
|
||
| In order to facilitate easier handling of version changes to the agent metadata, Dapr Agents supplies versioned JSON schemas. Within the [dapr agents repository] you'll find 3 types of JSON schema files: |
There was a problem hiding this comment.
I really do not understand why and what this metadata is used for? What are the scenarios for when I would use this and when does this get updated? What I do not get from this article is how to use this metadate store. I suggest that we provide at least 5 concrete examples of its usefulness.
There was a problem hiding this comment.
@msfussell we're now versioning the metadata that Dapr Agents sends to the registry. This is done to ensure a consumer of the metadata can find the schema for the specific version. In the future (and previously) the structure of the metadata might change and if consumers of the metadata are doing lookups for data, let's imagine in a UI, what happens when an agent registers on an older version without that schema field that the IU expects?
Adding the versioned metadata schema allows the consumer to take actions based of the metadata version by fetching the schema.
marcduiker
added
the
waiting-on-code-pr
…ations.md Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Casper Nielsen <whopsec@protonmail.com>
…ations.md Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Casper Nielsen <whopsec@protonmail.com>
…ations.md Co-authored-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Casper Nielsen <whopsec@protonmail.com>
4 participants
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Going out of dapr/dapr-agents#373 Dapr Agents now supplies its Metadata schema in the repo. This PR extends the docs with references to this so Operators can find and handle the differences in the versioned schemas when presenting agents etc.
Issue reference