Skip to content

Commit 8e2d1d0

Browse files
nagkumar91Copilot
andcommitted
feat(gen-ai): add memory operation semantic conventions
New attributes: - gen_ai.memory.store.id - gen_ai.memory.record.id - gen_ai.memory.record.content - gen_ai.memory.query.text - gen_ai.memory.records (type: any, list of record objects) New operation names: - create_memory_store, delete_memory_store - search_memory, update_memory, delete_memory Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 26a47b8 commit 8e2d1d0

13 files changed

Lines changed: 1111 additions & 72 deletions

File tree

.chloggen/gen-ai-memory-ops.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: enhancement
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: gen-ai
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Add semantic conventions for GenAI memory operations.
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: [3250]
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext: |
23+
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.

docs/gen-ai/anthropic.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,13 +213,17 @@ populating this attribute.
213213
| --- | --- | --- |
214214
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
215215
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
216+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
217+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
218+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
216219
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
217220
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
218221
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
219222
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
220-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
221223
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
224+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
222225
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
226+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
223227

224228
---
225229

docs/gen-ai/aws-bedrock.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,13 +237,17 @@ and SHOULD be provided **at span creation time** (if provided at all):
237237
| --- | --- | --- |
238238
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
239239
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
240+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
241+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
242+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
240243
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
241244
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
242245
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
243246
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
244-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
245247
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
248+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
246249
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
250+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
247251

248252
---
249253

docs/gen-ai/azure-ai-inference.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,13 +238,17 @@ and SHOULD be provided **at span creation time** (if provided at all):
238238
| --- | --- | --- |
239239
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
240240
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
241+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
242+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
243+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
241244
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
242245
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
243246
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
244247
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
245-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
246248
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
249+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
247250
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
251+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
248252

249253
---
250254

docs/gen-ai/gen-ai-agent-spans.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,13 +140,17 @@ and SHOULD be provided **at span creation time** (if provided at all):
140140
| --- | --- | --- |
141141
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
142142
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
143+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
144+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
145+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
143146
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
144147
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
145148
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
146149
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
147-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
148150
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
151+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
149152
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
153+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
150154

151155
---
152156

@@ -390,13 +394,17 @@ and SHOULD be provided **at span creation time** (if provided at all):
390394
| --- | --- | --- |
391395
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
392396
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
397+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
398+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
399+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
393400
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
394401
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
395402
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
396403
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
397-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
398404
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
405+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
399406
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
407+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
400408

401409
---
402410

@@ -643,13 +651,17 @@ and SHOULD be provided **at span creation time** (if provided at all):
643651
| --- | --- | --- |
644652
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
645653
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
654+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
655+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
656+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
646657
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
647658
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
648659
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
649660
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
650-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
651661
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
662+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
652663
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
664+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
653665

654666
---
655667

@@ -795,13 +807,17 @@ and SHOULD be provided **at span creation time** (if provided at all):
795807
| --- | --- | --- |
796808
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
797809
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
810+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
811+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
812+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
798813
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
799814
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
800815
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
801816
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
802-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
803817
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
818+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
804819
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
820+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
805821

806822
<!-- prettier-ignore-end -->
807823
<!-- END AUTOGENERATED TEXT -->

docs/gen-ai/gen-ai-events.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,13 +209,17 @@ populating this attribute.
209209
| --- | --- | --- |
210210
| `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Development](https://img.shields.io/badge/-development-blue) |
211211
| `create_agent` | Create GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
212+
| `create_memory_store` | Create/initialize a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
213+
| `delete_memory` | Delete memory records | ![Development](https://img.shields.io/badge/-development-blue) |
214+
| `delete_memory_store` | Delete/deprovision a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
212215
| `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) | ![Development](https://img.shields.io/badge/-development-blue) |
213216
| `execute_tool` | Execute a tool | ![Development](https://img.shields.io/badge/-development-blue) |
214217
| `generate_content` | Multimodal content generation operation such as [Gemini Generate Content](https://ai.google.dev/api/generate-content) | ![Development](https://img.shields.io/badge/-development-blue) |
215218
| `invoke_agent` | Invoke GenAI agent | ![Development](https://img.shields.io/badge/-development-blue) |
216-
| `invoke_workflow` | Invoke GenAI workflow | ![Development](https://img.shields.io/badge/-development-blue) |
217219
| `retrieval` | Retrieval operation such as [OpenAI Search Vector Store API](https://platform.openai.com/docs/api-reference/vector-stores/search) | ![Development](https://img.shields.io/badge/-development-blue) |
220+
| `search_memory` | Search/query memories from a memory store | ![Development](https://img.shields.io/badge/-development-blue) |
218221
| `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Development](https://img.shields.io/badge/-development-blue) |
222+
| `update_memory` | Create or update (upsert) memory records | ![Development](https://img.shields.io/badge/-development-blue) |
219223

220224
---
221225

0 commit comments

Comments
 (0)