Send AI question request
Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
Request
Request Body
The AI agent used to handle queries.
The items to be processed by the LLM, often files.
Note: Box AI handles documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first.
If the file size exceeds 1MB, the first 1MB of text representation will be processed.
If you set mode parameter to single_item_qa, the items array can have one element only.
"123"The id of the item.
"file"The type of the item.
Value is always file
"This is file content."The content of the item, often the text representation.
"multiple_item_qa"The mode specifies if this request is for a single or multiple items. If you select single_item_qa the items array can have one element only. Selecting multiple_item_qa allows you to provide up to 25 items.
Value is one of multiple_item_qa,single_item_qa
"What is the value provided by public APIs based on this document?"The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.
Response
A successful response including the answer from the LLM.
An unexpected client error.
An unexpected server error.
Request Example
curl -i -L POST "https://api.box.com/2.0/ai/ask" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"mode": "single_item_qa",
"prompt": "What is the value provided by public APIs based on this document?",
"items": [
{
"type": "file",
"id": "9842787262"
}
]
}'await client.ai.createAiAsk({
mode: 'multiple_item_qa' as AiAskModeField,
prompt: 'Which direction sun rises?',
items: [
new AiAskItemsField({
id: fileToAsk1.id,
type: 'file' as AiAskItemsTypeField,
content: 'Earth goes around the sun',
}),
new AiAskItemsField({
id: fileToAsk2.id,
type: 'file' as AiAskItemsTypeField,
content: 'Sun rises in the East in the morning',
}),
],
} satisfies AiAsk);client.ai.create_ai_ask(
CreateAiAskMode.MULTIPLE_ITEM_QA.value,
"Which direction sun rises?",
[
CreateAiAskItems(
id=file_to_ask_1.id,
type=CreateAiAskItemsTypeField.FILE.value,
content="Earth goes around the sun",
),
CreateAiAskItems(
id=file_to_ask_2.id,
type=CreateAiAskItemsTypeField.FILE.value,
content="Sun rises in the East in the morning",
),
],
)await client.Ai.CreateAiAskAsync(requestBody: new AiAsk(mode: AiAskModeField.MultipleItemQa, prompt: "Which direction sun rises?", items: Array.AsReadOnly(new [] {new AiAskItemsField(id: fileToAsk1.Id, type: AiAskItemsTypeField.File) { Content = "Earth goes around the sun" },new AiAskItemsField(id: fileToAsk2.Id, type: AiAskItemsTypeField.File) { Content = "Sun rises in the East in the morning" }})));BoxAIResponse response = BoxAI.sendAIRequest(
api,
"What is the content of the file?",
Collections.singletonList("123456", BoxAIItem.Type.FILE)),
BoxAI.Mode.SINGLE_ITEM_QA
);items = [{
"id": "1582915952443",
"type": "file",
"content": "More information about public APIs"
}]
answer = client.send_ai_question(
items=items,
prompt="What is this file?",
mode="single_item_qa"
)
print(answer)client.ai.ask(
{
prompt: 'What is the capital of France?',
items: [
{
type: 'file',
id: '12345'
}
],
mode: 'single_item_qa'
})
.then(response => {
/* response -> {
"answer": "Paris",
"created_at": "2021-10-01T00:00:00Z",
"completion_reason": "done"
} */
});Response Example
{
"answer": "Public APIs are important because of key and important reasons.",
"completion_reason": "done",
"created_at": "2012-12-12T10:53:43-08:00"
}