forked from open-telemetry/semantic-conventions
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Guangya Liu <gyliu@ibm.com>
- Loading branch information
Showing
8 changed files
with
308 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 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 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,174 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| linkTitle: Generative AI traces | ||
| ---> | ||
|
|
||
| # Semantic Conventions for GenAI agent and framework spans | ||
|
|
||
| **Status**: [Experimental][DocumentStatus] | ||
|
|
||
| <!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` --> | ||
|
|
||
| <!-- toc --> | ||
|
|
||
| - [Spans](#spans) | ||
| * [Create Agent Span](#create-agent-span) | ||
| * [Execute Tool Span](#execute-tool-span) | ||
|
|
||
| <!-- tocstop --> | ||
|
|
||
| Generative AI scenarios may involve multiple steps. For example RAG pattern implementation usually involves | ||
| the following steps: | ||
|
|
||
| - initial request to the GenAI model to rewrite user query | ||
| - getting embeddings for the rewritten query | ||
| - searching for similar documents in the vector store using embeddings | ||
| - getting completion from the GenAI model based on the similar documents. | ||
|
|
||
| These steps may be done by the application itself using GenAI models and vector databases. | ||
| It's also common to leverage client framework such as [LangGraph](https://github.com/langchain-ai/langgraph) | ||
| or service offerings such as [OpenAI Assistants](https://platform.openai.com/docs/assistants), | ||
| [Azure AI Agents](TODO link), or [Amazon Bedrock Agents](https://aws.amazon.com/bedrock/agents/). | ||
|
|
||
| This document defines semantic conventions for GenAI agent calls that are | ||
| handled by the remote agent service. | ||
| It MAY be applicable to agent operations that are performed by the GenAI | ||
| framework locally. | ||
|
|
||
| The semantic conventions for GenAI agents extend and override the semantic conventions | ||
| for [Gen AI Spans](gen-ai-spans.md). | ||
|
|
||
| ## Spans | ||
|
|
||
| ### Create Agent Span | ||
|
|
||
| Describes GenAI agent creation and is usually applicable when working with remote agent | ||
| services. | ||
|
|
||
| The `gen_ai.operation.name` MUST be `create_agent`. | ||
|
|
||
| The **span name** SHOULD be `create_agent {gen_ai.agent.name}`. | ||
| Semantic conventions for individual GenAI systems and frameworks MAY specify different span name format. | ||
|
|
||
| <!-- semconv trace.gen_ai.client.create_agent --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | ||
| |---|---|---|---|---|---| | ||
| | [`gen_ai.operation.name`](/docs/attributes-registry/gen-ai.md) | string | The name of the operation being performed. [1] | `chat`; `text_completion`; `embeddings` | `Required` |  | | ||
| | [`gen_ai.system`](/docs/attributes-registry/gen-ai.md) | string | The Generative AI product as identified by the client or server instrumentation. [2] | `openai` | `Required` |  | | ||
| | [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [3] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | `Conditionally Required` if the operation ended in an error |  | | ||
| | [`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.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 provided by the application. |  | | ||
| | [`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 appliable 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. [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. [7] | `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. [8] | `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. | ||
|
|
||
| **[2] `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`. | ||
|
|
||
| **[3] `error.type`:** 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. | ||
|
|
||
| **[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] `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.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] `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. | ||
|
|
||
| **[8] `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. | ||
|
|
||
| --- | ||
|
|
||
| `error.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 | | ||
| |---|---|---| | ||
| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. |  | | ||
|
|
||
| --- | ||
|
|
||
| `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.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 |  | | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ### Execute Tool Span | ||
|
|
||
| <!-- semconv trace.gen_ai.client.execute_tool --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | ||
| |---|---|---|---|---|---| | ||
| | [`gen_ai.agent.tool.name`](/docs/attributes-registry/gen-ai.md) | string | Name of the tool utilized by the agent. | `Flights` | `Recommended` |  | | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> |
Oops, something went wrong.