langchain-box
This package contains the LangChain integration with Box. For more information about Box, check out our developer documentation.
Pre-requisites
In order to integrate with Box, you need a few things:
- A Box instance — if you are not a current Box customer, sign up for a free dev account.
- A Box app — more on how to create an app
- Your app approved in your Box instance — This is done by your admin. The good news is if you are using a free developer account, you are the admin. Authorize your app
Installation
pip install -U langchain-box
Authentication
The box-langchain package offers some flexibility to authentication. The
most basic authentication method is by using a developer token. This can be
found in the Box developer console
on the configuration screen. This token is purposely short-lived (1 hour) and is
intended for development. With this token, you can add it to your environment as
BOX_DEVELOPER_TOKEN, you can pass it directly to the loader, or you can use the
BoxAuth authentication helper class.
We will cover passing it directly to the loader in the section below.
BoxAuth helper class
BoxAuth supports the following authentication methods:
- Token — either a developer token or any token generated through the Box SDK
- JWT with a service account
- JWT with a specified user
- CCG with a service account
- CCG with a specified user
For more information, learn about how to set up a Box application, and check out the Box authentication guide for more about our different authentication options.
Examples:
Token
from langchain_box.document_loaders import BoxLoader
from langchain_box.utilities import BoxAuth, BoxAuthType
auth = BoxAuth(
auth_type=BoxAuthType.TOKEN,
box_developer_token=box_developer_token
)
loader = BoxLoader(
box_auth=auth,
...
)
JWT with a service account
from langchain_box.document_loaders import BoxLoader
from langchain_box.utilities import BoxAuth, BoxAuthType
auth = BoxAuth(
auth_type=BoxAuthType.JWT,
box_jwt_path=box_jwt_path
)
loader = BoxLoader(
box_auth=auth,
...
JWT with a specified user
from langchain_box.document_loaders import BoxLoader
from langchain_box.utilities import BoxAuth, BoxAuthType
auth = BoxAuth(
auth_type=BoxAuthType.JWT,
box_jwt_path=box_jwt_path,
box_user_id=box_user_id
)
loader = BoxLoader(
box_auth=auth,
...
CCG with a service account
from langchain_box.document_loaders import BoxLoader
from langchain_box.utilities import BoxAuth, BoxAuthType
auth = BoxAuth(
auth_type=BoxAuthType.CCG,
box_client_id=box_client_id,
box_client_secret=box_client_secret,
box_enterprise_id=box_enterprise_id
)
loader = BoxLoader(
box_auth=auth,
...
CCG with a specified user
from langchain_box.document_loaders import BoxLoader
from langchain_box.utilities import BoxAuth, BoxAuthType
auth = BoxAuth(
auth_type=BoxAuthType.CCG,
box_client_id=box_client_id,
box_client_secret=box_client_secret,
box_user_id=box_user_id
)
loader = BoxLoader(
box_auth=auth,
...
Document Loaders
The BoxLoader class helps you get your unstructured content from Box
in Langchain's Document format. You can do this with either a List[str]
containing Box file IDs, or with a str containing a Box folder ID.
If getting files from a folder with folder ID, you can also set a Bool to
tell the loader to get all sub-folders in that folder, as well.
:::info A Box instance can contain Petabytes of files, and folders can contain millions of files. Be intentional when choosing what folders you choose to index. And we recommend never getting all files from folder 0 recursively. Folder ID 0 is your root folder. :::
Load files
import os
from langchain_box.document_loaders import BoxLoader
os.environ["BOX_DEVELOPER_TOKEN"] = "df21df2df21df2d1f21df2df1"
loader = BoxLoader(
box_file_ids=["12345", "67890"],
character_limit=10000 # Optional. Defaults to no limit
)
docs = loader.lazy_load()
Load from folder
import os
from langchain_box.document_loaders import BoxLoader
os.environ["BOX_DEVELOPER_TOKEN"] = "df21df2df21df2d1f21df2df1"
loader = BoxLoader(
box_folder_id="12345",
recursive=False, # Optional. return entire tree, defaults to False
character_limit=10000 # Optional. Defaults to no limit
)
docs = loader.lazy_load()
Metadata
Release files for langchain-box 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| langchain_box-0.3.2.tar.gz | 19.5 kB | Without provenance | Details for langchain_box-0.3.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| langchain_box-0.3.2-py3-none-any.whl | Python 3 | none | any | Details for langchain_box-0.3.2-py3-none-any.whl |
Total release size: 43.8 kB
Release files / langchain_box-0.3.2.tar.gz
| Download URL | langchain_box-0.3.2.tar.gz |
|---|---|
| Size | 19.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eafed872f41abcf647adcab37ead94e92166d99ccacbbe4de826ad2ba7fb8506
|
|
BLAKE2b-256 checksum How to use checksums |
9e7bf87e8fcd5794cc1fd79ac5fb50102e5b3016a3e48448dfe46690677ebd57
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Release files / langchain_box-0.3.2-py3-none-any.whl
| Download URL | langchain_box-0.3.2-py3-none-any.whl |
|---|---|
| Size | 24.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
610f8ee0acec67cfd3d619cdb0e9e84872376fdb3f0b388266e2fc0bd82809b1
|
|
BLAKE2b-256 checksum How to use checksums |
ed41e1716d9ab81b29f6a3136faee8bfe230e012d10d6892347989ca499beba8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Security for langchain-box 0.3.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.