Skip to content

Latest commit

 

History

History
170 lines (131 loc) · 17 KB

File metadata and controls

170 lines (131 loc) · 17 KB

Gen AI

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
gen_ai.agent.description string Free-form description of the GenAI agent provided by the application. Helps with math problems; Generates fiction stories Development
gen_ai.agent.id string The unique identifier of the GenAI agent. asst_5j66UpCpwteGg4YSxUnt7lPY Development
gen_ai.agent.name string Human-readable name of the GenAI agent provided by the application. Math Tutor; Fiction Writer Development
gen_ai.operation.name string The name of the operation being performed. [1] chat; text_completion; embeddings Development
gen_ai.output.type string Represents the content type requested by the client. [2] text; json; image Development
gen_ai.request.choice.count int The target number of candidate completions to return. 3 Development
gen_ai.request.encoding_formats string[] The encoding formats requested in an embeddings operation, if specified. [3] ["base64"]; ["float", "binary"] Development
gen_ai.request.frequency_penalty double The frequency penalty setting for the GenAI request. 0.1 Development
gen_ai.request.max_tokens int The maximum number of tokens the model generates for a request. 100 Development
gen_ai.request.model string The name of the GenAI model a request is being made to. gpt-4 Development
gen_ai.request.presence_penalty double The presence penalty setting for the GenAI request. 0.1 Development
gen_ai.request.seed int Requests with same seed value more likely to return same result. 100 Development
gen_ai.request.stop_sequences string[] List of sequences that the model will use to stop generating further tokens. ["forest", "lived"] Development
gen_ai.request.temperature double The temperature setting for the GenAI request. 0.0 Development
gen_ai.request.top_k double The top_k sampling setting for the GenAI request. 1.0 Development
gen_ai.request.top_p double The top_p sampling setting for the GenAI request. 1.0 Development
gen_ai.response.finish_reasons string[] Array of reasons the model stopped generating tokens, corresponding to each generation received. ["stop"]; ["stop", "length"] Development
gen_ai.response.id string The unique identifier for the completion. chatcmpl-123 Development
gen_ai.response.model string The name of the model that generated the response. gpt-4-0613 Development
gen_ai.system string The Generative AI product as identified by the client or server instrumentation. [4] openai Development
gen_ai.token.type string The type of token being counted. input; output Development
gen_ai.tool.call.id string The tool call identifier. call_mszuSIzqtI65i1wAUOE8w5H4 Development
gen_ai.tool.name string Name of the tool utilized by the agent. Flights Development
gen_ai.tool.type string Type of the tool utilized by the agent [5] function; extension; datastore Development
gen_ai.usage.input_tokens int The number of tokens used in the GenAI input (prompt). 100 Development
gen_ai.usage.output_tokens int The number of tokens used in the GenAI response (completion). 180 Development

[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 Development
create_agent Create GenAI agent Development
embeddings Embeddings operation such as OpenAI Create embeddings API Development
execute_tool Execute a tool Development
text_completion Text completions operation such as OpenAI Completions API (Legacy) Development

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 Development
json JSON object with known or unknown schema Development
speech Speech Development
text Plain text Development

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 Development
aws.bedrock AWS Bedrock Development
az.ai.inference Azure AI Inference Development
az.ai.openai Azure OpenAI Development
cohere Cohere Development
deepseek DeepSeek Development
gemini Gemini Development
groq Groq Development
ibm.watsonx.ai IBM Watsonx AI Development
mistral_ai Mistral AI Development
openai OpenAI Development
perplexity Perplexity Development
vertex_ai Vertex AI Development
xai xAI Development

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.) Development
output Output tokens (completion, response, etc.) Development

OpenAI Attributes

This group defines attributes for OpenAI.

Attribute Type Description Examples Stability
gen_ai.openai.request.service_tier string The service tier requested. May be a specific tier, default, or auto. auto; default Development
gen_ai.openai.response.service_tier string The service tier used for the response. scale; default Development
gen_ai.openai.response.system_fingerprint string A fingerprint to track any eventual change in the Generative AI environment. fp_44709d6fcb Development

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. Development
default The system will utilize the default scale tier. Development

Deprecated GenAI Attributes

Describes deprecated gen_ai attributes.

Attribute Type Description Examples Stability
gen_ai.completion string Deprecated, use Event API to report completions contents. [{'role': 'assistant', 'content': 'The capital of France is Paris.'}] Deprecated
Removed, no replacement at this time.
gen_ai.prompt string Deprecated, use Event API to report prompt contents. [{'role': 'user', 'content': 'What is the capital of France?'}] Deprecated
Removed, no replacement at this time.
gen_ai.usage.completion_tokens int Deprecated, use gen_ai.usage.output_tokens instead. 42 Deprecated
Replaced by gen_ai.usage.output_tokens attribute.
gen_ai.usage.prompt_tokens int Deprecated, use gen_ai.usage.input_tokens instead. 42 Deprecated
Replaced by gen_ai.usage.input_tokens attribute.

Deprecated OpenAI GenAI Attributes

Describes deprecated gen_ai.openai attributes.

Attribute Type Description Examples Stability
gen_ai.openai.request.response_format string Deprecated, use gen_ai.output.type. text; json_object; json_schema Deprecated
Replaced by gen_ai.output.type.
gen_ai.openai.request.seed int Deprecated, use gen_ai.request.seed. 100 Deprecated
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 Development
json_schema JSON schema response format Development
text Text response format Development