com.box.sdkgen.managers.ai

Class AiManager

Object

AiManager

public class AiManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AiManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	AiManager()
protected	AiManager(AiManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
AiResponseFull	createAiAsk(AiAsk requestBody) Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
AiResponseFull	createAiAsk(AiAsk requestBody, CreateAiAskHeaders headers) Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
AiResponse	createAiExtract(AiExtract requestBody) Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
AiResponse	createAiExtract(AiExtract requestBody, CreateAiExtractHeaders headers) Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
AiExtractStructuredResponse	createAiExtractStructured(AiExtractStructured requestBody) Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
AiExtractStructuredResponse	createAiExtractStructured(AiExtractStructured requestBody, CreateAiExtractStructuredHeaders headers) Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
AiResponse	createAiTextGen(AiTextGen requestBody) Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.
AiResponse	createAiTextGen(AiTextGen requestBody, CreateAiTextGenHeaders headers) Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.
AiAgent	getAiAgentDefaultConfig(GetAiAgentDefaultConfigQueryParams queryParams) Get the AI agent default config.
AiAgent	getAiAgentDefaultConfig(GetAiAgentDefaultConfigQueryParams queryParams, GetAiAgentDefaultConfigHeaders headers) Get the AI agent default config.
Authentication	getAuth()
NetworkSession	getNetworkSession()

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

AiManager

public AiManager()

AiManager

protected AiManager(AiManager.Builder builder)

Method Detail

createAiAsk

public AiResponseFull createAiAsk(AiAsk requestBody)

Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.

Parameters:

requestBody - Request body of createAiAsk method

createAiAsk

public AiResponseFull createAiAsk(AiAsk requestBody,
                                  CreateAiAskHeaders headers)

Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.

Parameters:

requestBody - Request body of createAiAsk method

headers - Headers of createAiAsk method

createAiTextGen

public AiResponse createAiTextGen(AiTextGen requestBody)

Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.

Parameters:

requestBody - Request body of createAiTextGen method

createAiTextGen

public AiResponse createAiTextGen(AiTextGen requestBody,
                                  CreateAiTextGenHeaders headers)

Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.

Parameters:

requestBody - Request body of createAiTextGen method

headers - Headers of createAiTextGen method

getAiAgentDefaultConfig

public AiAgent getAiAgentDefaultConfig(GetAiAgentDefaultConfigQueryParams queryParams)

Get the AI agent default config.

Parameters:

queryParams - Query parameters of getAiAgentDefaultConfig method

getAiAgentDefaultConfig

public AiAgent getAiAgentDefaultConfig(GetAiAgentDefaultConfigQueryParams queryParams,
                                       GetAiAgentDefaultConfigHeaders headers)

Get the AI agent default config.

Parameters:

queryParams - Query parameters of getAiAgentDefaultConfig method

headers - Headers of getAiAgentDefaultConfig method

createAiExtract

public AiResponse createAiExtract(AiExtract requestBody)

Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. In this request, both the prompt and the output can be freeform. Metadata template setup before sending the request is not required.

Parameters:

requestBody - Request body of createAiExtract method

createAiExtract

public AiResponse createAiExtract(AiExtract requestBody,
                                  CreateAiExtractHeaders headers)

Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. In this request, both the prompt and the output can be freeform. Metadata template setup before sending the request is not required.

Parameters:

requestBody - Request body of createAiExtract method

headers - Headers of createAiExtract method

createAiExtractStructured

public AiExtractStructuredResponse createAiExtractStructured(AiExtractStructured requestBody)

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.

To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates) or use the [metadata template API](https://developer.box.com/guides/metadata/templates/create).

This endpoint also supports [Enhanced Extract Agent](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent).

For information about supported file formats and languages, see the [Extract metadata from file (structured)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured) API guide.

Parameters:

requestBody - Request body of createAiExtractStructured method

createAiExtractStructured

public AiExtractStructuredResponse createAiExtractStructured(AiExtractStructured requestBody,
                                                             CreateAiExtractStructuredHeaders headers)

Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.

To define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates) or use the [metadata template API](https://developer.box.com/guides/metadata/templates/create).

This endpoint also supports [Enhanced Extract Agent](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent).

For information about supported file formats and languages, see the [Extract metadata from file (structured)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured) API guide.

Parameters:

requestBody - Request body of createAiExtractStructured method

headers - Headers of createAiExtractStructured method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()