AS AgentScopeAPI 手册 / API Reference

ChatCompletionsWebAutoConfiguration

@AutoConfiguration @EnableConfigurationProperties(ChatCompletionsProperties.class) @ConditionalOnProperty( prefix = "agentscope.chat-completions", name = "enabled", havingValue = "true", matchIfMissing = true) @ConditionalOnClass(ReActAgent.class) public class ChatCompletionsWebAutoConfiguration
源码Source io/agentscope/spring/boot/chat/config/ChatCompletionsWebAutoConfiguration.java:53–150

聊天补全 Web Auto 配置,保存相关配置项。位于 io.agentscope.spring.boot.chat.config 包。核心成员包括 chatMessageConverter、openAIToolConverter、chatCompletionsResponseBuilder、chatCompletionsStreamingAdapter、chatCompletionsStreamingService、chatCompletionsController。

Auto-configuration for exposing a Chat Completions style HTTP API.

This configuration assumes that the core agentscope-spring-boot-starter is already on the classpath and has configured a prototype-scoped ReActAgent bean.

Stateless API Design:

This API is 100% stateless, fully compatible with OpenAI's Chat Completions API:

  • Each request is independent - no server-side state

  • Client sends complete conversation history in messages

  • Server creates a fresh agent, processes messages, and returns response

  • Client appends response to their history for next request

For clients that need server-side session management, consider using a different API design pattern such as the OpenAI Assistants API or implementing session management in a higher layer.

方法摘要Method Summary

方法Method说明Description
public ChatMessageConverter chatMessageConverter()
返回聊天消息转换器。
Create the message converter bean.
public OpenAIToolConverter openAIToolConverter()
打开AI 工具转换器。
Create the OpenAI tool converter bean.
public ChatCompletionsResponseBuilder chatCompletionsResponseBuilder()
返回聊天补全响应构建器。
Create the response builder bean.
public ChatCompletionsStreamingAdapter chatCompletionsStreamingAdapter()
返回聊天补全流式适配器。
Create the streaming adapter bean.
public ChatCompletionsStreamingService chatCompletionsStreamingService(ChatCompletionsStreamingAdapter streamingAdapter)
设置聊天补全流式服务。
Create the streaming service bean.
public ChatCompletionsController chatCompletionsController(ObjectProvider<ReActAgent> agentProvider, ChatMessageConverter messageConverter, ChatCompletionsResponseBuilder responseBuilder, ChatCompletionsStreamingService streamingService, OpenAIToolConverter toolConverter)
执行聊天补全控制器相关操作。
Create the chat completions controller bean.

方法详情Method Detail

chatMessageConverter

public ChatMessageConverter chatMessageConverter()

返回聊天消息转换器。

Create the message converter bean.

返回Returns ChatMessageConverter
返回ChatMessageConverter。A new `ChatMessageConverter` instance for converting HTTP DTOs to framework messages
源码Source io/agentscope/spring/boot/chat/config/ChatCompletionsWebAutoConfiguration.java:69–73

openAIToolConverter

public OpenAIToolConverter openAIToolConverter()

打开AI 工具转换器。

Create the OpenAI tool converter bean.

返回Returns OpenAIToolConverter
返回OpenAIToolConverter。A new `OpenAIToolConverter` instance for converting OpenAI tools to ToolSchema
源码Source io/agentscope/spring/boot/chat/config/ChatCompletionsWebAutoConfiguration.java:80–84

chatCompletionsResponseBuilder

public ChatCompletionsResponseBuilder chatCompletionsResponseBuilder()

返回聊天补全响应构建器。

Create the response builder bean.

返回Returns ChatCompletionsResponseBuilder
返回ChatCompletionsResponseBuilder。A new `ChatCompletionsResponseBuilder` instance for building chat completion responses
源码Source io/agentscope/spring/boot/chat/config/ChatCompletionsWebAutoConfiguration.java:92–96

chatCompletionsStreamingAdapter

public ChatCompletionsStreamingAdapter chatCompletionsStreamingAdapter()

返回聊天补全流式适配器。

Create the streaming adapter bean.

返回Returns ChatCompletionsStreamingAdapter
一种新的`ChatCompletionsStreamingAdapter`实例。A new `ChatCompletionsStreamingAdapter` instance
源码Source io/agentscope/spring/boot/chat/config/ChatCompletionsWebAutoConfiguration.java:105–109

chatCompletionsStreamingService

public ChatCompletionsStreamingService chatCompletionsStreamingService(ChatCompletionsStreamingAdapter streamingAdapter)

设置聊天补全流式服务。

Create the streaming service bean.

参数Parameters
名称Name类型Type说明Description
streamingAdapterChatCompletionsStreamingAdapter流式适配器(类型 `ChatCompletionsStreamingAdapter`)。The framework-agnostic streaming adapter
返回Returns ChatCompletionsStreamingService
一种新的`ChatCompletionsStreamingService`实例。A new `ChatCompletionsStreamingService` instance
源码Source io/agentscope/spring/boot/chat/config/ChatCompletionsWebAutoConfiguration.java:119–124

chatCompletionsController

public ChatCompletionsController chatCompletionsController(ObjectProvider<ReActAgent> agentProvider, ChatMessageConverter messageConverter, ChatCompletionsResponseBuilder responseBuilder, ChatCompletionsStreamingService streamingService, OpenAIToolConverter toolConverter)

执行聊天补全控制器相关操作。

Create the chat completions controller bean.

参数Parameters
名称Name类型Type说明Description
agentProviderObjectProvider<ReActAgent>智能体提供者(类型 `ObjectProvider`)。Provider for creating prototype-scoped ReActAgent instances
messageConverterChatMessageConverter消息转换器(类型 `ChatMessageConverter`)。Converter for HTTP DTOs to framework messages
responseBuilderChatCompletionsResponseBuilder响应构建器(类型 `ChatCompletionsResponseBuilder`)。Builder for response objects
streamingServiceChatCompletionsStreamingService流式服务(类型 `ChatCompletionsStreamingService`)。Service for streaming responses
toolConverterOpenAIToolConverter用于OpenAI 工具到 ToolSchema的转换器。Converter for OpenAI tools to ToolSchema
返回Returns ChatCompletionsController
返回ChatCompletionsController。The configured ChatCompletionsController bean
源码Source io/agentscope/spring/boot/chat/config/ChatCompletionsWebAutoConfiguration.java:139–149
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.