Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
"@box/frontend": "^11.0.1",
"@box/item-icon": "^2.30.42",
"@box/languages": "^1.0.0",
"@box/metadata-editor": "^1.55.5",
"@box/metadata-editor": "^1.58.0",
"@box/metadata-filter": "^1.41.3",
"@box/metadata-view": "^1.10.0",
"@box/react-virtualized": "^9.22.3-rc-box.10",
Expand Down Expand Up @@ -297,7 +297,7 @@
"@box/combobox-with-api": "^1.41.42",
"@box/copy-input": "^1.39.41",
"@box/item-icon": "^2.30.42",
"@box/metadata-editor": "^1.55.5",
"@box/metadata-editor": "^1.58.0",
"@box/metadata-filter": "^1.41.3",
"@box/metadata-view": "^1.10.0",
"@box/react-virtualized": "^9.22.3-rc-box.10",
Expand Down
5 changes: 2 additions & 3 deletions src/api/Intelligence.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ class Intelligence extends Base {
throw new Error('Invalid item!');
}

// See: https://developer.box.com/reference/post-ai-extract-structured
const url = `${this.getBaseApiUrl()}/ai/extract_structured`;

const suggestionsResponse = await this.xhr.post({
Expand All @@ -85,9 +86,7 @@ class Intelligence extends Base {
id: `file_${item.id}`,
});

return !!suggestionsResponse?.data?.answer && typeof suggestionsResponse.data.answer === 'object'
? suggestionsResponse.data.answer
: suggestionsResponse.data;
return suggestionsResponse.data;
}
}

Expand Down
36 changes: 17 additions & 19 deletions src/api/__tests__/Intelligence.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,26 +124,24 @@ describe('api/Intelligence', () => {
}
});

test.each`
suggestionsFromServer | responseData
${{ stringFieldKey: 'fieldVal1', floatFieldKey: 124.0, enumFieldKey: 'EnumOptionKey', multiSelectFieldKey: ['multiSelectOption1', 'multiSelectOption5'] }} | ${{ data: { stringFieldKey: 'fieldVal1', floatFieldKey: 124.0, enumFieldKey: 'EnumOptionKey', multiSelectFieldKey: ['multiSelectOption1', 'multiSelectOption5'] } }}
${{ stringFieldKey: 'fieldVal1', floatFieldKey: 124.0, enumFieldKey: 'EnumOptionKey', multiSelectFieldKey: ['multiSelectOption1', 'multiSelectOption5'] }} | ${{ data: { answer: { stringFieldKey: 'fieldVal1', floatFieldKey: 124.0, enumFieldKey: 'EnumOptionKey', multiSelectFieldKey: ['multiSelectOption1', 'multiSelectOption5'] }, create_at: '2025-01-14T00:00:00-00:00' } }}
${{}} | ${{ data: {} }}
${{}} | ${{ data: { answer: {}, create_at: '2025-01-14T00:00:00-00:00' } }}
`(
'should return a successful response including the answer from the LLM',
async ({ suggestionsFromServer, responseData }) => {
intelligence.xhr.post = jest.fn().mockReturnValueOnce(responseData);
test('should return data as-is', async () => {
const responseData = {
data: {
answer: { field1: 'value1' },
created_at: '2026-03-27T08:10:14.106-07:00',
completion_reason: 'done',
},
};
intelligence.xhr.post = jest.fn().mockReturnValueOnce(responseData);

const suggestions = await intelligence.extractStructured(request);
expect(suggestions).toEqual(suggestionsFromServer);
expect(intelligence.xhr.post).toHaveBeenCalledWith({
url: `${intelligence.getBaseApiUrl()}/ai/extract_structured`,
id: 'file_123',
data: request,
});
},
);
const result = await intelligence.extractStructured(request);
expect(result).toEqual(responseData.data);
expect(intelligence.xhr.post).toHaveBeenCalledWith({
url: `${intelligence.getBaseApiUrl()}/ai/extract_structured`,
id: 'file_123',
data: request,
});
});

test('should not return any suggestions when error is 400', async () => {
const error = new Error();
Expand Down
35 changes: 34 additions & 1 deletion src/api/schemas/AiExtractResponse.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,37 @@
* @author Box
*/

export interface AiExtractResponse {}
export interface AiExtractConfidenceScore {
level: string;
score: number;
}

export interface AiExtractReference {
itemId: string;
page: number;
text: string;
boundingBox?: {
left: number,
top: number,
right: number,
bottom: number,
};
}

export interface AiAgentInfo {
models?: Array<{
name?: string,
provider?: string,
supported_purpose?: string,
}>;
processor?: string;
}

export interface AiExtractResponse {
answer: { [key: string]: any };
created_at: string;
completion_reason?: string;
confidence_score?: { [key: string]: AiExtractConfidenceScore };
reference?: { [key: string]: Array<AiExtractReference> };
ai_agent_info?: AiAgentInfo;
}
8 changes: 8 additions & 0 deletions src/api/schemas/AiExtractStructured.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,12 @@ export interface AiExtractStructured {
* – `AiAgentReference` : reference a custom AI-Agent by ID
*/
+ai_agent?: AiAgentExtractStructured | AiAgentReference;
/**
* When `true`, the response includes confidence scores for each extracted field.
*/
+include_confidence_score?: boolean;
/**
* When `true`, the response includes reference locations (bounding boxes) for each extracted field.
*/
+include_reference?: boolean;
}
Loading
Loading