此版本仍在开发中，尚未被视为稳定版本。最新的快照版本请使用 Spring AI 1.0.0-SNAPSHOT！spring-doc.cn

可观察性

Spring AI 基于 Spring 生态系统中的可观察性功能构建，以提供对 AI 相关操作的见解。 Spring AI 为其核心组件提供指标和跟踪功能：（包括 ）、、 、 和 。ChatClientAdvisorChatModelEmbeddingModelImageModelVectorStorespring-doc.cn

低基数键将添加到指标和跟踪中，而高基数键将仅添加到跟踪中。

聊天客户端

调用 ChatClient 或操作时，将记录观察结果。 它们测量执行调用所花费的时间并传播相关的跟踪信息。spring.ai.chat.clientcall()stream()spring-doc.cn

表 1.低基数键
名字 描述

gen_ai.operation.namespring-doc.cn

总是。frameworkspring-doc.cn

gen_ai.systemspring-doc.cn

总是。spring_aispring-doc.cn

spring.ai.chat.client.streamspring-doc.cn

聊天模型响应是流吗 -true or falsespring-doc.cn

spring.ai.kindspring-doc.cn

Spring AI 中的框架 API 类型： .chat_clientspring-doc.cn
表 2.高基数键
名字 描述

spring.ai.chat.client.advisor.paramsspring-doc.cn

advisor 参数映射。spring-doc.cn

spring.ai.chat.client.advisorsspring-doc.cn

已配置的聊天客户端顾问列表。spring-doc.cn

spring.ai.chat.client.system.paramsspring-doc.cn

Chat 客户端系统参数。自选。spring-doc.cn

spring.ai.chat.client.system.textspring-doc.cn

Chat 客户端系统文本。自选。spring-doc.cn

spring.ai.chat.client.tool.function.namesspring-doc.cn

启用工具函数名称。spring-doc.cn

spring.ai.chat.client.tool.function.callbacksspring-doc.cn

已配置的聊天客户端函数回调列表。spring-doc.cn

spring.ai.chat.client.user.paramsspring-doc.cn

Chat 客户端用户参数。自选。spring-doc.cn

spring.ai.chat.client.user.textspring-doc.cn

Chat 客户端用户文本。自选。spring-doc.cn

输入数据

输入数据通常很大，并且可能包含敏感信息。 由于这些原因，默认情况下不会导出它。ChatClientspring-doc.cn

Spring AI 支持跨所有跟踪后端将 Importing 数据导出为 span 属性。spring-doc.cn

财产 描述 违约

spring.ai.chat.client.observations.include-inputspring-doc.cn

是否在观察中包括输入内容。spring-doc.cn

falsespring-doc.cn
如果允许在观察中包含输入内容，则存在暴露敏感或私人信息的风险。请小心！

聊天客户顾问

当执行 advisor 的调用或流时，将记录观察结果。 它们测量在 advisor 中花费的时间（包括在内部 advisor 上花费的时间）并传播相关的跟踪信息。spring.ai.advisorspring-doc.cn

表 3.低基数键
名字 描述

gen_ai.operation.namespring-doc.cn

总是。frameworkspring-doc.cn

gen_ai.systemspring-doc.cn

总是。spring_aispring-doc.cn

spring.ai.advisor.typespring-doc.cn

如果 advisor 在请求处理中应用其逻辑，则 、 或 .BEFOREAFTERAROUNDspring-doc.cn

spring.ai.kindspring-doc.cn

Spring AI 中的框架 API 类型： .advisorspring-doc.cn
表 4.高基数键
名字 描述

spring.ai.advisor.namespring-doc.cn

顾问的姓名。spring-doc.cn

spring.ai.advisor.orderspring-doc.cn

顾问链中的 advisor 订单。spring-doc.cn

聊天模型

目前，只有以下 AI 模型的实现支持可观测性功能 提供商：Anthropic、Azure OpenAI、Mistral AI、Ollama、OpenAI、Vertex AI、MiniMax、Moonshot、QianFan、Zhiu AI。 未来版本将支持其他 AI 模型提供程序。ChatModel

在调用 ChatModel 或方法时记录观察结果。 它们测量方法完成所花费的时间并传播相关的跟踪信息。gen_ai.client.operationcallstreamspring-doc.cn

该指标衡量单个模型调用使用的输入和输出令牌的数量。gen_ai.client.token.usage
表 5.低基数键
名字 描述

gen_ai.operation.namespring-doc.cn

正在执行的操作的名称。spring-doc.cn

gen_ai.systemspring-doc.cn

由客户端检测标识的模型提供程序。spring-doc.cn

gen_ai.request.modelspring-doc.cn

要向其发出请求的模型的名称。spring-doc.cn

gen_ai.response.modelspring-doc.cn

生成响应的模型的名称。spring-doc.cn
表 6.高基数键
名字 描述

gen_ai.request.frequency_penaltyspring-doc.cn

模型请求的频率损失设置。spring-doc.cn

gen_ai.request.max_tokensspring-doc.cn

模型为请求生成的最大令牌数。spring-doc.cn

