AiExtract (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - AiExtract

All Implemented Interfaces:

Serializable
```
public class AiExtract
extends SerializableObject
```
AI metadata freeform extraction request object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AiExtract.Builder

Field Summary

Fields
Modifier and Type	Field and Description
`protected AiExtractAgent`	`aiAgent`
`protected List<AiItemBase>`	`items` The items that LLM will process.
`protected String`	`prompt` The prompt provided to a Large Language Model (LLM) in the request.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected AiExtract(AiExtract.Builder builder)

AiExtract(String prompt, List<AiItemBase> items)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`AiExtractAgent`	`getAiAgent()`
`List<AiItemBase>`	`getItems()`
`String`	`getPrompt()`
`int`	`hashCode()`
`String`	`toString()`

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
- prompt
```
protected final String prompt
```
  The prompt provided to a Large Language Model (LLM) in the request. The prompt can be up to 10000 characters long and it can be an XML or a JSON schema.
- items
```
protected final List<AiItemBase> items
```
  The items that LLM will process. Currently, you can use files only.
- aiAgent
```
protected AiExtractAgent aiAgent
```

Constructor Detail

AiExtract

public AiExtract(String prompt,
                 List<AiItemBase> items)

AiExtract

protected AiExtract(AiExtract.Builder builder)

Method Detail

getPrompt
```
public String getPrompt()
```

getItems
```
public List<AiItemBase> getItems()
```

getAiAgent
```
public AiExtractAgent getAiAgent()
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object