Skip to content

Commit

Permalink
Merge branch 'main' into DDOC-1208-docgen-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
wsocha authored Jan 10, 2025
2 parents bdf07a9 + dd18361 commit 6babb51
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 10 deletions.
2 changes: 0 additions & 2 deletions content/guides/api-calls/api-versioning-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ To stay informed about the forthcoming API modifications, monitor the [Changelog

</Message>

<!-- Commenting this until we enable base version support in Public API Service
<Message type='notice'>

In 2024, Box introduced year-based API versioning.
Expand All @@ -29,7 +28,6 @@ All endpoints available at the end of 2024 were assigned the version `2024.0`.
To make version-aware API calls, include the `box-version` header with the value `2024.0` in your requests.

</Message>
-->

## How Box API versioning works

Expand Down
8 changes: 4 additions & 4 deletions content/guides/box-ai/ai-agents/ai-agent-overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion content/guides/box-ai/ai-agents/ai-agent-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions content/guides/box-ai/ai-agents/get-agent-default-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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,
Expand Down
1 change: 0 additions & 1 deletion content/guides/box-ai/ai-models/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,6 @@ Models offered in **Preview** mode have not been fully performance-tested at sca
[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
Expand Down

0 comments on commit 6babb51

Please sign in to comment.