semantic-conventions/docs/registry/attributes/gen-ai.md

Gen AI

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

[1] gen_ai.data_source.id: Data sources are used by AI agents and RAG applications to store grounding data. A data source may be an external database, object store, document collection, website, or any other storage system used by the GenAI agent or application. The gen_ai.data_source.id SHOULD match the identifier used by the GenAI system rather than a name specific to the external storage, such as a database or object store. Semantic conventions referencing gen_ai.data_source.id MAY also leverage additional attributes, such as db.*, to further identify and describe the data source.

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

[3] 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.provider.name: The attribute SHOULD be set based on the instrumentation's best knowledge and may differ from the actual model provider.

Multiple providers, including Azure OpenAI, Gemini, and AI hosting platforms are accessible using the OpenAI REST API and corresponding client libraries, but may proxy or host models from different providers.

The gen_ai.request.model, gen_ai.response.model, and server.address attributes may help identify the actual system in use.

The gen_ai.provider.name attribute acts as a discriminator that identifies the GenAI telemetry format flavor specific to that provider within GenAI semantic conventions. It SHOULD be set consistently with provider-specific attributes and signals. For example, GenAI spans, metrics, and events related to AWS Bedrock should have the gen_ai.provider.name set to aws.bedrock and include applicable aws.bedrock.* attributes and are not expected to include openai.* attributes.

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

[6] 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
create_agent	Create GenAI agent
embeddings	Embeddings operation such as OpenAI Create embeddings API
execute_tool	Execute a tool
generate_content	Multimodal content generation operation such as Gemini Generate Content
invoke_agent	Invoke GenAI agent
text_completion	Text completions operation such as OpenAI Completions API (Legacy)

---

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.provider.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
anthropic	Anthropic
aws.bedrock	AWS Bedrock
azure.ai.inference	Azure AI Inference
azure.ai.openai	Azure OpenAI
cohere	Cohere
deepseek	DeepSeek
gcp.gemini	Gemini [7]
gcp.gen_ai	Any Google generative AI endpoint [8]
gcp.vertex_ai	Vertex AI [9]
groq	Groq
ibm.watsonx.ai	IBM Watsonx AI
mistral_ai	Mistral AI
openai	OpenAI
perplexity	Perplexity
x_ai	xAI

[7]: Used when accessing the 'generativelanguage.googleapis.com' endpoint. Also known as the AI Studio API.

[8]: May be used when specific backend is unknown.

[9]: Used when accessing the 'aiplatform.googleapis.com' endpoint.

---

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

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.'}]	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?'}]	Removed, no replacement at this time.
gen_ai.system	string	Deprecated, use gen_ai.provider.name instead.	openai; gcp.gen_ai; gcp.vertex_ai	Replaced by gen_ai.provider.name.
gen_ai.usage.completion_tokens	int	Deprecated, use gen_ai.usage.output_tokens instead.	42	Replaced by gen_ai.usage.output_tokens.
gen_ai.usage.prompt_tokens	int	Deprecated, use gen_ai.usage.input_tokens instead.	42	Replaced by gen_ai.usage.input_tokens.

---

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
azure.ai.inference	Azure AI Inference
azure.ai.openai	Azure OpenAI
cohere	Cohere
deepseek	DeepSeek
gcp.gemini	Gemini [10]
gcp.gen_ai	Any Google generative AI endpoint [11]
gcp.vertex_ai	Vertex AI [12]
groq	Groq
ibm.watsonx.ai	IBM Watsonx AI
mistral_ai	Mistral AI
openai	OpenAI
perplexity	Perplexity

[10]: This refers to the 'generativelanguage.googleapis.com' endpoint. Also known as the AI Studio API. May use common attributes prefixed with 'gcp.gen_ai.'.

[11]: May be used when specific backend is unknown. May use common attributes prefixed with 'gcp.gen_ai.'.

[12]: This refers to the 'aiplatform.googleapis.com' endpoint. May use common attributes prefixed with 'gcp.gen_ai.'.

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	Replaced by gen_ai.output.type.
gen_ai.openai.request.seed	int	Deprecated, use gen_ai.request.seed.	100	Replaced by gen_ai.request.seed.
gen_ai.openai.request.service_tier	string	Deprecated, use openai.request.service_tier.	auto; default	Replaced by openai.request.service_tier.
gen_ai.openai.response.service_tier	string	Deprecated, use openai.response.service_tier.	scale; default	Replaced by openai.response.service_tier.
gen_ai.openai.response.system_fingerprint	string	Deprecated, use openai.response.system_fingerprint.	fp_44709d6fcb	Replaced by openai.response.system_fingerprint.

---

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

---

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.