Skip to content

docs: remove beta tag for AI extract endpoints #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wsocha merged 1 commit into from
Feb 21, 2025
Merged

docs: remove beta tag for AI extract endpoints #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 5 additions & 7 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "97ccf22b82"
"x-box-commit-hash": "cc4376000f"
},
"servers": [
{
Expand Down Expand Up @@ -24378,7 +24378,6 @@
"operationId": "post_ai_extract",
"summary": "Extract metadata (freeform)",
"description": "Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.\nIn this request, both the prompt and the output can be freeform.\nMetadata template setup before sending the request is not required.",
"x-stability-level": "beta",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -24432,7 +24431,6 @@
"operationId": "post_ai_extract_structured",
"summary": "Extract metadata (structured)",
"description": "Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\nFor this request, you either need a metadata template or a list of fields you want to extract.\nInput is **either** a metadata template or a list of fields to ensure the structure.\nTo 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)\nor use the [metadata template API](g://metadata/templates/create).",
"x-stability-level": "beta",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -25290,7 +25288,7 @@
"type": "object",
"properties": {
"mode": {
"description": "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.",
"description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages for multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will be processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. Currently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only process the text.",
"type": "string",
"example": "multiple_item_qa",
"enum": [
Expand All @@ -25305,7 +25303,7 @@
"example": "What is the value provided by public APIs based on this document?"
},
"items": {
"description": "The items to be processed by the LLM, often files.\n\n**Note**: Box AI handles documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first.\nIf the file size exceeds 1MB, the first 1MB of text representation will be processed.\nIf you set `mode` parameter to `single_item_qa`, the `items` array can have one element only.",
"description": "The items to be processed by the LLM, often files.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AiItemAsk"
Expand Down Expand Up @@ -25585,7 +25583,7 @@
"x-box-tag": "ai"
},
"AiExtractStructuredResponse": {
"description": "AI response",
"description": "AI extract structured response",
"type": "object",
"properties": {
"answer": {
Expand All @@ -25610,7 +25608,7 @@
"answer",
"created_at"
],
"title": "AI response",
"title": "AI extract structured response",
"x-box-resource-id": "ai_extract_structured_response",
"x-box-tag": "ai"
},
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2025.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "97ccf22b82"
"x-box-commit-hash": "cc4376000f"
},
"servers": [
{
Expand Down
12 changes: 5 additions & 7 deletions openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "97ccf22b82"
"x-box-commit-hash": "cc4376000f"
},
"servers": [
{
Expand Down Expand Up @@ -24378,7 +24378,6 @@
"operationId": "post_ai_extract",
"summary": "Extract metadata (freeform)",
"description": "Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.\nIn this request, both the prompt and the output can be freeform.\nMetadata template setup before sending the request is not required.",
"x-stability-level": "beta",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -24432,7 +24431,6 @@
"operationId": "post_ai_extract_structured",
"summary": "Extract metadata (structured)",
"description": "Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\nFor this request, you either need a metadata template or a list of fields you want to extract.\nInput is **either** a metadata template or a list of fields to ensure the structure.\nTo 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)\nor use the [metadata template API](g://metadata/templates/create).",
"x-stability-level": "beta",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -25290,7 +25288,7 @@
"type": "object",
"properties": {
"mode": {
"description": "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.",
"description": "Box AI handles text documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first. If the text file size exceeds 1MB, the first 1MB of text representation will be processed. Box AI handles image documents with a resolution of 1024 x 1024 pixels, with a maximum of 5 images or 5 pages for multi-page images. If the number of image or image pages exceeds 5, the first 5 images or pages will be processed. If you set mode parameter to `single_item_qa`, the items array can have one element only. Currently Box AI does not support multi-modal requests. If both images and text are sent Box AI will only process the text.",
"type": "string",
"example": "multiple_item_qa",
"enum": [
Expand All @@ -25305,7 +25303,7 @@
"example": "What is the value provided by public APIs based on this document?"
},
"items": {
"description": "The items to be processed by the LLM, often files.\n\n**Note**: Box AI handles documents with text representations up to 1MB in size, or a maximum of 25 files, whichever comes first.\nIf the file size exceeds 1MB, the first 1MB of text representation will be processed.\nIf you set `mode` parameter to `single_item_qa`, the `items` array can have one element only.",
"description": "The items to be processed by the LLM, often files.",
"type": "array",
"items": {
"$ref": "#/components/schemas/AiItemAsk"
Expand Down Expand Up @@ -25585,7 +25583,7 @@
"x-box-tag": "ai"
},
"AiExtractStructuredResponse": {
"description": "AI response",
"description": "AI extract structured response",
"type": "object",
"properties": {
"answer": {
Expand All @@ -25610,7 +25608,7 @@
"answer",
"created_at"
],
"title": "AI response",
"title": "AI extract structured response",
"x-box-resource-id": "ai_extract_structured_response",
"x-box-tag": "ai"
},
Expand Down