Skip to content
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

Jump to bottom

Dev zone updates #605

Merged
merged 13 commits into from
Oct 11, 2024
Merged

Dev zone updates #605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
db3b134
Fix typo
SowaProgramuje Sep 19, 2024
d527af7
Add video section in the AI Dev zone
SowaProgramuje Sep 23, 2024
ca625f2
Change documentation pill description
SowaProgramuje Sep 25, 2024
623de99
Update video section captions
SowaProgramuje Oct 2, 2024
f8ed1b8
Rebase with main
SowaProgramuje Oct 2, 2024
0d15645
Improve copy after review
SowaProgramuje Oct 2, 2024
2ed86f7
Merge branch 'main' of github.com:box/developer.box.com into dev-zone…
SowaProgramuje Oct 3, 2024
fe90285
Update copy for q&a endpoint
SowaProgramuje Oct 3, 2024
6361d92
Improve SDK TS naming
SowaProgramuje Oct 8, 2024
f770535
Improve SDK TS naming
SowaProgramuje Oct 8, 2024
3c41070
Merge branch 'main' of github.com:box/developer.box.com into dev-zone…
SowaProgramuje Oct 10, 2024
b83be0c
Adjust wording in video description
SowaProgramuje Oct 10, 2024
df315c1
Merge branch 'main' of github.com:box/developer.box.com into dev-zone…
SowaProgramuje Oct 11, 2024
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
2 changes: 1 addition & 1 deletion content/guides/tooling/sdks/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ these projects to full parity.

## Next generation SDKs

The latest generation Box Python SDK, Box Typescript
The latest generation Box Python SDK, Box TypeScript
SDK, .NET SDK, and Swift SDK are designed to elevate the developer
experience and streamline your integration
with the Box Content Cloud.
Expand Down
2 changes: 1 addition & 1 deletion content/guides/tooling/sdks/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ project.
[Node SDK][node] is currently in maintenance mode and will be deprecated soon.
This means only critical security updates and bug fixes will be
implemented.
It is recommended to use the [auto-generated Typescript SDK][ts-gen].
It is recommended to use the [auto-generated TypeScript SDK][ts-gen].
</Message>

<CTA to="https://github.com/box/box-node-sdk">
Expand Down
6 changes: 3 additions & 3 deletions content/guides/tooling/sdks/typescript-gen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ alias_paths: []

# Install Typescript SDK (Generated)

You can use the **auto-generated** Box Typescript SDK to call Box APIs in a Typescript project.
You can use the **auto-generated** Box TypeScript SDK to call Box APIs in a TypeScript project.
This [next generation SDK][next-gen] brings along new functionality to designed to elevate the developer experience and streamline your integration with the Box Content Cloud.

<CTA to="https://github.com/box/box-typescript-sdk-gen">
Learn more about auto-generated Typescript SDK on GitHub
Learn more about auto-generated TypeScript SDK on GitHub
</CTA>

## NPM installation

To install the Typescript SDK run the following command from your terminal
To install the TypeScript SDK run the following command from your terminal
window or command prompt using the [Node Package Manager][npm].

