跳至主要内容

StandardLoggingPayload 规范

位于 kwargs["standard_logging_object"]。这是一个标准载荷,记录每一次成功和失败的响应。

StandardLoggingPayload

字段类型描述
id字符串唯一标识符
trace_id字符串追踪属于同一整体请求的多个 LLM 调用
call_type字符串调用类型
response_costfloat以美元 ($) 计算的响应成本
cost_breakdownOptional[CostBreakdown]详细的成本明细对象
response_cost_failure_debug_infoStandardLoggingModelCostFailureDebugInformation成本跟踪失败时的调试信息
statusStandardLoggingPayloadStatus载荷状态
status_fieldsStandardLoggingPayloadStatusFields用于轻松过滤和分析的类型化状态字段
total_tokens整数Token 总数
prompt_tokens整数提示词 (prompt) token 数量
completion_tokens整数补全 (completion) token 数量
startTimefloat调用开始时间
endTimefloat调用结束时间
completionStartTimefloat流式请求的首字响应时间
response_timefloat总响应时间。如果为流式请求,则为首字响应时间
model_map_informationStandardLoggingModelInformation模型映射信息
model字符串请求中发送的模型名称
model_idOptional[str]所用部署的模型 ID
model_groupOptional[str]请求使用的 model_group
api_base字符串LLM API 基础 URL
metadataStandardLoggingMetadata元数据信息
cache_hitOptional[bool]是否命中缓存
cache_keyOptional[str]可选的缓存键
saved_cache_costfloat通过缓存节省的成本
request_tags列表请求标签列表
end_userOptional[str]可选的终端用户标识符
requester_ip_addressOptional[str]可选的请求者 IP 地址
messagesOptional[Union[str, list, dict]]请求中发送的消息
responseOptional[Union[str, list, dict]]LLM 响应
error_strOptional[str]可选的错误字符串
error_informationOptional[StandardLoggingPayloadErrorInformation]可选的错误信息
model_parametersdict模型参数
hidden_paramsStandardLoggingHiddenParams隐藏参数

成本明细

cost_breakdown 字段提供补全请求的详细成本明细,作为包含以下内容的 CostBreakdown 对象:

  • input_cost:输入/提示词 token 的成本,包括缓存创建 token
  • output_cost:输出/补全 token 的成本(如果适用,包括推理 token)
  • tool_usage_cost:内置工具使用成本(例如,网页搜索、代码解释器)
  • total_cost:输入 + 输出 + 工具使用的总成本

注意:此字段适用于所有调用类型。对于非补全调用,input_costoutput_cost 可能为 0。

总成本关系为:response_cost = cost_breakdown.total_cost

CostBreakdown 类型

class CostBreakdown(TypedDict, total=False):
input_cost: float # Cost of input/prompt tokens in USD
output_cost: float # Cost of output/completion tokens in USD (includes reasoning)
tool_usage_cost: float # Cost of built-in tools usage in USD
total_cost: float # Total cost in USD

StandardLoggingUserAPIKeyMetadata

字段类型描述
user_api_key_hashOptional[str]LiteLLM 虚拟密钥的哈希值
user_api_key_aliasOptional[str]API 密钥的别名
user_api_key_org_idOptional[str]与密钥关联的组织 ID
user_api_key_team_idOptional[str]与密钥关联的团队 ID
user_api_key_user_idOptional[str]与密钥关联的用户 ID
user_api_key_team_aliasOptional[str]与密钥关联的团队别名

StandardLoggingMetadata

继承自 StandardLoggingUserAPIKeyMetadata 并添加以下内容:

