Skip to content

docs: Additional (Optional) configuration for external document loader #812

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs: Additional (Optional) configuration for external document loader #812

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
77 changes: 77 additions & 0 deletions docs/getting-started/env-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1824,6 +1824,83 @@ Note: this configuration assumes that AWS credentials will be available to your
- Description: Sets the API key for authenticating with the external document loader service.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_HTTP_METHOD`

- Type: `str`
- Default: `PUT`
- Description: HTTP method for external document loader requests.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_ENDPOINT`

- Type: `str`
- Default: `/process`
- Description: API endpoint path for the external document loader.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_REQUEST_FORMAT`

- Type: `str`
- Default: `binary`
- Description: Request format for document uploads. Options: `binary`, `multipart`, `base64`.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_FILE_FIELD_NAME`

- Type: `str`
- Default: `file`
- Description: Form field name for the file in multipart requests.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_FILENAME_FIELD_NAME`

- Type: `str`
- Default: `""`
- Description: Optional separate form field name for the filename in multipart requests.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_PARAMS`

- Type: `dict`
- Default: `{}`
- Description: JSON object for additional request body parameters.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_QUERY_PARAMS`

- Type: `dict`
- Default: `{}`
- Description: JSON object for URL query parameters.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_HEADERS`

- Type: `dict`
- Default: `{}`
- Description: JSON object for custom HTTP headers.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_RESPONSE_CONTENT_PATH`

- Type: `str`
- Default: `page_content`
- Description: JSON path to extract content from the response.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_RESPONSE_METADATA_PATH`

- Type: `str`
- Default: `metadata`
- Description: JSON path to extract metadata from the response.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `EXTERNAL_DOCUMENT_LOADER_RESPONSE_TYPE`

- Type: `str`
- Default: `object`
- Description: Response format type. Options: `object`, `array`.
- Persistence: This environment variable is a `PersistentConfig` variable.

#### `TIKA_SERVER_URL`

- Type: `str`
Expand Down