Merge branch 'main' into DOCS-2659-eadvanced-updates

box · Jan 16, 2025 · 7c2931c · 7c2931c
2 parents 4a9fa04 + 7ace360
commit 7c2931c
Show file tree

Hide file tree

Showing 20 changed files with 440 additions and 52 deletions.
diff --git a/content/guides/box-ai/ai-agents/ai-agent-overrides.md b/content/guides/box-ai/ai-agents/ai-agent-overrides.md
@@ -52,7 +52,7 @@ A complete configuration for `ai/ask` is as follows:
       "temperature": 0,
       "top_p": 1
     },
-    "model": "azure__openai__gpt_3_5_turbo_16k",
+    "model": "azure__openai__gpt_4o_mini",
     "num_tokens_for_completion": 8400,
     "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
     "system_message": "You are a helpful travel assistant specialized in budget travel"
@@ -66,7 +66,7 @@ A complete configuration for `ai/ask` is as follows:
       "temperature": 0,
       "top_p": 1
     },
-    "model": "azure__openai__gpt_3_5_turbo_16k",
+    "model": "azure__openai__gpt_4o_mini",
     "num_tokens_for_completion": 8400,
     "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
     "system_message": "You are a helpful travel assistant specialized in budget travel"
@@ -87,7 +87,7 @@ A complete configuration for `ai/ask` is as follows:
       "temperature": 0,
       "top_p": 1
     },
-    "model": "azure__openai__gpt_3_5_turbo_16k",
+    "model": "azure__openai__gpt_4o_mini",
     "num_tokens_for_completion": 8400,
     "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
     "system_message": "You are a helpful travel assistant specialized in budget travel"
@@ -108,7 +108,7 @@ A complete configuration for `ai/ask` is as follows:
       "temperature": 0,
       "top_p": 1
     },
-    "model": "azure__openai__gpt_3_5_turbo_16k",
+    "model": "azure__openai__gpt_4o_mini",
     "num_tokens_for_completion": 8400,
     "prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
     "system_message": "You are a helpful travel assistant specialized in budget travel"

