Skip to content

Commit ad2b6d0

Browse files
nagkumar91Copilot
andcommitted
Rename gen_ai.memory.returned_records to gen_ai.memory.records
Aligns with existing naming patterns: - gen_ai.retrieval.documents - gen_ai.input.messages - gen_ai.output.messages - gen_ai.tool.definitions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 2019f4a commit ad2b6d0

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -853,7 +853,7 @@ or `search_memory` if store id is not available.
853853
| [`server.port`](/docs/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If `server.address` is set. | int | GenAI server port. [5] | `80`; `8080`; `443` |
854854
| [`server.address`](/docs/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | GenAI server address. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` |
855855
| [`gen_ai.memory.query.text`](/docs/registry/attributes/gen-ai.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | string | The search query used to retrieve memories. [7] | `user dietary preferences`; `past flight bookings` |
856-
| [`gen_ai.memory.returned_records`](/docs/registry/attributes/gen-ai.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | any | The memory records returned from a search operation. [8] | [<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User prefers dark mode",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_123",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.95<br>&nbsp;&nbsp;},<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User is based in Seattle",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_456",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.82<br>&nbsp;&nbsp;}<br>] |
856+
| [`gen_ai.memory.records`](/docs/registry/attributes/gen-ai.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | any | The memory records returned from a search operation. [8] | [<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User prefers dark mode",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_123",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.95<br>&nbsp;&nbsp;},<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User is based in Seattle",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_456",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.82<br>&nbsp;&nbsp;}<br>] |
857857

858858
**[1] `gen_ai.operation.name`:** If one of the predefined values applies, but specific system uses a different name it's RECOMMENDED to document it in the semantic conventions for specific GenAI system and use system-specific name in the instrumentation. If a different name is not documented, instrumentation libraries SHOULD use applicable predefined value.
859859

@@ -891,7 +891,7 @@ Instrumentations SHOULD document the list of errors they report.
891891
> [!WARNING]
892892
> This attribute may contain sensitive information.
893893
894-
**[8] `gen_ai.memory.returned_records`:** This attribute follows the same pattern as `gen_ai.retrieval.documents`.
894+
**[8] `gen_ai.memory.records`:** This attribute follows the same pattern as `gen_ai.retrieval.documents`.
895895

896896
Each record object SHOULD contain at least the following properties:
897897
`content` (any): The content of the memory record.

docs/registry/attributes/gen-ai.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This document defines the attributes used to describe telemetry in the context o
3030
| <a id="gen-ai-memory-query-text" href="#gen-ai-memory-query-text">`gen_ai.memory.query.text`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The search query used to retrieve memories. [4] | `user dietary preferences`; `past flight bookings` |
3131
| <a id="gen-ai-memory-record-content" href="#gen-ai-memory-record-content">`gen_ai.memory.record.content`</a> | ![Development](https://img.shields.io/badge/-development-blue) | any | The content/value of the memory record. [5] | `{"preference": "dark_mode", "value": true}` |
3232
| <a id="gen-ai-memory-record-id" href="#gen-ai-memory-record-id">`gen_ai.memory.record.id`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the memory record. | `mem_5j66UpCpwteGg4YSxUnt7lPY` |
33-
| <a id="gen-ai-memory-returned-records" href="#gen-ai-memory-returned-records">`gen_ai.memory.returned_records`</a> | ![Development](https://img.shields.io/badge/-development-blue) | any | The memory records returned from a search operation. [6] | [<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User prefers dark mode",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_123",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.95<br>&nbsp;&nbsp;},<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User is based in Seattle",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_456",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.82<br>&nbsp;&nbsp;}<br>] |
33+
| <a id="gen-ai-memory-records" href="#gen-ai-memory-records">`gen_ai.memory.records`</a> | ![Development](https://img.shields.io/badge/-development-blue) | any | The memory records returned from a search operation. [6] | [<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User prefers dark mode",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_123",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.95<br>&nbsp;&nbsp;},<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"content": "User is based in Seattle",<br>&nbsp;&nbsp;&nbsp;&nbsp;"id": "mem_456",<br>&nbsp;&nbsp;&nbsp;&nbsp;"score": 0.82<br>&nbsp;&nbsp;}<br>] |
3434
| <a id="gen-ai-memory-store-id" href="#gen-ai-memory-store-id">`gen_ai.memory.store.id`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The unique identifier of the memory store. [7] | `ms_abc123`; `user-preferences-store` |
3535
| <a id="gen-ai-operation-name" href="#gen-ai-operation-name">`gen_ai.operation.name`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the operation being performed. [8] | `chat`; `generate_content`; `text_completion` |
3636
| <a id="gen-ai-output-messages" href="#gen-ai-output-messages">`gen_ai.output.messages`</a> | ![Development](https://img.shields.io/badge/-development-blue) | any | Messages returned by the model where each message represents a specific model response (choice, candidate). [9] | [<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;"role": "assistant",<br>&nbsp;&nbsp;&nbsp;&nbsp;"parts": [<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type": "text",<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"content": "The weather in Paris is currently rainy with a temperature of 57°F."<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br>&nbsp;&nbsp;&nbsp;&nbsp;],<br>&nbsp;&nbsp;&nbsp;&nbsp;"finish_reason": "stop"<br>&nbsp;&nbsp;}<br>] |
@@ -99,7 +99,7 @@ section for more details.
9999
100100
Instrumentations SHOULD NOT capture this by default.
101101

102-
**[6] `gen_ai.memory.returned_records`:** This attribute follows the same pattern as `gen_ai.retrieval.documents`.
102+
**[6] `gen_ai.memory.records`:** This attribute follows the same pattern as `gen_ai.retrieval.documents`.
103103

104104
Each record object SHOULD contain at least the following properties:
105105
`content` (any): The content of the memory record.

model/gen-ai/registry.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -726,7 +726,7 @@ groups:
726726
> This attribute may contain sensitive information.
727727
examples: ["user dietary preferences", "past flight bookings"]
728728

729-
- id: gen_ai.memory.returned_records
729+
- id: gen_ai.memory.records
730730
stability: development
731731
type: any
732732
brief: The memory records returned from a search operation.

model/gen-ai/spans.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ groups:
609609
conditionally_required: if applicable
610610
- ref: gen_ai.memory.query.text
611611
requirement_level: opt_in
612-
- ref: gen_ai.memory.returned_records
612+
- ref: gen_ai.memory.records
613613
requirement_level: opt_in
614614

615615
- id: span.gen_ai.update_memory.client

0 commit comments

Comments
 (0)