gen_ai.request.presence_penaltyspring-doc.cn

模型请求的存在惩罚设置。spring-doc.cn

gen_ai.request.stop_sequencesspring-doc.cn

模型将用于停止生成更多标记的序列列表。spring-doc.cn

gen_ai.request.temperaturespring-doc.cn

模型请求的温度设置。spring-doc.cn

gen_ai.request.top_kspring-doc.cn

模型请求的 top_k 采样设置。spring-doc.cn

gen_ai.request.top_pspring-doc.cn

模型请求的 top_p 采样设置。spring-doc.cn

gen_ai.response.finish_reasonsspring-doc.cn

模型停止生成令牌的原因，对应于收到的每一代。spring-doc.cn

gen_ai.response.idspring-doc.cn

AI 响应的唯一标识符。spring-doc.cn

gen_ai.usage.input_tokensspring-doc.cn

模型输入 （prompt） 中使用的标记数。spring-doc.cn

gen_ai.usage.output_tokensspring-doc.cn

模型输出 （completion） 中使用的标记数。spring-doc.cn

gen_ai.usage.total_tokensspring-doc.cn

模型交换中使用的代币总数。spring-doc.cn

gen_ai.promptspring-doc.cn

发送到模型的完整提示。自选。spring-doc.cn

gen_ai.completionspring-doc.cn

从模型收到的完整响应。自选。spring-doc.cn
对于测量用户令牌，上表列出了观察跟踪中存在的值。 使用 .gen_ai.client.token.usageChatModel
表 7.事件
名字 描述

gen_ai.content.promptspring-doc.cn

事件，包括聊天提示的内容。自选。spring-doc.cn

gen_ai.content.completionspring-doc.cn

事件，包括聊天完成的内容。自选。spring-doc.cn

聊天提示和完成数据

聊天提示和完成数据通常很大，并且可能包含敏感信息。 由于这些原因，默认情况下不会导出它。spring-doc.cn

Spring AI 支持将聊天提示和完成数据导出为 span 事件（如果您使用 OpenTelemetry 跟踪后端）， 而如果您使用 OpenZipkin 跟踪后端，则数据将导出为 span 属性。spring-doc.cn

此外，Spring AI 支持记录聊天提示和完成数据，这对于故障排除场景非常有用。spring-doc.cn

财产 描述 违约

spring.ai.chat.observations.include-promptspring-doc.cn

在观察中包括提示内容。 或truefalsespring-doc.cn

falsespring-doc.cn

spring.ai.chat.observations.include-completionspring-doc.cn

在观察任务中包括完成内容。 或truefalsespring-doc.cn

falsespring-doc.cn

spring.ai.chat.observations.include-error-loggingspring-doc.cn

在观测中包括错误记录。 或truefalsespring-doc.cn

falsespring-doc.cn
如果您在观察中启用聊天提示和完成数据，则存在暴露敏感或私人信息的风险。请小心！

EmbeddingModel

目前，只有以下实现支持可观测性功能 AI 模型提供商：Azure OpenAI、Mistral AI、Ollama 和 OpenAI。 未来版本将支持其他 AI 模型提供程序。EmbeddingModel

观察结果记录在嵌入模型方法调用时。 它们测量方法完成所花费的时间并传播相关的跟踪信息。gen_ai.client.operationspring-doc.cn

该指标衡量单个模型调用使用的输入和输出令牌的数量。gen_ai.client.token.usage
表 8.低基数键
名字 描述

gen_ai.operation.namespring-doc.cn

正在执行的操作的名称。spring-doc.cn

gen_ai.systemspring-doc.cn

由客户端检测标识的模型提供程序。spring-doc.cn

gen_ai.request.modelspring-doc.cn

要向其发出请求的模型的名称。spring-doc.cn

gen_ai.response.modelspring-doc.cn

生成响应的模型的名称。spring-doc.cn
表 9.高基数键
名字 描述

gen_ai.request.embedding.dimensionsspring-doc.cn

生成的输出嵌入具有的维度数。spring-doc.cn

gen_ai.usage.input_tokensspring-doc.cn

模型输入中使用的标记数。spring-doc.cn

gen_ai.usage.total_tokensspring-doc.cn

模型交换中使用的代币总数。spring-doc.cn
对于测量用户令牌，上表列出了观察跟踪中存在的值。 使用 .gen_ai.client.token.usageEmbeddingModel

图像模型

目前，只有以下 AI 模型的实现支持可观测性功能 提供商：OpenAI。 未来版本将支持其他 AI 模型提供程序。ImageModel

观察结果记录在图像模型方法调用中。 它们测量方法完成所花费的时间并传播相关的跟踪信息。gen_ai.client.operationspring-doc.cn

该指标衡量单个模型调用使用的输入和输出令牌的数量。gen_ai.client.token.usage
表 10.低基数键
名字 描述

gen_ai.operation.namespring-doc.cn

正在执行的操作的名称。spring-doc.cn

gen_ai.systemspring-doc.cn

由客户端检测标识的模型提供程序。spring-doc.cn

gen_ai.request.modelspring-doc.cn

