gen-ai: semantic conventions for memory operations #3250
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: gen-ai | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Add semantic conventions for GenAI memory operations. | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [3250] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | | ||
| Adds `gen_ai.operation.name` values for memory operations and introduces `gen_ai.memory.*` attributes and spans for memory store lifecycle, search, upsert, and delete. |
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| { | ||
| "$defs": { | ||
|
Member
There was a problem hiding this comment. i don't think we have to act on it yet, but it's interesting that Could you please create an issue for it so we come back to it during stabilization process? |
||
| "MemoryRecord": { | ||
| "additionalProperties": true, | ||
| "description": "Represents a single memory record stored in or retrieved from a memory store.", | ||
| "properties": { | ||
| "content": { | ||
| "description": "The content of the memory record.", | ||
| "title": "Content", | ||
| "type": "string" | ||
| }, | ||
| "id": { | ||
| "description": "A unique identifier for the memory record.", | ||
| "title": "Id", | ||
| "type": "string" | ||
| }, | ||
| "score": { | ||
| "description": "The relevance score of the memory record (populated on search results).", | ||
| "title": "Score", | ||
| "type": "number" | ||
| }, | ||
| "metadata": { | ||
| "additionalProperties": true, | ||
| "description": "Provider-specific metadata associated with the memory record.", | ||
| "title": "Metadata", | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "title": "MemoryRecord", | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "description": "Represents the list of memory records stored in or retrieved from a memory store.", | ||
| "items": { | ||
| "$ref": "#/$defs/MemoryRecord" | ||
| }, | ||
| "title": "MemoryRecords", | ||
| "type": "array" | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we define code representation of json model for each of the existing ones in the https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/non-normative/models.ipynb (so it's easier to review and, for users who are not familiar with json schema, to read and interpret conventions. could you please add one there? thanks!