程序包 cn.tbox.sdk

类 TboxClient

java.lang.Object

cn.tbox.sdk.TboxClient

public class TboxClient
extends Object

Tbox client for making API requests.

构造器概要

构造器

构造器	说明
TboxClient(HttpClientConfig httpClientConfig)	Creates a new Tbox client.
TboxClient(String authorization)	Creates a new Tbox client with authorization.

方法概要

修饰符和类型	方法	说明
Iterable<Map<String,Object>>	chat(String appId, String query, String userId)	Makes a chat request to the Tbox API with default parameters.
Iterable<Map<String,Object>>	chat(String appId, String query, String userId, String conversationId, String requestId, Map<String,Object> inputs, boolean withMeta, MessageParser messageParser, Map<String,Object> clientProperties)	Makes a chat request to the Tbox API.
Map<String,Map<String,Object>>	chatSync(String appId, String query, String userId)	Makes a synchronous chat request to the Tbox API with default parameters.
Map<String,Map<String,Object>>	chatSync(String appId, String query, String userId, String conversationId, String requestId, Map<String,Object> inputs, Map<String,Object> clientProperties)	Makes a synchronous chat request to the Tbox API.
Iterable<Map<String,Object>>	completion(String appId, Map<String,Object> inputs, String userId)	Makes a completion request to the Tbox API with default parameters.
Iterable<Map<String,Object>>	completion(String appId, Map<String,Object> inputs, String userId, String conversationId, String requestId, boolean withMeta, MessageParser messageParser, Map<String,Object> clientProperties)	Makes a completion request to the Tbox API.
Map<String,Map<String,Object>>	completionSync(String appId, Map<String,Object> inputs, String userId)	Makes a synchronous completion request to the Tbox API with default parameters.
Map<String,Map<String,Object>>	completionSync(String appId, Map<String,Object> inputs, String userId, String conversationId, String requestId, Map<String,Object> clientProperties)	Makes a synchronous completion request to the Tbox API.
protected HttpClient	createHttpClient(HttpClientConfig config)	Creates the HTTP client instance.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

TboxClient

public TboxClient(HttpClientConfig httpClientConfig)
           throws TboxClientConfigException

Creates a new Tbox client.

参数:

httpClientConfig - HTTP client configuration

抛出:

TboxClientConfigException - if there's a configuration error

TboxClient

public TboxClient(String authorization)
           throws TboxClientConfigException

Creates a new Tbox client with authorization.

参数:

authorization - Authorization token

抛出:

TboxClientConfigException - if there's a configuration error

方法详细资料

createHttpClient

protected HttpClient createHttpClient(HttpClientConfig config)
                               throws TboxClientConfigException

Creates the HTTP client instance. This method is protected to allow mocking in tests.

参数:

config - HTTP client configuration

返回:

HTTP client instance

抛出:

TboxClientConfigException - if there's a configuration error

chat

public Iterable<Map<String,Object>> chat(String appId,
 String query,
 String userId,
 String conversationId,
 String requestId,
 Map<String,Object> inputs,
 boolean withMeta,
 MessageParser messageParser,
 Map<String,Object> clientProperties)
                                  throws TboxClientConfigException

Makes a chat request to the Tbox API. Used to call Tbox chat-type applications. Returns a unified streaming response format.

参数:

appId - Application ID

query - Query text

userId - User ID

conversationId - Conversation ID (optional)

requestId - Request ID (optional)

inputs - Input parameters (optional)

withMeta - Whether to include meta information (optional)

messageParser - Message parser (optional)

clientProperties - Client properties (optional)

返回:

Iterable of parsed responses

抛出:

TboxClientConfigException - if there's a configuration error

chat

public Iterable<Map<String,Object>> chat(String appId,
 String query,
 String userId)
                                  throws TboxClientConfigException

Makes a chat request to the Tbox API with default parameters.

参数:

appId - Application ID

query - Query text

userId - User ID

返回:

Iterable of parsed responses

抛出:

TboxClientConfigException - if there's a configuration error

chatSync

public Map<String,Map<String,Object>> chatSync(String appId,
 String query,
 String userId,
 String conversationId,
 String requestId,
 Map<String,Object> inputs,
 Map<String,Object> clientProperties)
                                        throws TboxClientConfigException

Makes a synchronous chat request to the Tbox API. Wraps the chat API into a synchronous interface.

参数:

appId - Application ID

query - Query text

userId - User ID

conversationId - Conversation ID (optional)

requestId - Request ID (optional)

inputs - Input parameters (optional)

clientProperties - Client properties (optional)

返回:

Map of response data

抛出:

TboxClientConfigException - if there's a configuration error

chatSync

public Map<String,Map<String,Object>> chatSync(String appId,
 String query,
 String userId)
                                        throws TboxClientConfigException

Makes a synchronous chat request to the Tbox API with default parameters.

参数:

appId - Application ID

query - Query text

userId - User ID

返回:

Map of response data

抛出:

TboxClientConfigException - if there's a configuration error

completion

public Iterable<Map<String,Object>> completion(String appId,
 Map<String,Object> inputs,
 String userId,
 String conversationId,
 String requestId,
 boolean withMeta,
 MessageParser messageParser,
 Map<String,Object> clientProperties)
                                        throws TboxClientConfigException

Makes a completion request to the Tbox API.

参数:

appId - Application ID

userId - User ID

inputs - Input parameters (optional)

conversationId - Conversation ID (optional)

requestId - Request ID (optional)

withMeta - Whether to include meta information (optional)

messageParser - Message parser (optional)

clientProperties - Client properties (optional)

返回:

Iterable of parsed responses

抛出:

TboxClientConfigException - if there's a configuration error

completion

public Iterable<Map<String,Object>> completion(String appId,
 Map<String,Object> inputs,
 String userId)
                                        throws TboxClientConfigException

Makes a completion request to the Tbox API with default parameters.

参数:

appId - Application ID

inputs - Input parameters

userId - User ID

返回:

Iterable of parsed responses

抛出:

TboxClientConfigException - if there's a configuration error

completionSync

public Map<String,Map<String,Object>> completionSync(String appId,
 Map<String,Object> inputs,
 String userId,
 String conversationId,
 String requestId,
 Map<String,Object> clientProperties)
                                              throws TboxClientConfigException

Makes a synchronous completion request to the Tbox API. Wraps the completion API into a synchronous interface.

参数:

appId - Application ID

inputs - Input parameters

userId - User ID

conversationId - Conversation ID (optional)

requestId - Request ID (optional)

clientProperties - Client properties (optional)

返回:

Map of response data

抛出:

TboxClientConfigException - if there's a configuration error

completionSync

public Map<String,Map<String,Object>> completionSync(String appId,
 Map<String,Object> inputs,
 String userId)
                                              throws TboxClientConfigException

Makes a synchronous completion request to the Tbox API with default parameters.

参数:

appId - Application ID

inputs - Input parameters

userId - User ID

返回:

Map of response data

抛出:

TboxClientConfigException - if there's a configuration error