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.

AttributeTypeDescriptionExamplesStability
gen_ai.agent.descriptionstringFree-form description of the GenAI agent provided by the application.Helps with math problems; Generates fiction storiesDevelopment
gen_ai.agent.idstringThe unique identifier of the GenAI agent.asst_5j66UpCpwteGg4YSxUnt7lPYDevelopment
gen_ai.agent.namestringHuman-readable name of the GenAI agent provided by the application.Math Tutor; Fiction WriterDevelopment
gen_ai.operation.namestringThe name of the operation being performed. [1]chat; text_completion; embeddingsDevelopment
gen_ai.output.typestringRepresents the content type requested by the client. [2]text; json; imageDevelopment
gen_ai.request.choice.countintThe target number of candidate completions to return.3Development
gen_ai.request.encoding_formatsstring[]The encoding formats requested in an embeddings operation, if specified. [3]["base64"]; ["float", "binary"]Development
gen_ai.request.frequency_penaltydoubleThe frequency penalty setting for the GenAI request.0.1Development
gen_ai.request.max_tokensintThe maximum number of tokens the model generates for a request.100Development
gen_ai.request.modelstringThe name of the GenAI model a request is being made to.gpt-4Development
gen_ai.request.presence_penaltydoubleThe presence penalty setting for the GenAI request.0.1Development
gen_ai.request.seedintRequests with same seed value more likely to return same result.100Development
gen_ai.request.stop_sequencesstring[]List of sequences that the model will use to stop generating further tokens.["forest", "lived"]Development
gen_ai.request.temperaturedoubleThe temperature setting for the GenAI request.0.0Development
gen_ai.request.top_kdoubleThe top_k sampling setting for the GenAI request.1.0Development
gen_ai.request.top_pdoubleThe top_p sampling setting for the GenAI request.1.0Development
gen_ai.response.finish_reasonsstring[]Array of reasons the model stopped generating tokens, corresponding to each generation received.["stop"]; ["stop", "length"]Development
gen_ai.response.idstringThe unique identifier for the completion.chatcmpl-123Development
gen_ai.response.modelstringThe name of the model that generated the response.gpt-4-0613Development
gen_ai.systemstringThe Generative AI product as identified by the client or server instrumentation. [4]openaiDevelopment
gen_ai.token.typestringThe type of token being counted.input; outputDevelopment
gen_ai.tool.call.idstringThe tool call identifier.call_mszuSIzqtI65i1wAUOE8w5H4Development
gen_ai.tool.namestringName of the tool utilized by the agent.FlightsDevelopment
gen_ai.tool.typestringType of the tool utilized by the agent [5]function; extension; datastoreDevelopment
gen_ai.usage.input_tokensintThe number of tokens used in the GenAI input (prompt).100Development
gen_ai.usage.output_tokensintThe number of tokens used in the GenAI response (completion).180Development

[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.

ValueDescriptionStability
chatChat completion operation such as OpenAI Chat APIDevelopment
create_agentCreate GenAI agentDevelopment
embeddingsEmbeddings operation such as OpenAI Create embeddings APIDevelopment
execute_toolExecute a toolDevelopment
text_completionText 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.

ValueDescriptionStability
imageImageDevelopment
jsonJSON object with known or unknown schemaDevelopment
speechSpeechDevelopment
textPlain textDevelopment

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.

ValueDescriptionStability
anthropicAnthropicDevelopment
aws.bedrockAWS BedrockDevelopment
az.ai.inferenceAzure AI InferenceDevelopment
az.ai.openaiAzure OpenAIDevelopment
cohereCohereDevelopment
deepseekDeepSeekDevelopment
geminiGeminiDevelopment
groqGroqDevelopment
ibm.watsonx.aiIBM Watsonx AIDevelopment
mistral_aiMistral AIDevelopment
openaiOpenAIDevelopment
perplexityPerplexityDevelopment
vertex_aiVertex AIDevelopment
xaixAIDevelopment

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.

ValueDescriptionStability
inputInput tokens (prompt, input, etc.)Development
outputOutput tokens (completion, response, etc.)Development

OpenAI Attributes

This group defines attributes for OpenAI.

AttributeTypeDescriptionExamplesStability
gen_ai.openai.request.service_tierstringThe service tier requested. May be a specific tier, default, or auto.auto; defaultDevelopment
gen_ai.openai.response.service_tierstringThe service tier used for the response.scale; defaultDevelopment
gen_ai.openai.response.system_fingerprintstringA fingerprint to track any eventual change in the Generative AI environment.fp_44709d6fcbDevelopment

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.

ValueDescriptionStability
autoThe system will utilize scale tier credits until they are exhausted.Development
defaultThe system will utilize the default scale tier.Development

Deprecated GenAI Attributes

Describes deprecated gen_ai attributes.

AttributeTypeDescriptionExamplesStability
gen_ai.completionstringDeprecated, 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.promptstringDeprecated, 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_tokensintDeprecated, use gen_ai.usage.output_tokens instead.42Deprecated
Replaced by gen_ai.usage.output_tokens attribute.
gen_ai.usage.prompt_tokensintDeprecated, use gen_ai.usage.input_tokens instead.42Deprecated
Replaced by gen_ai.usage.input_tokens attribute.

Deprecated OpenAI GenAI Attributes

Describes deprecated gen_ai.openai attributes.

AttributeTypeDescriptionExamplesStability
gen_ai.openai.request.response_formatstringDeprecated, use gen_ai.output.type.text; json_object; json_schemaDeprecated
Replaced by gen_ai.output.type.
gen_ai.openai.request.seedintDeprecated, use gen_ai.request.seed.100Deprecated
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.

ValueDescriptionStability
json_objectJSON object response formatDevelopment
json_schemaJSON schema response formatDevelopment
textText response formatDevelopment