要向其发出请求的模型的名称。spring-doc.cn
表 11.高基数键
名字 描述

gen_ai.request.image.response_formatspring-doc.cn

返回生成图像的格式。spring-doc.cn

gen_ai.request.image.sizespring-doc.cn

要生成的图像的大小。spring-doc.cn

gen_ai.request.image.stylespring-doc.cn

要生成的图像的样式。spring-doc.cn

gen_ai.response.idspring-doc.cn

AI 响应的唯一标识符。spring-doc.cn

gen_ai.response.modelspring-doc.cn

生成响应的模型的名称。spring-doc.cn

gen_ai.usage.input_tokensspring-doc.cn

模型输入 （prompt） 中使用的标记数。spring-doc.cn

gen_ai.usage.output_tokensspring-doc.cn

模型输出 （generation） 中使用的令牌数。spring-doc.cn

gen_ai.usage.total_tokensspring-doc.cn

模型交换中使用的代币总数。spring-doc.cn

gen_ai.promptspring-doc.cn

发送到模型的完整提示。自选。spring-doc.cn
对于测量用户令牌，上表列出了观察跟踪中存在的值。 使用 .gen_ai.client.token.usageImageModel
表 12.事件
名字 描述

gen_ai.content.promptspring-doc.cn

事件，包括图像提示的内容。自选。spring-doc.cn

图像提示数据

图像提示数据通常很大，并且可能包含敏感信息。 由于这些原因，默认情况下不会导出它。spring-doc.cn

Spring AI 支持将图像提示数据导出为 span 事件（如果您使用 OpenTelemetry 跟踪后端）， 而如果您使用 OpenZipkin 跟踪后端，则数据将导出为 span 属性。spring-doc.cn

财产 描述 违约

spring.ai.image.observations.include-promptspring-doc.cn

true或falsespring-doc.cn

falsespring-doc.cn
如果允许在观察中包括图像提示数据，则存在暴露敏感或私人信息的风险。请小心！

矢量存储

Spring AI 中的所有向量存储实现都经过检测，以通过 Micrometer 提供指标和分布式跟踪数据。spring-doc.cn

与 Vector Store 交互时，将记录观察结果。 它们测量在 和 操作上花费的时间，并传播相关的跟踪信息。db.vector.client.operationqueryaddremovespring-doc.cn

表 13.低基数键
名字 描述

db.operation.namespring-doc.cn

正在执行的操作或命令的名称。、 或 之一。adddeletequeryspring-doc.cn

db.systemspring-doc.cn

由客户端检测标识的数据库管理系统 （DBMS） 产品。其中之一 ， ， ， .pg_vectorazurecassandrachromaelasticsearchmilvusneo4jopensearchqdrantredistypesenseweaviatepineconeoraclemongodbgemfirehanasimplespring-doc.cn

spring.ai.kindspring-doc.cn

Spring AI 中的框架 API 类型： .vector_storespring-doc.cn
表 14.高基数键
名字 描述

db.collection.namespring-doc.cn

数据库中集合 （表、容器） 的名称。spring-doc.cn

db.namespacespring-doc.cn

数据库的名称，在服务器地址和端口中完全限定。spring-doc.cn

db.record.idspring-doc.cn

记录标识符（如果存在）。spring-doc.cn

db.search.similarity_metricspring-doc.cn

相似性搜索中使用的量度。spring-doc.cn

db.vector.dimension_countspring-doc.cn

向量的维度。spring-doc.cn

db.vector.field_namespring-doc.cn

作为向量的 name 字段（例如，字段名称）。spring-doc.cn

db.vector.query.contentspring-doc.cn

正在执行的搜索查询的内容。spring-doc.cn

db.vector.query.filterspring-doc.cn

搜索查询中使用的元数据筛选条件。spring-doc.cn

db.vector.query.response.documentsspring-doc.cn

从相似性搜索查询返回的文档。自选。spring-doc.cn

db.vector.query.similarity_thresholdspring-doc.cn

接受所有搜索分数的相似性阈值。阈值 0.0 表示接受任何相似性或禁用相似性阈值筛选。阈值 1.0 表示需要完全匹配。spring-doc.cn

db.vector.query.top_kspring-doc.cn

查询返回的前 k 个最相似的向量。spring-doc.cn
表 15.事件
名字 描述

db.vector.content.query.responsespring-doc.cn

事件，包括向量搜索响应数据。自选。spring-doc.cn

响应数据

向量搜索响应数据通常很大，并且可能包含敏感信息。 由于这些原因，默认情况下不会导出它。spring-doc.cn

Spring AI 支持将向量搜索响应数据导出为 span 事件（如果您使用 OpenTelemetry 跟踪后端）。 而如果您使用 OpenZipkin 跟踪后端，则数据将导出为 span 属性。spring-doc.cn

财产 描述 违约

spring.ai.vectorstore.observations.include-query-responsespring-doc.cn

true或falsespring-doc.cn

falsespring-doc.cn
如果允许在观察结果中包含向量搜索响应数据，则存在暴露敏感信息或私人信息的风险。请小心！