字段类型描述
spend_logs_metadataOptional[dict]用于支出日志的键值对
requester_ip_addressOptional[str]请求者的 IP 地址
requester_metadataOptional[dict]附加的请求者元数据
vector_store_request_metadataOptional[List[StandardLoggingVectorStoreRequest]]向量数据库请求元数据
requester_custom_headersDict[str, str]客户端发送到代理的任何自定义 (x-) 标头。
prompt_management_metadataOptional[StandardLoggingPromptManagementMetadata]提示词管理和版本控制元数据
mcp_tool_call_metadataOptional[StandardLoggingMCPToolCall]MCP(模型上下文协议)工具调用信息和成本跟踪
applied_guardrailsOptional[List[str]]已应用的安全护栏 (guardrail) 名称列表
usage_objectOptional[dict]来自 LLM 提供商的原始使用量对象
cold_storage_object_keyOptional[str]用于冷存储检索的 S3/GCS 对象键
guardrail_informationOptional[list[StandardLoggingGuardrailInformation]]安全护栏信息

StandardLoggingVectorStoreRequest

字段类型描述
vector_store_idOptional[str]向量数据库 ID
custom_llm_providerOptional[str]向量数据库关联的自定义 LLM 提供商(例如:bedrock, openai, anthropic)
queryOptional[str]向量数据库查询
vector_store_search_responseOptional[VectorStoreSearchResponse]OpenAI 格式的向量数据库搜索响应
start_timeOptional[float]向量数据库请求开始时间
end_timeOptional[float]向量数据库请求结束时间

StandardLoggingAdditionalHeaders

字段类型描述
x_ratelimit_limit_requests整数请求速率限制
x_ratelimit_limit_tokens整数Token 速率限制
x_ratelimit_remaining_requests整数剩余请求额度
x_ratelimit_remaining_tokens整数剩余 Token 额度

StandardLoggingHiddenParams

字段类型描述
model_idOptional[str]可选的模型 ID
cache_keyOptional[str]可选的缓存键
api_baseOptional[str]可选的 API 基础 URL
response_costOptional[str]可选的响应成本
additional_headersOptional[StandardLoggingAdditionalHeaders]附加标头
batch_modelsOptional[List[str]]仅针对批处理 API 设置。列出用于成本计算的模型
litellm_model_nameOptional[str]请求中发送的模型名称

StandardLoggingModelInformation

字段类型描述
model_map_key字符串模型映射键
model_map_valueOptional[ModelInfo]可选的模型信息

StandardLoggingModelCostFailureDebugInformation

字段类型描述
error_str字符串错误字符串
traceback_str字符串回溯字符串
model字符串模型名称
cache_hitOptional[bool]是否命中缓存
custom_llm_providerOptional[str]可选的自定义 LLM 提供商
base_modelOptional[str]可选的基础模型
call_type字符串调用类型
custom_pricingOptional[bool]是否使用了自定义定价

StandardLoggingPayloadErrorInformation

字段类型描述
error_codeOptional[str]可选的错误代码(例如 "429")
error_classOptional[str]可选的错误类(例如 "RateLimitError")
llm_providerOptional[str]返回错误的 LLM 提供商(例如 "openai")

StandardLoggingPayloadStatus

具有两个可能值的字面量类型

  • "success"
  • "failure"

StandardLoggingGuardrailInformation

字段类型描述
guardrail_nameOptional[str]安全护栏名称
guardrail_providerOptional[str]安全护栏提供商
guardrail_modeOptional[Union[GuardrailEventHooks, List[GuardrailEventHooks]]]安全护栏模式
guardrail_requestOptional[dict]安全护栏请求
guardrail_responseOptional[Union[dict, str, List[dict]]]安全护栏响应
guardrail_statusLiteral["success", "guardrail_intervened", "guardrail_failed_to_respond"]安全护栏执行状态:success = 未检测到违规,blocked = 因策略违规导致内容被拦截/修改,failure = 技术错误或 API 失败
start_timeOptional[float]安全护栏开始时间
end_timeOptional[float]安全护栏结束时间
durationOptional[float]安全护栏持续时间(秒)
masked_entity_countOptional[Dict[str, int]]掩码实体计数

StandardLoggingPayloadStatusFields

用于轻松过滤和分析的类型化状态字段。

字段类型描述
llm_api_statusStandardLoggingPayloadStatusLLM API 调用状态:"success" 表示成功完成,"failure" 表示报错
guardrail_statusGuardrailStatus安全护栏执行状态(见下文)

