xpander SDK
Console Login

Java SDK

API Reference

Classes

ToolResponse

Initializers 

import ai.xpander.sdk.ToolResponse;

new ToolResponse(java.lang.String toolCallId, java.lang.String role, java.lang.String name, java.lang.String responseMessage, com.fasterxml.jackson.databind.node.ObjectNode filteredTool);,new ToolResponse(java.lang.String toolCallId, java.lang.String role, java.lang.String name, java.lang.String responseMessage, com.fasterxml.jackson.databind.node.ObjectNode filteredTool, java.lang.String payloadProperty1);,new ToolResponse(java.lang.String toolCallId, java.lang.String role, java.lang.String name, java.lang.String responseMessage, com.fasterxml.jackson.databind.node.ObjectNode filteredTool, java.lang.String payloadProperty1, java.lang.Number payloadProperty2);
Name Type Description
toolCallId java.lang.String No description.
role java.lang.String No description.
name java.lang.String No description.
responseMessage java.lang.String No description.
filteredTool com.fasterxml.jackson.databind.node.ObjectNode No description.
payloadProperty1 java.lang.String No description.
payloadProperty2 java.lang.Number No description.
toolCallIdRequired
  • Type: java.lang.String
roleRequired
  • Type: java.lang.String
nameRequired
  • Type: java.lang.String
responseMessageRequired
  • Type: java.lang.String
filteredToolRequired
  • Type: com.fasterxml.jackson.databind.node.ObjectNode
payloadProperty1Optional
  • Type: java.lang.String
payloadProperty2Optional
  • Type: java.lang.Number

Methods

Name Description
buildMessage No description.
toJSON No description.
buildMessage 
public java.lang.String buildMessage()
toJSON 
public com.fasterxml.jackson.databind.node.ObjectNode toJSON()

Static Functions

Name Description
fromJSON No description.
fromJSON 
import ai.xpander.sdk.ToolResponse;

ToolResponse.fromJSON(java.lang.Object json)
jsonRequired
  • Type: java.lang.Object

Properties

Name Type Description
filteredTool com.fasterxml.jackson.databind.node.ObjectNode No description.
name java.lang.String No description.
responseMessage java.lang.String No description.
role java.lang.String No description.
toolCallId java.lang.String No description.
payloadProperty1 java.lang.String No description.
payloadProperty2 java.lang.Number No description.
filteredToolRequired 
public com.fasterxml.jackson.databind.node.ObjectNode getFilteredTool();
  • Type: com.fasterxml.jackson.databind.node.ObjectNode
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
responseMessageRequired 
public java.lang.String getResponseMessage();
  • Type: java.lang.String
roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String
toolCallIdRequired 
public java.lang.String getToolCallId();
  • Type: java.lang.String
payloadProperty1Optional 
public java.lang.String getPayloadProperty1();
  • Type: java.lang.String
payloadProperty2Optional 
public java.lang.Number getPayloadProperty2();
  • Type: java.lang.Number

XpanderClient

Initializers 

import ai.xpander.sdk.XpanderClient;

new XpanderClient(java.lang.String agentKey, java.lang.String agentUrl, java.lang.String llmProvider);
Name Type Description
agentKey java.lang.String No description.
agentUrl java.lang.String No description.
llmProvider java.lang.String No description.
agentKeyRequired
  • Type: java.lang.String
agentUrlRequired
  • Type: java.lang.String
llmProviderRequired
  • Type: java.lang.String

Methods

Name Description
loadXpanderTools No description.
tools No description.
xpanderToolCall No description.
loadXpanderTools 
public java.util.List<java.lang.Object> loadXpanderTools()
tools 
public java.lang.Object tools()
public java.lang.Object tools(java.lang.String llmProvider)
llmProviderOptional
  • Type: java.lang.String
xpanderToolCall 
public java.util.List<ToolResponse> xpanderToolCall(java.lang.Object toolSelectorResponse)
public java.util.List<ToolResponse> xpanderToolCall(java.lang.Object toolSelectorResponse, java.lang.String llmProvider)
toolSelectorResponseRequired
  • Type: java.lang.Object
llmProviderOptional
  • Type: java.lang.String

Properties

Name Type Description
validProviders java.util.List No description.
agentKey java.lang.String No description.
agentUrl java.lang.String No description.
toolsCache java.lang.Object No description.
validProvidersRequired 
public java.util.List<java.lang.String> getValidProviders();
  • Type: java.util.List
agentKeyRequired 
public java.lang.String getAgentKey();
  • Type: java.lang.String
agentUrlRequired 
public java.lang.String getAgentUrl();
  • Type: java.lang.String
toolsCacheRequired 
public java.lang.Object getToolsCache();
  • Type: java.lang.Object

Protocols

IToolResponse

Properties

Name Type Description
filteredTool com.fasterxml.jackson.databind.node.ObjectNode No description.
name java.lang.String No description.
responseMessage java.lang.String No description.
role java.lang.String No description.
toolCallId java.lang.String No description.
payloadProperty1 java.lang.String No description.
payloadProperty2 java.lang.Number No description.
filteredToolRequired 
public com.fasterxml.jackson.databind.node.ObjectNode getFilteredTool();
  • Type: com.fasterxml.jackson.databind.node.ObjectNode
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
responseMessageRequired 
public java.lang.String getResponseMessage();
  • Type: java.lang.String
roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String
toolCallIdRequired 
public java.lang.String getToolCallId();
  • Type: java.lang.String
payloadProperty1Optional 
public java.lang.String getPayloadProperty1();
  • Type: java.lang.String
payloadProperty2Optional 
public java.lang.Number getPayloadProperty2();
  • Type: java.lang.Number

IToolResponsePayload

Properties

Name Type Description
property1 java.lang.String No description.
property2 java.lang.Number No description.
property1Required 
public java.lang.String getProperty1();
  • Type: java.lang.String
property2Required 
public java.lang.Number getProperty2();
  • Type: java.lang.Number

Enums

LLMProvider

Enum representing different Large Language Model (LLM) providers.

Members

Name Description
OPEN_AI Represents the 'openai' provider.
OPEN_AI

Represents the 'openai' provider.