docs: Update AI documentation (#432)

* docs: Update AI documentation * Update openapi.json --------- Co-authored-by: Barbara Czyż <[email protected]>
box · Jun 11, 2024 · d2b1e63 · d2b1e63
1 parent 9ec28ce
commit d2b1e63
Showing 1 changed file with 11 additions and 11 deletions.
diff --git a/openapi.json b/openapi.json
@@ -14,7 +14,7 @@
       "url": "http://www.apache.org/licenses/LICENSE-2.0"
     },
     "version": "2.0.0",
-    "x-box-commit-hash": "d7b05a25c3"
+    "x-box-commit-hash": "20609e8332"
   },
   "servers": [
     {
@@ -23879,7 +23879,7 @@
     "/ai/ask": {
       "post": {
         "operationId": "post_ai_ask",
-        "summary": "Send AI Ask request",
+        "summary": "Send AI question request",
         "tags": [
           "AI"
         ],
@@ -23932,7 +23932,7 @@
     "/ai/text_gen": {
       "post": {
         "operationId": "post_ai_text_gen",
-        "summary": "Send AI Text Gen request",
+        "summary": "Send AI request to generate text",
         "tags": [
           "AI"
         ],
@@ -24019,7 +24019,7 @@
         "properties": {
           "mode": {
             "type": "string",
-            "description": "The mode specifies if this request is for a single or multiple items.",
+            "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.",
             "enum": [
               "multiple_item_qa",
               "single_item_qa"
@@ -24029,12 +24029,12 @@
           },
           "prompt": {
             "type": "string",
-            "description": "The prompt provided by the client to be answered by the LLM.",
+            "description": "The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.",
             "example": "What is the value provided by public APIs based on this document?"
           },
           "items": {
             "type": "array",
-            "description": "The items to be processed by the LLM, often files.",
+            "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. ",
             "minItems": 1,
             "maxItems": 25,
             "uniqueItems": true,
@@ -24048,12 +24048,12 @@
               "properties": {
                 "id": {
                   "type": "string",
-                  "description": "The id of the item",
+                  "description": "The id of the item.",
                   "example": "123"
                 },
                 "type": {
                   "type": "string",
-                  "description": "The type of the item",
+                  "description": "The type of the item.",
                   "enum": [
                     "file"
                   ],
@@ -24081,12 +24081,12 @@
         "properties": {
           "prompt": {
             "type": "string",
-            "description": "The prompt provided by the client to be answered by the LLM.",
+            "description": "The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.",
             "example": "Write an email to a client about the importance of public APIs."
           },
           "items": {
             "type": "array",
-            "description": "The items to be processed by the LLM, often files.",
+            "description": "The items to be processed by the LLM, often files.\nThe array can include **exactly one** element.\n\n**Note**: Box AI handles documents with text representations up to 1MB in size.\nIf the file size exceeds 1MB, the first 1MB of text representation will be processed.",
             "required": [
               "id",
               "type"
@@ -38749,4 +38749,4 @@
     "description": "Box Developer Documentation",
     "url": "https://developer.box.com"
   }
-}
+}