StandardLoggingPayloadStatus

具有两个可能值的字面量类型

  • "success" - LLM API 请求成功完成
  • "failure" - LLM API 请求失败

GuardrailStatus

具有四个可能值的字面量类型

  • "success" - 安全护栏已运行并允许内容通过(未检测到违规)
  • "guardrail_intervened" - 安全护栏因策略违规拦截或修改了内容
  • "guardrail_failed_to_respond" - 安全护栏发生技术故障或 API 错误
  • "not_run" - 此请求未运行安全护栏

使用示例

过滤安全护栏介入的请求日志

{
"status_fields": {
"guardrail_status": "guardrail_intervened"
}
}

查找安全护栏技术故障

{
"status_fields": {
"guardrail_status": "guardrail_failed_to_respond"
}
}

获取成功的 LLM 请求

{
"status_fields": {
"llm_api_status": "success"
}
}

查找安全护栏成功运行且未介入的请求

{
"status_fields": {
"guardrail_status": "success",
"llm_api_status": "success"
}
}

查找未运行安全护栏的请求

{
"status_fields": {
"guardrail_status": "not_run"
}
}

StandardLoggingPromptManagementMetadata

用于跟踪提示词版本控制和管理信息。

字段类型描述
prompt_id字符串必填。提示词模板或版本的唯一标识符
prompt_variablesOptional[dict]提示词模板中使用的变量/参数(例如:{"user_name": "John", "context": "support"}
prompt_integration字符串必填。管理提示词的集成或系统(例如:"langfuse", "promptlayer", "custom"

StandardLoggingMCPToolCall

用于跟踪 LiteLLM 请求中的模型上下文协议 (MCP) 工具调用。这为外部工具集成提供了详细的日志记录。

字段类型描述
name字符串必填。正在调用的工具名称(例如:"get_weather", "search_database"
argumentsdict必填。作为键值对传递给工具的参数
resultOptional[dict]工具执行返回的响应/结果(由自定义日志记录钩子填充)
mcp_server_nameOptional[str]处理工具调用的 MCP 服务器名称(例如:"weather-service", "database-connector"
mcp_server_logo_urlOptional[str]MCP 服务器 Logo 的 URL(用于 LiteLLM 仪表板的 UI 显示)
namespaced_tool_nameOptional[str]包含服务器前缀的完全限定工具名称(例如:"deepwiki-mcp/get_page_content", "github-mcp/create_issue"
mcp_server_cost_infoOptional[MCPServerCostInfo]工具调用的成本跟踪信息

MCPServerCostInfo

MCP 服务器工具调用的成本跟踪结构

字段类型描述
default_cost_per_queryOptional[float]对此 MCP 服务器的任何工具调用的默认美元成本
tool_name_to_cost_per_queryOptional[Dict[str, float]]用于精细定价的每工具成本映射(例如:{"search": 0.01, "create": 0.05}

用法

# Basic MCP tool call metadata
mcp_tool_call = {
"name": "search_documents",
"arguments": {
"query": "machine learning tutorials",
"limit": 10,
"filter": "type:pdf"
},
"mcp_server_name": "document-search-service",
"namespaced_tool_name": "docs-mcp/search_documents",
"mcp_server_cost_info": {
"default_cost_per_query": 0.02,
"tool_name_to_cost_per_query": {
"search_documents": 0.02,
"get_document": 0.01
}
}
}

# optional result field (via custom logging hooks)
mcp_tool_call_with_result = {
"name": "search_documents",
"arguments": {
"query": "machine learning tutorials",
"limit": 10,
"filter": "type:pdf"
},
"result": {
"documents": [...],
"total_found": 42,
"search_time_ms": 150
},
"mcp_server_name": "document-search-service",
"namespaced_tool_name": "docs-mcp/search_documents",
"mcp_server_cost_info": {
"default_cost_per_query": 0.02,
"tool_name_to_cost_per_query": {
"search_documents": 0.02,
"get_document": 0.01
}
}
}