```shell
Expand Down
6 changes: 3 additions & 3 deletions content/microcopy/footer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ categories:

links:
ts_gen_sdk:
// text: Text for link to the Typescript SDK (Generated)
text: Typescript SDK (Generated)
// url: link to the Typescript SDK (Generated)
// text: Text for link to the TypeScript SDK (Generated)
text: TypeScript SDK (Generated)
// url: link to the TypeScript SDK (Generated)
url: https://github.com/box/box-typescript-sdk-gen

java_sdk:
Expand Down
107 changes: 87 additions & 20 deletions content/pages/ai-dev-zone/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ centered: false
# Box AI Developer Zone

<Centered wide id="ai-developer-zone" >
<HeroImage type="AiDevZone" imageWidth="548" imageHeight="493">
<HeroImage type="AiDevZone" imageWidth="600" imageHeight="400">
<Header>
Box AI</br>
Developer Zone
Expand All @@ -20,14 +20,12 @@ view sample code, explore Box AI use cases, and more!
</Centered>

<Centered mid>
<Header>
<Header centered>
Try out interactive demos
</Header>
<p style="text-align: left; margin-left: 0;">
Box AI API is currently a beta feature. Bear in mind that
the available capabilities can change.
</p>
<TileGrid rows="3">
Box AI API is currently a beta feature offered subject to Box’s Main Beta Agreement, and the available capabilities may change. Box AI API is available to all Enterprise Plus customers.
SowaProgramuje marked this conversation as resolved.
Show resolved Hide resolved

<TileGrid rows="4">
<Tile type="ai" title="Get a summary" href="/ai-dev-zone-summary">
Summarize a document in a selected tone of voice.

Expand All @@ -44,40 +42,109 @@ view sample code, explore Box AI use cases, and more!

<strong style="background-color: #e8e8e8">Public beta</strong>
</Tile>
<!-- <Tile disabled type="ai"
title="Ask questions"
>
Ask Box AI about the document to get the details. Demo coming soon!

<strong style="background-color: #e8e8e8">Public beta</strong>
</Tile> -->
</TileGrid>
</Centered>

<Centered mid>
<Header>
Box AI API documentation and support
Documentation and support
</Header>
<p style="text-align: left; margin-left: 0;">
These resources will get you up and running with Box AI API.
</p>

<TileGrid rows="4">
<Tile type="document" title="AI API reference"
<Tile type="code-new" title="AI API reference"
href="/reference/resources/ai-response/">
Check the API reference for specification details.

<strong style="background-color: #e8e8e8">Documentation</strong>
</Tile>
<Tile type="leaflet" title="Developer guides"
<Tile type="code-new" title="Developer guides"
href="/guides/box-ai/">
Browse the guides to learn how to use Box AI API.

<strong style="background-color: #e8e8e8">Documentation</strong>
</Tile>
<Tile type="tuning" title="Supported AI models"
<Tile type="code-new" title="Supported AI models"
href="/guides/box-ai/supported-models/">
Check table list of the supported AI models.

<strong style="background-color: #e8e8e8">Documentation</strong>
</Tile>
<Tile type="speech-bubble" title="Support"
<Tile type="code-new" title="Support"
href="https://community.box.com/">
Visit Box Developer Community for support.
Visit Box Developer Community for support and knowledge sharing.

<strong style="background-color: #e8e8e8">Community</strong>
</Tile>
</TileGrid>
</Centered>

<Centered mid>
<Header>
Box for AI Integrations
</Header>
<p style="text-align: left; margin-left: 0;">
Use Box for AI Integrations to extend LLM models' existing knowledge bases.
</p>

<TileGrid rows="4">
<Tile type="box-brown" title="LlamaIndex"
href="https://github.com/run-llama/llama_index/tree/main/llama-index-integrations/readers/llama-index-readers-box#readme">
Enable access to Box content within LLM workflows with Box reader suite for LlamaIndex.

<strong style="background-color: #e8e8e8">New</strong>
</Tile>
<Tile type="box-brown" title="LangChain"
href="https://python.langchain.com/v0.2/docs/integrations/providers/box/">
Include Box content in your LLM workflows with Box loader for LangChain.

<strong style="background-color: #e8e8e8">New</strong>
</Tile>
</TileGrid>
</Centered>

<Centered mid>
<Header centered>
Videos
</Header>
Watch the latest Box AI API tutorials and demos.

<TileGrid rows="3">
<Tile image="AI-API" title="AI API overview"
href="https://www.youtube.com/watch?v=amhOj0YRVRQ&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
Check out the high-level features of the Box AI API in one minute.

</Tile>
<Tile image="API-text-gen" title="Endpoint overivew"
href="https://www.youtube.com/watch?v=xxR8aF4r3g8&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
See a demo of the Box AI API text generation endpoint.

</Tile>
<Tile image="API-q&a" title="Endpoint overivew"
href="https://www.youtube.com/watch?v=UyKfacz6G9g&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
See a demo of the Box AI API document Q&A endpoint.

</Tile>
<Tile image="API-extract" title="Endpoint overivew"
href="https://www.youtube.com/watch?v=fijj0CX67c4&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
Extract metadata with various prompt formats with Box AI API.

</Tile>
<Tile image="API-extract-structured" title="Endpoint overivew"
href="https://www.youtube.com/watch?v=dU3oo4sHZt0&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q">
Extract metadata with predefined structure with Box AI API.

</Tile>
<Tile image="API-interview" title="Hear from Box CPO Diego Dugatkin"
href="https://www.youtube.com/watch?v=NA4NiqBdSg4&t=2s">
Learn why Box chose to expose Box AI through our public API.

</Tile>
</TileGrid>

<More secondary="true" to='https://www.youtube.com/watch?v=amhOj0YRVRQ&list=PLCSEWOlbcUyI2ta24oRr75_4igvMzKJ9q' center>
View all videos
</More>
</Centered>
117 changes: 20 additions & 97 deletions content/pages/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,48 +35,14 @@ All the developer resources to help you get the most from Box products

</Banner>

<!-- <Centered wide>
<Header to='/guides' centered>
Guides
</Header>
<GuidesList>
Get started, learn tips and tricks, and discover how to use the Box
Platform API with our comprehensive guides. Here are six of the most used
guides to get you started.

<GuideList href='/guides/authentication/'>
Authentication
</GuideList>
<GuideList href='/guides/cli/quick-start/'>
CLI Quick Start
</GuideList>
<GuideList href='/guides/tooling/postman/quick-start/'>
Postman Quick Start
</GuideList>
<GuideList href='/guides/api-calls/permissions-and-errors/common-errors/'>
Common Errors
</GuideList>
<GuideList href='/guides/api-calls/pagination/offset-based/'>
API Pagination
</GuideList>
<GuideList href='/guides/embed/ui-elements/'>
UI Elements
</GuideList>
</GuidesList>

<More to='/guides' right>
More Guides
</More>
</Centered> -->

<Centered wide id="start-with-box-platform" >
<Header centered>
I'm new to Box Platform. How do I start?
</Header>
We got you covered! Follow these steps to build
new applications and discover Box Platform capabilities.

<TileGrid>
<TileGrid rows="3">
<Tile type="users" title="1. Explore user types"
href="platform/user-types/">
Box Platform covers many use cases
Expand All @@ -95,28 +61,17 @@ All the developer resources to help you get the most from Box products
Credentials, and App Token authentication. Learn more and
select the method that applies to your app.
</Tile>
<Tile type="cli" title="4. Set up Box CLI"
href="/guides/cli/quick-start/">
Optionally, follow the Box CLI quickstart
guide to have an API testing space. It takes less than
five minutes to start developing!
</Tile>
<Tile type="architecture" title="5. Create an architecture pattern"
href="/platform/appendix/architecture-patterns/">
We always recommend putting pen to paper and drawing out your solution.
Have a look at the most common architecture patterns to get inspired!
</Tile>
<Tile type="create" title="6. Create the application"
<Tile type="create" title="4. Create the application"
href="https://app.box.com/developers/console">
Now, you can start building! Launch the Developer Console and create an
application of your choice.
</Tile>
<Tile type="authorize" title="7. Authorize the application"
<Tile type="authorize" title="5. Authorize the application"
href="/guides/authorization/">
Read about the authorization requirements you have to
fulfill to start using you app.
</Tile>
<Tile type="code" title="8. Start coding"
<Tile type="code" title="6. Start coding"
href="#sdks-and-tools">
Finally, explore our developer toolkit: API Reference,
SDKS, Box CLI, Postman Collection, Box UI Elements and much more!
Expand All @@ -143,26 +98,30 @@ All the developer resources to help you get the most from Box products
href="/reference/">
*Box API Reference*
</Tile>
<Tile type="java" title="Java SDK"
<Tile type="python" title="Python Gen SDK"
href="https://github.com/box/box-python-sdk-gen?tab=readme-ov-file#box-python-sdk-generated">
*box-python-sdk-gen*
</Tile>
<Tile type="java" title="Box Java SDK"
href="https://github.com/box/box-java-sdk#readme">
*box-java-sdk*
</Tile>
<Tile type="python" title="Python SDK"
href="https://github.com/box/box-python-sdk#readme">
*box-python-sdk*
<Tile type="box-orange" title="TypeScript Gen SDK"
href="https://github.com/box/box-typescript-sdk-gen?tab=readme-ov-file#box-typescript-sdk-generated">
*box-typescript-sdk-gen*
</Tile>
<Tile type="node" title="Node.js SDK"
href="https://github.com/box/box-node-sdk#readme">
*box-node-js-sdk*
<Tile type="net" title="Box .NET Gen SDK"
href="https://github.com/box/box-dotnet-sdk-gen?tab=readme-ov-file#box-dotnet-sdk-generated">
*box-dotnet-sdk-gen*
</Tile>
<Tile type="net" title=".NET SDK"
href="https://github.com/box/box-windows-sdk-v2#readme">
*box-windows-sdk-v2*
</Tile>
<Tile type="tool" title="iOS SDK"
<Tile type="tool" title="Box iOS SDK"
href="https://github.com/box/box-ios-sdk#readme">
*box-ios-sdk*
</Tile>
<Tile type="tool" title="Box Swift Gen SDK (beta)"
href="https://github.com/box/box-ios-sdk#readme">
*box-swift-sdk-gen*
</Tile>
<Tile type="tool" title="Postman collection"
href="/guides/tooling/postman">
*Box Postman Collection*
Expand All @@ -184,42 +143,6 @@ All the developer resources to help you get the most from Box products
</More>
</section>

<!-- <Dark>
<Centered wide>
<Header to='/sdks-and-tools' centered>
SDKS & Tools
</Header>
<SDKS>
Development with Box Platform is made easier with SDKs for your
programming language, a command line interface, front-end UI elements,
and much more.

<SDK language='python' href='https://github.com/box/box-python-sdk'>
Python SDK
</SDK>
<SDK language='java' href='https://github.com/box/box-java-sdk'>
Java SDK
</SDK>
<SDK language='node' href='https://github.com/box/box-node-sdk'>
Node SDK
</SDK>
<SDK language='dotnet' href='https://github.com/box/box-windows-sdk'>
Windows .NET SDK
</SDK>
<SDK language='cli' href='https://github.com/box/boxcli'>
Box CLI
</SDK>
<SDK language='uielements' href='https://github.com/box/box-ui-elements'>
UI Elements
</SDK>
</SDKS>

<More to='/sdks-and-tools' right>
More SDKs & Tools
</More>
</Centered>
</Dark> -->

<Centered wide>
<FeaturedBoard type="community" />
</Centered>
Expand Down
4 changes: 2 additions & 2 deletions content/pages/sdks-and-tools/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following SDKs and tools are developed and supported by Box.
Here you will find a list of SDKs
you can use to build your application.
Separately, we have listed the next generation
Python, Typescript, and .NET SDKs, which are the
Python, TypeScript, and .NET SDKs, which are the
newest addition.
.NET is still a beta feature, but we encourage
you to give it a try and explore all the
Expand All @@ -42,7 +42,7 @@ these projects to full parity.

### Next generation SDKs

The latest generation Box Python SDK, Box Typescript
The latest generation Box Python SDK, Box TypeScript
SDK, .NET SDK, and Swift SDK are designed to elevate the developer
experience and streamline your integration
with the Box Content Cloud.
Expand Down
Loading