diff --git a/content/guides/box-ai/ai-agents/ai-agent-versioning.md b/content/guides/box-ai/ai-agents/ai-agent-versioning.md
@@ -147,7 +147,7 @@ To make sure your configurations are not affected in a negative way, you can use
     "textGen": {
         "type": "ai_agent_text_gen",
         "basicGen": {
-            "model": "azure__openai__gpt_3_5_turbo_16k",
+            "model": "azure__openai__gpt_4o_mini",
             "systemMessage": "\nIf you need to know today's date to respond, it is {current_date}.\nThe user is working in a collaborative document creation editor called Box Notes.\nAssume that you are helping a business user create documents or to help the user revise existing text.\nYou can help the user in creating templates to be reused or update existing documents, you can respond with text that the user can use to place in the document that the user is editing.\nIf the user simply asks to \"improve\" the text, then simplify the language and remove jargon, unless the user specifies otherwise.\nDo not open with a preamble to the response, just respond.\n",
             "promptTemplate": "{user_question}",
             "numTokensForCompletion": 12000,

diff --git a/content/guides/box-ai/ai-agents/get-agent-default-config.md b/content/guides/box-ai/ai-agents/get-agent-default-config.md
@@ -40,7 +40,7 @@ To make a call, you must pass the following parameters. Mandatory parameters are
 |--------|--------|-------|
 |`language`| The language code the agent configuration is returned for. If the language is not supported, the default configuration is returned. | `ja-JP`| 
 |**`mode`**|The mode used to filter the agent configuration. The value can be `ask`, `text_gen`, `extract`, or `extract_structured` depending on the result you want to achieve. |`ask`|
-|`model`|The model you want to get the configuration for. To make sure your chosen model is supported, see the [list of models][models].| `azure__openai__gpt_3_5_turbo_16k`|
+|`model`|The model you want to get the configuration for. To make sure your chosen model is supported, see the [list of models][models].| `azure__openai__gpt_4o_mini`|
 
 ## Responses
 
@@ -140,7 +140,7 @@ When you set the `mode` parameter to `text_gen` the response will be as follows:
 {
      "type": "ai_agent_text_gen",
      "basic_gen": {
-          "model": "azure__openai__gpt_3_5_turbo_16k",
+          "model": "azure__openai__gpt_4o_mini",
           "system_message": "\nIf you need to know today's date to respond, it is {current_date}.\nThe user is working in a collaborative document creation editor called Box Notes.\nAssume that you are helping a business user create documents or to help the user revise existing text.\nYou can help the user in creating templates to be reused or update existing documents, you can respond with text that the user can use to place in the document that the user is editing.\nIf the user simply asks to \"improve\" the text, then simplify the language and remove jargon, unless the user specifies otherwise.\nDo not open with a preamble to the response, just respond.\n",
           "prompt_template": "{user_question}",
           "num_tokens_for_completion": 12000,

diff --git a/content/guides/box-ai/ai-models/google-text-bison-32-model-card.md b/content/guides/box-ai/ai-models/google-text-bison-32-model-card.md
@@ -10,7 +10,11 @@ related_guides:
 
 # Google Text Bison 32k
 
-**Google Text Bison 32k** is a multimodal model designed to handle lightweight tasks. This model supports a long context window, making it highly suitable for tasks involving large text input, such as summarization or code analysis. 
+**Google Text Bison 32k** is a multimodal model designed to handle lightweight tasks. This model supports a long context window, making it highly suitable for tasks involving large text input, such as summarization or code analysis.
+
+<Message type='warning'>
+  This model has been deprecated on 2025-01-09.
+</Message>
 
 ## Model details
 

diff --git a/content/guides/box-ai/ai-models/google-text-bison-model-card.md b/content/guides/box-ai/ai-models/google-text-bison-model-card.md
@@ -12,6 +12,10 @@ related_guides:
 
 **Google Text Bison** is a multimodal model designed to handle lightweight tasks.
 
+<Message type='warning'>
+  This model has been deprecated on 2025-01-09.
+</Message>
+
 ## Model details
 
 | Item  | Value | Description |

diff --git a/content/guides/box-ai/ai-models/google-text-unicorn-model-card.md b/content/guides/box-ai/ai-models/google-text-unicorn-model-card.md
@@ -12,6 +12,10 @@ related_guides:
 
 **Google Text Unicorn** is a multimodal model designed to handle lightweight tasks.
 
+<Message type='warning'>
+  This model has been deprecated on 2025-01-09.
+</Message>
+
 ## Model details
 
 | Item  | Value | Description |

diff --git a/content/guides/box-ai/ai-models/google-textembedding-gecko-002-model-card.md b/content/guides/box-ai/ai-models/google-textembedding-gecko-002-model-card.md
@@ -11,6 +11,10 @@ related_guides:
 
 Text embedding models convert textual data into numerical vectors that can be processed by machine learning algorithms. The **Google textembedding-gecko@002** model features enhanced AI quality, optimized for embedding tasks, converting text into vector representations, useful in various AI applications.
 
+<Message type='warning'>
+  This model has been deprecated on 2025-01-09.
+</Message>
+
 ## Model details
 
 | Item  | Value | Description |

diff --git a/content/guides/box-ai/ai-models/google-textembedding-gecko-003-model-card.md b/content/guides/box-ai/ai-models/google-textembedding-gecko-003-model-card.md
@@ -11,6 +11,10 @@ related_guides:
 
 Text embedding models convert textual data into numerical vectors that can be processed by machine learning algorithms. The **Google textembedding-gecko@003** model features enhanced AI quality, and is designed for advanced embedding tasks, enhancing the performance of text-related applications.
 
+<Message type='warning'>
+  This model has been deprecated on 2025-01-09.
+</Message>
+
 ## Model details
 
 | Item  | Value | Description |

diff --git a/content/guides/box-ai/ai-models/google-textembedding-gecko-model-card.md b/content/guides/box-ai/ai-models/google-textembedding-gecko-model-card.md
@@ -11,6 +11,10 @@ related_guides:
 
 Text embedding models convert textual data into numerical vectors that can be processed by machine learning algorithms. The **Google textembedding-gecko** model features enhanced AI quality, excels in text embeddings, offering strong retrieval performance while being compact.
 
+<Message type='warning'>
+  This model has been deprecated on 2025-01-09.
+</Message>
+
 ## Model details
 
 | Item  | Value | Description |

diff --git a/content/guides/box-ai/ai-models/index.md b/content/guides/box-ai/ai-models/index.md
@@ -70,48 +70,6 @@ Models offered in **Preview** mode have not been fully performance-tested at sca
         <strong style="background-color: #e1ffe7">Available</strong>
       </div>
     </Tile>
-    <Tile type="model" title="google__textembedding_gecko" href="/guides/box-ai/ai-models/google-textembedding-gecko-model-card">
-      A text embedding model, converting textual data into numerical vectors that machine learning algorithms can process.
-      <div>
-        <strong style="background-color: #e8e8e8">Embeddings</strong>
-        <strong style="background-color: #e1ffe7">Available</strong>
-      </div>
-    </Tile>
-    <Tile type="model" title="google__textembedding_gecko_002" href="/guides/box-ai/ai-models/google-textembedding-gecko-002-model-card">
-       A text embedding model converting textual data into numerical vectors that machine learning algorithms can process.
-      <div>
-      <strong style="background-color: #e8e8e8">Embeddings</strong>
-        <strong style="background-color: #e1ffe7">Available</strong>
-      </div>
-    </Tile>
-    <Tile type="model" title="google__textembedding_gecko_003" href="/guides/box-ai/ai-models/google-textembedding-gecko-003-model-card">
-      A text embedding model converting textual data into numerical vectors that machine learning algorithms can process.
-      <div>
-      <strong style="background-color: #e8e8e8">Embeddings</strong>
-        <strong style="background-color: #e1ffe7">Available</strong>
-      </div>
-    </Tile>
-    <Tile type="palm" title="google__text_unicorn" href="/guides/box-ai/ai-models/google-text-unicorn-model-card">
-       A model that can handle complex tasks, such as coding, due to the extensive embedded knowledge.
-      <div>
-      <strong style="background-color: #e8e8e8">Chat</strong>
-        <strong style="background-color: #e1ffe7">Available</strong>
-      </div>
-    </Tile>
-    <Tile type="palm" title="google__text_bison" href="/guides/box-ai/ai-models/google-text-bison-model-card">
-      A model capable of creating document summaries, answers to questions, and content classification labels.
-      <div>
-        <strong style="background-color: #e8e8e8">Chat</strong>
-        <strong style="background-color: #e1ffe7">Available</strong>
-      </div>
-    </Tile>
-    <Tile type="palm" title="google__text_bison_32k" href="/guides/box-ai/ai-models/google-text-bison-32-model-card">
-      An enhanced **text-bison** model capable of creating document summaries, answers to questions, and content classification labels.
-      <div>
-        <strong style="background-color: #e8e8e8">Chat</strong>
-        <strong style="background-color: #e1ffe7">Available</strong>
-      </div>
-    </Tile>
     <Tile type="model" title="aws__claude_3_haiku" href="/guides/box-ai/ai-models/aws-claude-3-haiku-model-card">
       A model tailored for various language tasks, including creative writing and conversational AI.
       <div>
@@ -142,12 +100,64 @@ Models offered in **Preview** mode have not been fully performance-tested at sca
     </Tile>
 </TileGrid>
 
+### Deprecated models
+
+<TileGrid rows="2">
+  <Tile type="model" title="google__textembedding_gecko" href="/guides/box-ai/ai-models/google-textembedding-gecko-model-card">
+    A text embedding model, converting textual data into numerical vectors that machine learning algorithms can process.
+    <div>
+      <strong style="background-color: #e8e8e8">
+        Deprecated on 2025-01-09
+      </strong>
+    </div>
+  </Tile>
+  <Tile type="model" title="google__textembedding_gecko_002" href="/guides/box-ai/ai-models/google-textembedding-gecko-002-model-card">
+      A text embedding model converting textual data into numerical vectors that machine learning algorithms can process.
+    <div>
+      <strong style="background-color: #e8e8e8">
+        Deprecated on 2025-01-09
+      </strong>
+    </div>
+  </Tile>
+  <Tile type="model" title="google__textembedding_gecko_003" href="/guides/box-ai/ai-models/google-textembedding-gecko-003-model-card">
+    A text embedding model converting textual data into numerical vectors that machine learning algorithms can process.
+    <div>
+      <strong style="background-color: #e8e8e8">
+        Deprecated on 2025-01-09
+      </strong>
+    </div>
+  </Tile>
+  <Tile type="palm" title="google__text_unicorn" href="/guides/box-ai/ai-models/google-text-unicorn-model-card">
+      A model that can handle complex tasks, such as coding, due to the extensive embedded knowledge.
+    <div>
+      <strong style="background-color: #e8e8e8">
+        Deprecated on 2025-01-09
+      </strong>
+    </div>
+  </Tile>
+  <Tile type="palm" title="google__text_bison" href="/guides/box-ai/ai-models/google-text-bison-model-card">
+    A model capable of creating document summaries, answers to questions, and content classification labels.
+    <div>
+      <strong style="background-color: #e8e8e8">
+        Deprecated on 2025-01-09
+      </strong>
+    </div>
+  </Tile>
+  <Tile type="palm" title="google__text_bison_32k" href="/guides/box-ai/ai-models/google-text-bison-32-model-card">
+    An enhanced **text-bison** model capable of creating document summaries, answers to questions, and content classification labels.
+    <div>
+      <strong style="background-color: #e8e8e8">
+        Deprecated on 2025-01-09
+      </strong>
+    </div>
+  </Tile>
+</TileGrid>
+
 [ask]: e://post_ai_ask
 [text-gen]: e://post_ai_text_gen
 [extract]: e://post_ai_extract
 [extract-structured]: e://post_ai_extract_structured
 [agent]: e://get_ai_agent_default
-[azure-ai-gpt-3-5-model]: https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35
 [azure-ai-mini-4o-model]: https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=python-secure#gpt-4o-and-gpt-4-turbo
 [vertex-ai-model]: https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#models
 [vertex-ai-gemini-models]: https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#gemini-models

diff --git a/content/guides/box-ai/ai-tutorials/prerequisites.md b/content/guides/box-ai/ai-tutorials/prerequisites.md
@@ -29,7 +29,7 @@ the Box AI APIs in your sandbox, request access
 from the Box AI team using [this form][form].
 </Message>
 
-## Create an application
+## Create a custom application
 
 First you need to create a custom application
 you will use to make calls. To create

diff --git a/content/guides/docgen/docgen-getting-started.md b/content/guides/docgen/docgen-getting-started.md
@@ -0,0 +1,71 @@
+---
+rank: 1
+related_endpoints:
+  - post_docgen_templates_v2025.0
+  - post_docgen_batches_v2025.0
+related_guides:
+  - docgen/generate-document
+  - docgen/mark-template
+  - docgen/docgen-jobs
+  - docgen/docgen-templates
+---
+
+# Get started with Box Doc Gen
+
+To start generating documents with Box Doc Gen API you will need a custom application and a developer token to
+authenticate your calls. You also need a Doc Gen template that will serve as an input source for your document.
+
+## Enable Box Doc Gen
+
+To use Box Doc Gen, make sure it is enabled by an
+admin in the Admin Console.
+If you are a Box Admin, you will find the necessary information in
+[Enterprise Settings: Content & Sharing Tab][settings] documentation.
+
+## Create and upload a Box Doc Gen template
+
+To use Box Doc Gen API to generate documents, a Box Doc Gen template must already exist in Box. You have the following options to create a template:
+
+* Install the [Box Doc Gen Template Creator add-in for Microsoft Word][template-addin].
+* Create a Box Doc Gen template [using a JSON file][json-template] or manually create [template tags][template-tags].
+
+## Create a custom application
+
+First you need to create a custom application
+you will use to make calls. To create
+an application, follow the guide
+on [creating custom apps][createapps].
+
+## Generate a developer token
+
+You need a developer token
+to authenticate your app when sending requests.
+
+To generate a token:
+
+1. Go to **Developer Console** > **My Platform Apps**.
+2. Click the **Options menu** button (…) on the right.
+3. Select **Generate Developer Token**. The token will be automatically generated and saved to clipboard.
+
+![generate token](./images/developer-token.png)
+
+You can also open your app, go to
+**Configuration** > **Developer Token**
+and generate the token.
+
+<Message type="notice">
+A developer token is only valid for one hour.
+</Message>
+
+For additional details, see [developer token][token].
+After you generate the token, you can use it in cURL
+or other clients, such as [Postman][postman], to make
+calls.
+
+[token]: g://authentication/tokens/developer-tokens
+[createapps]: g://applications/app-types/custom-apps
+[postman]: g://tooling/postman
+[settings]: https://support.box.com/hc/en-us/articles/4404822772755-Enterprise-Settings-Content-Sharing-Tab#h_01FYQGK5RW42T07GV985MQ9E9A
+[template-addin]: https://support.box.com/hc/en-us/articles/36587535449747-Installing-Box-Doc-Gen-Add-in
+[template-tags]: https://support.box.com/hc/en-us/articles/36151895655059-Creating-A-Box-Doc-Gen-Template-Manually
+[json-template]: https://support.box.com/hc/en-us/articles/36148012877843-Creating-a-Box-Doc-Gen-Template-using-JSON-data
diff --git a/content/guides/docgen/docgen-jobs.md b/content/guides/docgen/docgen-jobs.md
@@ -0,0 +1,46 @@
+---
+rank: 5
+related_endpoints:
+  - get_docgen_jobs_v2025.0
+  - get_docgen_batch_jobs_id_v2025.0
+  - get_docgen_jobs_id_v2025.0
+related_guides:
+  - docgen/docgen-getting-started
+  - docgen/generate-document
+---
+
+# Box Doc Gen jobs
+
+A Box Doc Gen job runs when you make a request to generate a document.
+The `document_generation_data` parameter in the `POST` request is an array of entries that represent Box Doc Gen jobs run to generate a document.
+
+<Samples id='post_docgen_batches_v2025.0' />
+
+Box Doc Gen API allows you to get information about the Box Doc Gen jobs.
+
+## Prerequisites
+
+Before you start using Box Doc Gen API, follow the steps listed in the [get started with Box Doc Gen][docgen-prerequisites] guide to create a custom app and a Box Doc Gen template.
+
+## List all Box Doc Gen jobs
+
+To get a list of all Box Doc Gen jobs that were run,
+use the `GET /2.0/docgen_jobs` endpoint. You don't have to provide any additional parameters.
+
+<Samples id='get_docgen_jobs_v2025.0' />
+
+## Get a Box Doc Gen job by ID
+
+To get a specific Box Doc Gen job,
+use the `GET /2.0/docgen_jobs_id` endpoint and provide the `job_id`.
+
+<Samples id='get_docgen_jobs_id_v2025.0' />
+
+## Get Box Doc Gen jobs in batch with a specific ID
+
+A single request can generate several documents. In such a case, a separate generation job is run for each document and all these jobs are included in one "batch" meaning a request.
+To get all jobs performed within one request, use the `GET /2.0/docgen_batch_jobs_id` endpoint and provide the `batch_id`.
+
+<Samples id='get_docgen_jobs_id_v2025.0' />
+
+[docgen-prerequisites]: g://docgen/docgen-getting-started