Watsonx Semantic Conventions [INSTA-21674] #2792
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,28 @@ | ||
| # 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 IBM WatsonX AI semantic conventions" | ||
|
|
||
| # 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: [123] | ||
|
|
||
| # (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: | | ||
| Added specific semantic conventions for IBM WatsonX AI including: | ||
| - WatsonX-specific attributes like project_id, space_id, version, and trace_id | ||
| - WatsonX-specific LLM attributes like decoding_method, random_seed, max_new_tokens, min_new_tokens, and repetition_penalty | ||
| - WatsonX-specific metrics for completions duration, exceptions, responses, and tokens | ||
| - Dedicated span definition for WatsonX client operations | ||
| - Comprehensive documentation with examples | ||
|
||
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,181 @@ | ||
| <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/attribute_namespace.md.j2 --> | ||
|
|
||
| # Gen AI | ||
|
|
||
| - [GenAI Attributes](#genai-attributes) | ||
| - [OpenAI Attributes](#openai-attributes) | ||
| - [IBM WatsonX AI Attributes](#ibm-watsonx-ai-attributes) | ||
| - [Deprecated GenAI Attributes](#deprecated-genai-attributes) | ||
| - [Deprecated OpenAI GenAI Attributes](#deprecated-openai-genai-attributes) | ||
|
|
||
| ## GenAI Attributes | ||
|
|
||
| This document defines the attributes used to describe telemetry in the context of Generative Artificial Intelligence (GenAI) Models requests and responses. | ||
|
||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="gen-ai-agent-description" href="#gen-ai-agent-description">`gen_ai.agent.description`</a> | string | Free-form description of the GenAI agent provided by the application. | `Helps with math problems`; `Generates fiction stories` |  | | ||
| | <a id="gen-ai-agent-id" href="#gen-ai-agent-id">`gen_ai.agent.id`</a> | string | The unique identifier of the GenAI agent. | `asst_5j66UpCpwteGg4YSxUnt7lPY` |  | | ||
| | <a id="gen-ai-agent-name" href="#gen-ai-agent-name">`gen_ai.agent.name`</a> | string | Human-readable name of the GenAI agent provided by the application. | `Math Tutor`; `Fiction Writer` |  | | ||
| | <a id="gen-ai-operation-name" href="#gen-ai-operation-name">`gen_ai.operation.name`</a> | string | The name of the operation being performed. [1] | `chat`; `text_completion`; `embeddings` |  | | ||
| | <a id="gen-ai-output-type" href="#gen-ai-output-type">`gen_ai.output.type`</a> | string | Represents the content type requested by the client. [2] | `text`; `json`; `image` |  | | ||
| | <a id="gen-ai-request-encoding-formats" href="#gen-ai-request-encoding-formats">`gen_ai.request.encoding_formats`</a> | string[] | The encoding formats requested in an embeddings operation, if specified. [3] | `["base64"]`; `["float", "binary"]` |  | | ||
| | <a id="gen-ai-request-frequency-penalty" href="#gen-ai-request-frequency-penalty">`gen_ai.request.frequency_penalty`</a> | double | The frequency penalty setting for the GenAI request. | `0.1` |  | | ||
| | <a id="gen-ai-request-max-tokens" href="#gen-ai-request-max-tokens">`gen_ai.request.max_tokens`</a> | int | The maximum number of tokens the model generates for a request. | `100` |  | | ||
| | <a id="gen-ai-request-model" href="#gen-ai-request-model">`gen_ai.request.model`</a> | string | The name of the GenAI model a request is being made to. | `gpt-4` |  | | ||
| | <a id="gen-ai-request-presence-penalty" href="#gen-ai-request-presence-penalty">`gen_ai.request.presence_penalty`</a> | double | The presence penalty setting for the GenAI request. | `0.1` |  | | ||
| | <a id="gen-ai-request-seed" href="#gen-ai-request-seed">`gen_ai.request.seed`</a> | int | Requests with same seed value more likely to return same result. | `100` |  | | ||
| | <a id="gen-ai-request-stop-sequences" href="#gen-ai-request-stop-sequences">`gen_ai.request.stop_sequences`</a> | string[] | List of sequences that the model will use to stop generating further tokens. | `["forest", "lived"]` |  | | ||
| | <a id="gen-ai-request-temperature" href="#gen-ai-request-temperature">`gen_ai.request.temperature`</a> | double | The temperature setting for the GenAI request. | `0.0` |  | | ||
| | <a id="gen-ai-request-top-k" href="#gen-ai-request-top-k">`gen_ai.request.top_k`</a> | double | The top_k sampling setting for the GenAI request. | `1.0` |  | | ||
| | <a id="gen-ai-request-top-p" href="#gen-ai-request-top-p">`gen_ai.request.top_p`</a> | double | The top_p sampling setting for the GenAI request. | `1.0` |  | | ||
| | <a id="gen-ai-response-finish-reasons" href="#gen-ai-response-finish-reasons">`gen_ai.response.finish_reasons`</a> | string[] | Array of reasons the model stopped generating tokens, corresponding to each generation received. | `["stop"]`; `["stop", "length"]` |  | | ||
| | <a id="gen-ai-response-id" href="#gen-ai-response-id">`gen_ai.response.id`</a> | string | The unique identifier for the completion. | `chatcmpl-123` |  | | ||
| | <a id="gen-ai-response-model" href="#gen-ai-response-model">`gen_ai.response.model`</a> | string | The name of the model that generated the response. | `gpt-4-0613` |  | | ||
| | <a id="gen-ai-system" href="#gen-ai-system">`gen_ai.system`</a> | string | The Generative AI product as identified by the client or server instrumentation. [4] | `openai` |  | | ||
| | <a id="gen-ai-token-type" href="#gen-ai-token-type">`gen_ai.token.type`</a> | string | The type of token being counted. | `input`; `output` |  | | ||
| | <a id="gen-ai-tool-call-id" href="#gen-ai-tool-call-id">`gen_ai.tool.call.id`</a> | string | The tool call identifier. | `call_mszuSIzqtI65i1wAUOE8w5H4` |  | | ||
| | <a id="gen-ai-tool-name" href="#gen-ai-tool-name">`gen_ai.tool.name`</a> | string | Name of the tool utilized by the agent. | `Flights` |  | | ||
| | <a id="gen-ai-tool-type" href="#gen-ai-tool-type">`gen_ai.tool.type`</a> | string | Type of the tool utilized by the agent [5] | `function`; `extension`; `datastore` |  | | ||
| | <a id="gen-ai-usage-input-tokens" href="#gen-ai-usage-input-tokens">`gen_ai.usage.input_tokens`</a> | int | The number of tokens used in the GenAI input (prompt). | `100` |  | | ||
| | <a id="gen-ai-usage-output-tokens" href="#gen-ai-usage-output-tokens">`gen_ai.usage.output_tokens`</a> | int | The number of tokens used in the GenAI response (completion). | `180` |  | | ||
|
|
||
| **[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. | ||
|
|
||
| **[2] `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. | ||
|
|
||
| **[3] `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. | ||
|
|
||
| **[4] `gen_ai.system`:** The `gen_ai.system` describes a family of GenAI models with specific model identified | ||
| by `gen_ai.request.model` and `gen_ai.response.model` attributes. | ||
|
|
||
| The actual GenAI product may differ from the one identified by the client. | ||
| Multiple systems, including Azure OpenAI and Gemini, are accessible by OpenAI client | ||
| libraries. In such cases, the `gen_ai.system` is set to `openai` based on the | ||
| instrumentation's best knowledge, instead of the actual system. The `server.address` | ||
| attribute may help identify the actual system in use for `openai`. | ||
|
|
||
| For custom model, a custom friendly name SHOULD be used. | ||
| If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | ||
|
|
||
| **[5] `gen_ai.tool.type`:** Extension: A tool executed on the agent-side to directly call external APIs, bridging the gap between the agent and real-world systems. | ||
| Agent-side operations involve actions that are performed by the agent on the server or within the agent's controlled environment. | ||
| Function: A tool executed on the client-side, where the agent generates parameters for a predefined function, and the client executes the logic. | ||
| Client-side operations are actions taken on the user's end or within the client application. | ||
| Datastore: A tool used by the agent to access and query structured or unstructured external data for retrieval-augmented tasks or knowledge updates. | ||
|
|
||
| --- | ||
|
|
||
| `gen_ai.operation.name` 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 | | ||
| |---|---|---| | ||
| | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) |  | | ||
| | `create_agent` | Create GenAI agent |  | | ||
| | `embeddings` | Embeddings operation such as [OpenAI Create embeddings API](https://platform.openai.com/docs/api-reference/embeddings/create) |  | | ||
| | `execute_tool` | Execute a tool |  | | ||
| | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) |  | | ||
|
|
||
| --- | ||
|
|
||
| `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 | | ||
| |---|---|---| | ||
| | `anthropic` | Anthropic |  | | ||
| | `aws.bedrock` | AWS Bedrock |  | | ||
| | `az.ai.inference` | Azure AI Inference |  | | ||
| | `az.ai.openai` | Azure OpenAI |  | | ||
| | `cohere` | Cohere |  | | ||
| | `deepseek` | DeepSeek |  | | ||
| | `gemini` | Gemini |  | | ||
| | `groq` | Groq |  | | ||
| | `ibm.watsonx.ai` | IBM Watsonx AI |  | | ||
| | `mistral_ai` | Mistral AI |  | | ||
| | `openai` | OpenAI |  | | ||
| | `perplexity` | Perplexity |  | | ||
| | `vertex_ai` | Vertex AI |  | | ||
| | `xai` | xAI |  | | ||
|
|
||
| --- | ||
|
|
||
| `gen_ai.token.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 | | ||
| |---|---|---| | ||
| | `input` | Input tokens (prompt, input, etc.) |  | | ||
| | `output` | Output tokens (completion, response, etc.) |  | | ||
|
|
||
| ## OpenAI Attributes | ||
|
|
||
| This group defines attributes for OpenAI. | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="gen-ai-openai-request-service-tier" href="#gen-ai-openai-request-service-tier">`gen_ai.openai.request.service_tier`</a> | string | The service tier requested. May be a specific tier, default, or auto. | `auto`; `default` |  | | ||
| | <a id="gen-ai-openai-response-service-tier" href="#gen-ai-openai-response-service-tier">`gen_ai.openai.response.service_tier`</a> | string | The service tier used for the response. | `scale`; `default` |  | | ||
| | <a id="gen-ai-openai-response-system-fingerprint" href="#gen-ai-openai-response-system-fingerprint">`gen_ai.openai.response.system_fingerprint`</a> | string | A fingerprint to track any eventual change in the Generative AI environment. | `fp_44709d6fcb` |  | | ||
|
|
||
| --- | ||
|
|
||
| `gen_ai.openai.request.service_tier` 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 | | ||
| |---|---|---| | ||
| | `auto` | The system will utilize scale tier credits until they are exhausted. |  | | ||
| | `default` | The system will utilize the default scale tier. |  | | ||
|
|
||
| ## IBM WatsonX AI Attributes | ||
|
|
||
| This group defines attributes specific to IBM WatsonX AI. | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="gen-ai-watsonx-request-project-id" href="#gen-ai-watsonx-request-project-id">`gen_ai.watsonx.request.project_id`</a> | string | The project ID in IBM WatsonX AI. | `12345678-abcd-1234-efgh-1234567890ab` |  | | ||
| | <a id="gen-ai-watsonx-request-space-id" href="#gen-ai-watsonx-request-space-id">`gen_ai.watsonx.request.space_id`</a> | string | The space ID in IBM WatsonX AI. | `abcdef12-3456-7890-abcd-ef1234567890` |  | | ||
| | <a id="gen-ai-watsonx-request-version" href="#gen-ai-watsonx-request-version">`gen_ai.watsonx.request.version`</a> | string | The version of the model being used. | `1.0`; `2.3.1` |  | | ||
| | <a id="gen-ai-watsonx-response-trace-id" href="#gen-ai-watsonx-response-trace-id">`gen_ai.watsonx.response.trace_id`</a> | string | The trace ID returned by IBM WatsonX AI. | `wxt-12345678-abcd-1234-efgh-1234567890ab` |  | | ||
|
|
||
| ## Deprecated GenAI Attributes | ||
|
|
||
| Describes deprecated `gen_ai` attributes. | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="gen-ai-completion" href="#gen-ai-completion">`gen_ai.completion`</a> | string | Deprecated, use Event API to report completions contents. | `[{'role': 'assistant', 'content': 'The capital of France is Paris.'}]` | <br>Removed, no replacement at this time. | | ||
| | <a id="gen-ai-prompt" href="#gen-ai-prompt">`gen_ai.prompt`</a> | string | Deprecated, use Event API to report prompt contents. | `[{'role': 'user', 'content': 'What is the capital of France?'}]` | <br>Removed, no replacement at this time. | | ||
| | <a id="gen-ai-usage-completion-tokens" href="#gen-ai-usage-completion-tokens">`gen_ai.usage.completion_tokens`</a> | int | Deprecated, use `gen_ai.usage.output_tokens` instead. | `42` | <br>Replaced by `gen_ai.usage.output_tokens` attribute. | | ||
| | <a id="gen-ai-usage-prompt-tokens" href="#gen-ai-usage-prompt-tokens">`gen_ai.usage.prompt_tokens`</a> | int | Deprecated, use `gen_ai.usage.input_tokens` instead. | `42` | <br>Replaced by `gen_ai.usage.input_tokens` attribute. | | ||
|
|
||
| ## Deprecated OpenAI GenAI Attributes | ||
|
|
||
| Describes deprecated `gen_ai.openai` attributes. | ||
|
|
||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | <a id="gen-ai-openai-request-response-format" href="#gen-ai-openai-request-response-format">`gen_ai.openai.request.response_format`</a> | string | Deprecated, use `gen_ai.output.type`. | `text`; `json_object`; `json_schema` | <br>Replaced by `gen_ai.output.type`. | | ||
| | <a id="gen-ai-openai-request-seed" href="#gen-ai-openai-request-seed">`gen_ai.openai.request.seed`</a> | int | Deprecated, use `gen_ai.request.seed`. | `100` | <br>Replaced by `gen_ai.request.seed` attribute. | | ||
|
|
||
| --- | ||
|
|
||
| `gen_ai.openai.request.response_format` 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 | | ||
| |---|---|---| | ||
| | `json_object` | JSON object response format |  | | ||
| | `json_schema` | JSON schema response format |  | | ||
| | `text` | Text response format |  | | ||
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.
s/123/1650
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.
Done ,