AS AgentScopeAPI 手册 / API Reference

WebSocketRequest

public final class WebSocketRequest
源码Source io/agentscope/core/model/transport/websocket/WebSocketRequest.java:37–139

WebSocket 请求,与模型服务通信并返回生成或向量化结果。位于 io.agentscope.core.model.transport.websocket 包。核心成员包括 getUrl、getHeaders、getConnectTimeout、builder。

WebSocket connection request configuration.

Usage example:

`WebSocketRequest request = WebSocketRequest.builder("wss://api.openai.com/v1/realtime")
.header("Authorization", "Bearer " + apiKey)
.header("OpenAI-Beta", "realtime=v1")
.connectTimeout(Duration.ofSeconds(30))
.build();
`

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
Builder类class
WebSocketRequest的构建器。
Builder for WebSocketRequest.

方法摘要Method Summary

方法Method说明Description
public String getUrl()
获取WebSocket URL。
Get the WebSocket URL.
public Map<String, String> getHeaders()
获取请求请求头。
Get the request headers.
public Duration getConnectTimeout()
获取连接超时。
Get the connection timeout.
public static Builder builder(String url)
static
返回构建器实例。
Create a new builder with the specified URL.

方法详情Method Detail

getUrl

public String getUrl()

获取WebSocket URL。

Get the WebSocket URL.

返回Returns String
返回字符串结果。WebSocket URL
源码Source io/agentscope/core/model/transport/websocket/WebSocketRequest.java:54–56

getHeaders

public Map<String, String> getHeaders()

获取请求请求头。

Get the request headers.

返回Returns Map<String, String>
返回映射。Request headers (immutable)
源码Source io/agentscope/core/model/transport/websocket/WebSocketRequest.java:63–65

getConnectTimeout

public Duration getConnectTimeout()

获取连接超时。

Get the connection timeout.

返回Returns Duration
返回时长。Connection timeout
源码Source io/agentscope/core/model/transport/websocket/WebSocketRequest.java:72–74

builder

public static Builder builder(String url)
static

返回构建器实例。

Create a new builder with the specified URL.

参数Parameters
名称Name类型Type说明Description
urlString服务地址(类型 `String`)。WebSocket URL
返回Returns Builder
返回当前实例,以支持链式调用。Builder instance
源码Source io/agentscope/core/model/transport/websocket/WebSocketRequest.java:82–84

嵌套类详情Nested Class Detail

Builder

public static class Builder

WebSocketRequest的构建器。位于 io.agentscope.core.model.transport.websocket 包。核心成员包括 header、headers、connectTimeout、build。

Builder for WebSocketRequest.

基于官方固定版本源码静态生成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.