OpenAI 客户端操作的语义约定

状态: 开发中

OpenAI 的语义约定扩展并覆盖了 Gen AI 的语义约定。

Span

gen_ai.provider.name 必须设置为 "openai"。

推理

状态:

OpenAI 客户端 span 的语义约定扩展并覆盖了 Gen AI Span 的语义约定。

gen_ai.provider.name 必须设置为 "openai"，并且应在 **span 创建时** 提供。

**Span 名称** 应为 {gen_ai.operation.name} {gen_ai.request.model}。

**Span 类型**应为 CLIENT。

**Span 状态**应遵循 记录错误文档。

Attributes

键	Stability	需求级别	Value Type	描述	Example Values
gen_ai.operation.name		必需	字符串	正在执行的操作的名称。[1]	chat；generate_content；text_completion
gen_ai.request.model		必需	字符串	请求的 GenAI 模型名称。[2]	gpt-4
error.type		如果操作以错误结束，则条件必需	字符串	描述操作结束的错误类别。[3]	timeout；java.net.UnknownHostException；server_certificate_invalid；500
gen_ai.conversation.id		如果可用，则条件必需	字符串	对话（会话、线程）的唯一标识符，用于在此对话中存储和关联消息。[4]	conv_5j66UpCpwteGg4YSxUnt7lPY
gen_ai.output.type		有条件地必需 [5]	字符串	表示客户端请求的内容类型。[6]	text；json；image
gen_ai.request.choice.count		如果在请求中可用且不等于 1，则条件必需	int	目标候选补全数量。	3
gen_ai.request.seed		如果适用且请求包含种子，则条件必需	int	具有相同种子值的请求更有可能返回相同的结果。	100
openai.request.service_tier		有条件地必需 [7]	字符串	请求的服务层级。可以是具体层级、默认值或自动。	auto; default
openai.response.service_tier		有条件地必需 [8]	字符串	响应使用的服务层级。	scale; default
server.port		如果设置了 server.address，则条件必需。	int	GenAI 服务器端口。[9]	80; 8080; 443
gen_ai.request.frequency_penalty		推荐	double	GenAI 请求的频率惩罚设置。	0.1
gen_ai.request.max_tokens		推荐	int	模型为请求生成的最大令牌数。	100
gen_ai.request.presence_penalty		推荐	double	GenAI 请求的存在惩罚设置。	0.1
gen_ai.request.stop_sequences		推荐	string[]	模型将用于停止生成更多令牌的序列列表。	["forest", "lived"]
gen_ai.request.temperature		推荐	double	GenAI 请求的温度设置。	0.0
gen_ai.request.top_p		推荐	double	GenAI 请求的 top_p 采样设置。	1.0
gen_ai.response.finish_reasons		推荐	string[]	模型停止生成令牌的原因数组，对应于收到的每个生成。	["stop"]；["stop", "length"]
gen_ai.response.id		推荐	字符串	补全的唯一标识符。	chatcmpl-123
gen_ai.response.model		推荐	字符串	生成响应的模型名称。[10]	gpt-4-0613
gen_ai.usage.input_tokens		推荐	int	GenAI 输入（提示）使用的令牌数。	100
gen_ai.usage.output_tokens		推荐	int	GenAI 响应（补全）使用的令牌数。	180
openai.response.system_fingerprint		推荐	字符串	用于跟踪生成式 AI 环境中任何最终更改的指纹。	fp_44709d6fcb
server.address		推荐	字符串	GenAI 服务器地址。[11]	example.com；10.1.2.80；/tmp/my.sock
gen_ai.input.messages		选择加入	any	作为输入提供给模型的聊天记录。[12]	[   {     “role”: “user”,     “parts”: [       {         “type”: “text”,         “content”: “Weather in Paris?"       }     ]   },   {     “role”: “assistant”,     “parts”: [       {         “type”: “tool_call”,         “id”: “call_VSPygqKTWdrhaFErNvMV18Yl”,         “name”: “get_weather”,         “arguments”: {           “location”: “Paris”         }       }     ]   },   {     “role”: “tool”,     “parts”: [       {         “type”: “tool_call_response”,         “id”: " call_VSPygqKTWdrhaFErNvMV18Yl”,         “result”: “rainy, 57°F”       }     ]   } ]
gen_ai.output.messages		选择加入	any	模型返回的消息，每条消息代表一个特定的模型响应（选择、候选）。[13]	[   {     “role”: “assistant”,     “parts”: [       {         “type”: “text”,         “content”: “The weather in Paris is currently rainy with a temperature of 57°F."       }     ],     “finish_reason”: “stop”   } ]
gen_ai.system_instructions		选择加入	any	与聊天记录分开提供给 GenAI 代理或模型的系统消息或指令。[14]	[   {     “type”: “text”,     “content”: “You are an Agent that greet users, always use greetings tool to respond”   } ]; [   {     “type”: “text”,     “content”: “You are a language translator."   },   {     “type”: “text”,     “content”: “Your mission is to translate text in English to French."   } ]
gen_ai.tool.definitions		选择加入	any	可供 GenAI 代理或模型使用的源系统工具定义列表。[15]	[   {     “type”: “function”,     “name”: “get_current_weather”,     “description”: “Get the current weather in a given location”,     “parameters”: {       “type”: “object”,       “properties”: {         “location”: {           “type”: “string”,           “description”: “The city and state, e.g. San Francisco, CA”         },         “unit”: {           “type”: “string”,           “enum”: [             “celsius”,             “fahrenheit”           ]         }       },       “required”: [         “location”,         “unit”       ]     }   } ]

[1] gen_ai.operation.name: 如果预定义值之一适用，但特定系统使用不同名称，则建议在特定 GenAI 系统的语义约定中记录它，并在仪器中使用系统特定的名称。如果未记录不同名称，仪器库应使用适用的预定义值。

[2] gen_ai.request.model： 请求的 GenAI 模型名称。如果模型由供应商提供，则值必须是请求模型的确切名称。如果模型是经过微调的自定义模型，则该值应比经过微调的基础模型具有更具体的名称。

[3] error.type: error.type 应匹配生成式 AI 提供商或客户端库返回的错误代码、发生的异常的规范名称或另一个低基数错误标识符。仪器应记录它们报告的错误列表。

[4] gen_ai.conversation.id: 仪器应在可轻松获得给定操作的对话 ID 时填充它，例如

• 当被仪器化的客户端框架管理对话历史时（请参阅 LlamaIndex chat store）

• 当仪器化维护后端会话的 GenAI 客户端库时（请参阅 AWS Bedrock agent sessions，OpenAI Assistant threads）

管理对话历史的应用程序开发人员可以添加对话 ID 到 GenAI 和其他跨度或日志，使用仪器库提供的自定义跨度或日志记录处理器或钩子。

[5] gen_ai.output.type: 适用时，如果请求包含输出格式。

[6] gen_ai.output.type： 此属性应设置为客户端请求的输出类型

• json，用于具有已定义或未定义架构的结构化输出
• image，用于图像输出
• speech，用于语音输出
• text，用于纯文本输出

该属性指定输出模式，而不是实际输出格式。例如，如果请求的是图像，则实际输出可能是指向图像文件的 URL。

其他输出格式细节可能在将来记录在 gen_ai.output.{type}.* 属性中。

[7] openai.request.service_tier： 如果请求包含 service_tier 且值为非 'auto'

[8] openai.response.service_tier： 如果收到了响应并且包含 service_tier

[9] server.port: 从客户端观察并与中介通信时，server.port 应表示任何中介（例如代理）之后的服务器端口，如果可用。

[10] gen_ai.response.model： 如果可用。提供响应的 GenAI 模型名称。如果模型由供应商提供，则值必须是实际使用的模型的确切名称。如果模型是经过微调的自定义模型，则该值应比经过微调的基础模型具有更具体的名称。

[11] server.address： 从客户端观察到，并且在通过中介进行通信时，server.address 应代表任何中介（例如代理）之后的服务器地址，如果可用。

[12] gen_ai.input.messages： 仪器必须遵循 输入消息 JSON schema。当属性在事件上记录时，必须以结构化形式记录。当在 span 上记录时，如果不支持结构化格式，则可以作为 JSON 字符串记录，否则应以结构化形式记录。

消息必须按发送给模型的顺序提供。仪器可以提供一种方法供用户过滤或截断输入消息。

有关更多详细信息，请参阅 在属性上记录内容 部分。

[13] gen_ai.output.messages： 仪器必须遵循 输出消息 JSON schema

每条消息代表模型生成的单个输出选择/候选。每条消息恰好对应一个生成（选择/候选），反之亦然 - 一个选择不能跨越多条消息，或者一条消息不能包含来自多个选择的部分。

当属性记录在事件上时，它必须以结构化形式记录。当记录在跨度上时，如果不支持结构化格式，它可以被记录为 JSON 字符串，否则应以结构化形式记录。

仪器可以提供一种方法供用户过滤或截断输出消息。

有关更多详细信息，请参阅 在属性上记录内容 部分。

[14] gen_ai.system_instructions： 当相应的供应商或 API 允许将系统指令或消息与聊天记录分开提供时，应使用此属性。

作为聊天记录一部分的指令应记录在 gen_ai.input.messages 属性中，而不是此处。

仪器必须遵循 System instructions JSON schema。

当记录在跨度上时，如果不支持结构化格式，它可以被记录为 JSON 字符串，否则应以结构化形式记录。

仪器可以提供一种方法供用户过滤或截断系统指令。

有关更多详细信息，请参阅 在属性上记录内容 部分。

[15] gen_ai.tool.definitions： 此属性的值匹配源系统工具定义格式。

预计它是一个对象数组，其中每个对象代表一个工具定义。如果仪器可用序列化字符串，仪器应尽最大努力将其反序列化为数组。当记录在跨度上时，如果不支持结构化格式，它可以被记录为 JSON 字符串，否则应以结构化形式记录。

由于此属性可能很大，因此不建议默认填充它。仪器可以提供一种启用填充此属性的方法。

error.type 具有以下已知值列表。如果其中一个适用，则必须使用相应的值；否则，可以使用自定义值。

值	描述	Stability
_OTHER	当检测不到自定义值时使用的回退错误值。

gen_ai.operation.name 具有以下知名值列表。如果其中之一适用，则必须使用相应的值；否则，可以使用自定义值。

值	描述	Stability
chat	聊天完成操作，例如 OpenAI Chat API
create_agent	创建 GenAI 代理
embeddings	嵌入操作，例如 OpenAI 创建嵌入 API
execute_tool	执行工具
generate_content	多模态内容生成操作，例如 Gemini 生成内容
invoke_agent	调用 GenAI 代理
text_completion	文本补全操作，例如 OpenAI Completions API (Legacy)

gen_ai.output.type 具有以下知名值列表。如果其中之一适用，则必须使用相应的值；否则，可以使用自定义值。

值	描述	Stability
image	Image
json	具有已知或未知架构的 JSON 对象
speech	Speech
text	纯文本

openai.request.service_tier 具有以下一系列知名值。如果其中一个适用，则必须使用相应的取值；否则，可以使用自定义取值。

值	描述	Stability
auto	系统将使用缩放层信用额度，直到耗尽为止。
default	系统将使用默认缩放层。

嵌入

请参阅 通用嵌入 Span 定义。

指标

OpenAI 指标遵循 生成式 AI 指标，并附带注意到的其他属性。各个系统可能包含额外的系统特定属性。建议在可用时查看系统特定文档。

指标: gen_ai.client.token.usage

报告 token 使用情况，遵循 gen_ai.client.token.usage 的通用定义。

附加属性

Attributes

键	Stability	需求级别	Value Type	描述	Example Values
openai.response.service_tier		推荐	字符串	响应使用的服务层级。	scale; default
openai.response.system_fingerprint		推荐	字符串	用于跟踪生成式 AI 环境中任何最终更改的指纹。	fp_44709d6fcb

指标: gen_ai.client.operation.duration

衡量完成操作所需时间，遵循 gen_ai.client.operation.duration 的通用定义。

附加属性

Attributes

键	Stability	需求级别	Value Type	描述	Example Values
openai.response.service_tier		推荐	字符串	响应使用的服务层级。	scale; default
openai.response.system_fingerprint		推荐	字符串	用于跟踪生成式 AI 环境中任何最终更改的指纹。	fp_44709d6fcb