AiAgentBasicTextTool (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - AiAgentBasicTextToolBase
    - - AiAgentBasicTextTool

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AiAgentLongTextTool, AiStudioAgentBasicTextTool
```
public class AiAgentBasicTextTool
extends AiAgentBasicTextToolBase
```
AI agent processor used to handle basic text.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AiAgentBasicTextTool.Builder

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`promptTemplate` The prompt template contains contextual information of the request and the user prompt.
`protected String`	`systemMessage` System messages try to help the LLM "understand" its role and what it is supposed to do.

Fields inherited from class AiAgentBasicTextToolBase
llmEndpointParams, model, numTokensForCompletion

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

AiAgentBasicTextTool()

protected AiAgentBasicTextTool(AiAgentBasicTextTool.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getPromptTemplate()`
`String`	`getSystemMessage()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class AiAgentBasicTextToolBase
getLlmEndpointParams, getModel, getNumTokensForCompletion

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - systemMessage
```
protected String systemMessage
```
    System messages try to help the LLM "understand" its role and what it is supposed to do.
  - promptTemplate
```
protected String promptTemplate
```
    The prompt template contains contextual information of the request and the user prompt. When passing `prompt_template` parameters, you **must include** inputs for `{user_question}` and `{content}`. `{current_date}` is optional, depending on the use.
- Constructor Detail
  - AiAgentBasicTextTool
```
public AiAgentBasicTextTool()
```
  - AiAgentBasicTextTool
```
protected AiAgentBasicTextTool(AiAgentBasicTextTool.Builder builder)
```
- Method Detail
  - getSystemMessage
```
public String getSystemMessage()
```
  - getPromptTemplate
```
public String getPromptTemplate()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class AiAgentBasicTextToolBase
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AiAgentBasicTextToolBase
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AiAgentBasicTextToolBase