Removed unnecessary GenAI agent span attributes when create agent (#2116)
Signed-off-by: Guangya Liu <gyliu@ibm.com> Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
This commit is contained in:
Guangya Liu
GitHub
parent
29237f651b
commit
2d05f4d034
|
|
@ -0,0 +1,22 @@
|
|||
# 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: bug_fix
|
||||
|
||||
# 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: Removed irrelevant attributes on GenAI create agent span.
|
||||
|
||||
# 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: [1924]
|
||||
|
||||
# (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:
|
||||
|
|
@ -56,24 +56,18 @@ Semantic conventions for individual GenAI systems and frameworks MAY specify dif
|
|||
| [`gen_ai.agent.description`](/docs/attributes-registry/gen-ai.md) | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` | `Conditionally Required` If provided by the application. |  |
|
||||
| [`gen_ai.agent.id`](/docs/attributes-registry/gen-ai.md) | string | The unique identifier of the GenAI agent. | `asst_5j66UpCpwteGg4YSxUnt7lPY` | `Conditionally Required` if applicable. |  |
|
||||
| [`gen_ai.agent.name`](/docs/attributes-registry/gen-ai.md) | string | Human-readable name of the GenAI agent provided by the application. | `Math Tutor`; `Fiction Writer` | `Conditionally Required` If provided by the application. |  |
|
||||
| [`gen_ai.output.type`](/docs/attributes-registry/gen-ai.md) | string | Represents the content type requested by the client. [4] | `text`; `json`; `image` | `Conditionally Required` [5] |  |
|
||||
| [`gen_ai.request.choice.count`](/docs/attributes-registry/gen-ai.md) | int | The target number of candidate completions to return. | `3` | `Conditionally Required` if available, in the request, and !=1 |  |
|
||||
| [`gen_ai.request.model`](/docs/attributes-registry/gen-ai.md) | string | The name of the GenAI model a request is being made to. [6] | `gpt-4` | `Conditionally Required` If provided by the application. |  |
|
||||
| [`gen_ai.request.model`](/docs/attributes-registry/gen-ai.md) | string | The name of the GenAI model a request is being made to. [4] | `gpt-4` | `Conditionally Required` If available. |  |
|
||||
| [`gen_ai.request.seed`](/docs/attributes-registry/gen-ai.md) | int | Requests with same seed value more likely to return same result. | `100` | `Conditionally Required` if applicable and if the request includes a seed |  |
|
||||
| [`gen_ai.request.temperature`](/docs/attributes-registry/gen-ai.md) | double | The temperature setting for the GenAI request. | `0.0` | `Conditionally Required` If provided by the application. |  |
|
||||
| [`gen_ai.request.top_p`](/docs/attributes-registry/gen-ai.md) | double | The top_p sampling setting for the GenAI request. | `1.0` | `Conditionally Required` If provided by the application. |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | GenAI server port. [7] | `80`; `8080`; `443` | `Conditionally Required` If `server.address` is set. |  |
|
||||
| [`gen_ai.request.encoding_formats`](/docs/attributes-registry/gen-ai.md) | string[] | The encoding formats requested in an embeddings operation, if specified. [8] | `["base64"]`; `["float", "binary"]` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | GenAI server port. [5] | `80`; `8080`; `443` | `Conditionally Required` If `server.address` is set. |  |
|
||||
| [`gen_ai.request.encoding_formats`](/docs/attributes-registry/gen-ai.md) | string[] | The encoding formats requested in an embeddings operation, if specified. [6] | `["base64"]`; `["float", "binary"]` | `Recommended` |  |
|
||||
| [`gen_ai.request.frequency_penalty`](/docs/attributes-registry/gen-ai.md) | double | The frequency penalty setting for the GenAI request. | `0.1` | `Recommended` |  |
|
||||
| [`gen_ai.request.max_tokens`](/docs/attributes-registry/gen-ai.md) | int | The maximum number of tokens the model generates for a request. | `100` | `Recommended` |  |
|
||||
| [`gen_ai.request.presence_penalty`](/docs/attributes-registry/gen-ai.md) | double | The presence penalty setting for the GenAI request. | `0.1` | `Recommended` |  |
|
||||
| [`gen_ai.request.stop_sequences`](/docs/attributes-registry/gen-ai.md) | string[] | List of sequences that the model will use to stop generating further tokens. | `["forest", "lived"]` | `Recommended` |  |
|
||||
| [`gen_ai.response.finish_reasons`](/docs/attributes-registry/gen-ai.md) | string[] | Array of reasons the model stopped generating tokens, corresponding to each generation received. | `["stop"]`; `["stop", "length"]` | `Recommended` |  |
|
||||
| [`gen_ai.response.id`](/docs/attributes-registry/gen-ai.md) | string | The unique identifier for the completion. | `chatcmpl-123` | `Recommended` |  |
|
||||
| [`gen_ai.response.model`](/docs/attributes-registry/gen-ai.md) | string | The name of the model that generated the response. [9] | `gpt-4-0613` | `Recommended` |  |
|
||||
| [`gen_ai.usage.input_tokens`](/docs/attributes-registry/gen-ai.md) | int | The number of tokens used in the GenAI input (prompt). | `100` | `Recommended` |  |
|
||||
| [`gen_ai.usage.output_tokens`](/docs/attributes-registry/gen-ai.md) | int | The number of tokens used in the GenAI response (completion). | `180` | `Recommended` |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | GenAI server address. [10] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` |  |
|
||||
| [`gen_ai.request.temperature`](/docs/attributes-registry/gen-ai.md) | double | The temperature setting for the GenAI request. | `0.0` | `Recommended` |  |
|
||||
| [`gen_ai.request.top_p`](/docs/attributes-registry/gen-ai.md) | double | The top_p sampling setting for the GenAI request. | `1.0` | `Recommended` |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | GenAI server address. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` |  |
|
||||
|
||||
**[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.
|
||||
|
||||
|
|
@ -93,21 +87,13 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`.
|
|||
the canonical name of exception that occurred, or another low-cardinality error identifier.
|
||||
Instrumentations SHOULD document the list of errors they report.
|
||||
|
||||
**[4] `gen_ai.output.type`:** This attribute SHOULD be used when the client requests output of a specific type. The model may return zero or more outputs of this type.
|
||||
This attribute specifies the output modality and not the actual output format. For example, if an image is requested, the actual output could be a URL pointing to an image file.
|
||||
Additional output format details may be recorded in the future in the `gen_ai.output.{type}.*` attributes.
|
||||
**[4] `gen_ai.request.model`:** The name of the GenAI model a request is being made to. If the model is supplied by a vendor, then the value must be the exact name of the model requested. If the model is a fine-tuned custom model, the value should have a more specific name than the base model that's been fine-tuned.
|
||||
|
||||
**[5] `gen_ai.output.type`:** when applicable and if the request includes an output format.
|
||||
**[5] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
|
||||
|
||||
**[6] `gen_ai.request.model`:** The name of the GenAI model a request is being made to. If the model is supplied by a vendor, then the value must be the exact name of the model requested. If the model is a fine-tuned custom model, the value should have a more specific name than the base model that's been fine-tuned.
|
||||
**[6] `gen_ai.request.encoding_formats`:** In some GenAI systems the encoding formats are called embedding types. Also, some GenAI systems only accept a single format per request.
|
||||
|
||||
**[7] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
|
||||
|
||||
**[8] `gen_ai.request.encoding_formats`:** In some GenAI systems the encoding formats are called embedding types. Also, some GenAI systems only accept a single format per request.
|
||||
|
||||
**[9] `gen_ai.response.model`:** If available. The name of the GenAI model that provided the response. If the model is supplied by a vendor, then the value must be the exact name of the model actually used. If the model is a fine-tuned custom model, the value should have a more specific name than the base model that's been fine-tuned.
|
||||
|
||||
**[10] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
|
||||
**[7] `server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -132,17 +118,6 @@ Additional output format details may be recorded in the future in the `gen_ai.ou
|
|||
|
||||
---
|
||||
|
||||
`gen_ai.output.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `image` | Image |  |
|
||||
| `json` | JSON object with known or unknown schema |  |
|
||||
| `speech` | Speech |  |
|
||||
| `text` | Plain text |  |
|
||||
|
||||
---
|
||||
|
||||
`gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
| Value | Description | Stability |
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
groups:
|
||||
- id: trace.gen_ai.client.common_attributes
|
||||
- id: trace.gen_ai.client.common_request_attributes
|
||||
type: attribute_group
|
||||
stability: development
|
||||
brief: >
|
||||
|
|
@ -34,6 +34,27 @@ groups:
|
|||
conditionally_required: if applicable and if the request includes a seed
|
||||
- ref: gen_ai.request.encoding_formats
|
||||
requirement_level: recommended
|
||||
- ref: server.address
|
||||
brief: GenAI server address.
|
||||
requirement_level: recommended
|
||||
- ref: server.port
|
||||
brief: GenAI server port.
|
||||
requirement_level:
|
||||
conditionally_required: If `server.address` is set.
|
||||
- ref: error.type
|
||||
requirement_level:
|
||||
conditionally_required: "if the operation ended in an error"
|
||||
note: |
|
||||
The `error.type` SHOULD match the error code returned by the Generative AI provider or the client library,
|
||||
the canonical name of exception that occurred, or another low-cardinality error identifier.
|
||||
Instrumentations SHOULD document the list of errors they report.
|
||||
- id: trace.gen_ai.client.common_attributes
|
||||
type: attribute_group
|
||||
stability: development
|
||||
brief: >
|
||||
Describes GenAI operation span.
|
||||
extends: trace.gen_ai.client.common_request_attributes
|
||||
attributes:
|
||||
- ref: gen_ai.output.type
|
||||
requirement_level:
|
||||
conditionally_required: when applicable and if the request includes an output format.
|
||||
|
|
@ -51,20 +72,6 @@ groups:
|
|||
requirement_level: recommended
|
||||
- ref: gen_ai.usage.output_tokens
|
||||
requirement_level: recommended
|
||||
- ref: server.address
|
||||
brief: GenAI server address.
|
||||
requirement_level: recommended
|
||||
- ref: server.port
|
||||
brief: GenAI server port.
|
||||
requirement_level:
|
||||
conditionally_required: If `server.address` is set.
|
||||
- ref: error.type
|
||||
requirement_level:
|
||||
conditionally_required: "if the operation ended in an error"
|
||||
note: |
|
||||
The `error.type` SHOULD match the error code returned by the Generative AI provider or the client library,
|
||||
the canonical name of exception that occurred, or another low-cardinality error identifier.
|
||||
Instrumentations SHOULD document the list of errors they report.
|
||||
- id: span.gen_ai.client
|
||||
type: span
|
||||
stability: development
|
||||
|
|
@ -182,7 +189,7 @@ groups:
|
|||
|
||||
**Span name** SHOULD be `create_agent {gen_ai.agent.name}`.
|
||||
Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format.
|
||||
extends: trace.gen_ai.client.common_attributes
|
||||
extends: trace.gen_ai.client.common_request_attributes
|
||||
attributes:
|
||||
- ref: gen_ai.system
|
||||
requirement_level: required
|
||||
|
|
@ -195,19 +202,6 @@ groups:
|
|||
- ref: gen_ai.agent.description
|
||||
requirement_level:
|
||||
conditionally_required: If provided by the application.
|
||||
- ref: gen_ai.request.model
|
||||
requirement_level:
|
||||
conditionally_required: If provided by the application.
|
||||
note: >
|
||||
The name of the GenAI model a request is being made to. If the model is supplied by a vendor,
|
||||
then the value must be the exact name of the model requested. If the model is a fine-tuned
|
||||
custom model, the value should have a more specific name than the base model that's been fine-tuned.
|
||||
- ref: gen_ai.request.temperature
|
||||
requirement_level:
|
||||
conditionally_required: If provided by the application.
|
||||
- ref: gen_ai.request.top_p
|
||||
requirement_level:
|
||||
conditionally_required: If provided by the application.
|
||||
|
||||
- id: span.gen_ai.execute_tool.internal
|
||||
type: span
|
||||
|
|
|
|||
Loading…
Reference in New Issue