# FutureSmart Document Intelligence

> Ingest documents, read the fields extracted from them, and ask questions across a collection.

Every page below is also available as markdown: append `.md` to its URL.


## Docs

- [Overview](https://developers.futuresmart.ai/document-intelligence/): What the Document Intelligence API does, and where to start.
- [Quickstart](https://developers.futuresmart.ai/document-intelligence/quickstart/): Add a document and ask a question - two calls.
- [Errors](https://developers.futuresmart.ai/document-intelligence/errors/): Every error code, what causes it, and whether retrying helps.
- [Rate limits](https://developers.futuresmart.ai/document-intelligence/rate-limits/): How fast you may call, and what a 429 looks like.
- [Changelog](https://developers.futuresmart.ai/document-intelligence/changelog/): Every change to v1, dated.

## Guides

- [Collections](https://developers.futuresmart.ai/document-intelligence/guides/collections/): What a collection is, and where your collection_id comes from.
- [Ingesting documents](https://developers.futuresmart.ai/document-intelligence/guides/ingesting-documents/): The three document sources, jobs, and how to know ingestion finished.
- [Field schema](https://developers.futuresmart.ai/document-intelligence/guides/field-schema/): Choosing which fields get extracted from your documents.
- [Extracted fields](https://developers.futuresmart.ai/document-intelligence/guides/extracted-fields/): Reading the fields pulled out of a document.
- [Search and chat](https://developers.futuresmart.ai/document-intelligence/guides/search-and-chat/): Finding passages versus getting a written answer.

## Reference

- [All endpoints](https://developers.futuresmart.ai/document-intelligence/reference/): Every endpoint in v1, generated from the OpenAPI spec.

## Documents

- [Add documents](https://developers.futuresmart.ai/document-intelligence/reference/documents-add-documents/): Add one document or many
- [List documents](https://developers.futuresmart.ai/document-intelligence/reference/documents-list-documents/): The documents in a collection, a page at a time, newest first
- [Upload document files](https://developers.futuresmart.ai/document-intelligence/reference/documents-upload-document-files/): Upload one or more files whose bytes live on local disk, as `multipart/form-data` under the field name `files`
- [Get upload URLs](https://developers.futuresmart.ai/document-intelligence/reference/documents-get-upload-urls/): Step 1 of a three-step upload for large files
- [Get extracted fields](https://developers.futuresmart.ai/document-intelligence/reference/documents-get-extracted-fields/): The fields extracted from one document
- [Delete a document](https://developers.futuresmart.ai/document-intelligence/reference/documents-delete-a-document/): Remove one document from a collection

## Field schema

- [Get a collection's fields](https://developers.futuresmart.ai/document-intelligence/reference/fields-get-a-collection-s-fields/): The extraction schema for a collection - every field it pulls out of a document, with its type and settings
- [Add fields](https://developers.futuresmart.ai/document-intelligence/reference/fields-add-fields/): Add new fields to a collection's extraction schema
- [Update or add fields](https://developers.futuresmart.ai/document-intelligence/reference/fields-update-or-add-fields/): Update the fields named in the body (create any that do not exist yet)
- [Replace the custom fields](https://developers.futuresmart.ai/document-intelligence/reference/fields-replace-the-custom-fields/): Replace a collection's custom fields with exactly the set in the body - fields you omit are removed, the rest are updated or created
- [Remove fields](https://developers.futuresmart.ai/document-intelligence/reference/fields-remove-fields/): Remove fields from a collection's schema by name

## Jobs

- [Get a job](https://developers.futuresmart.ai/document-intelligence/reference/jobs-get-a-job/): How is the work going that a `202` accepted?

## Search and chat

- [Search a collection](https://developers.futuresmart.ai/document-intelligence/reference/retrieval-search-a-collection/): Find the passages in a collection that match a query
- [Ask a question](https://developers.futuresmart.ai/document-intelligence/reference/retrieval-ask-a-question/): Ask a question across a collection and get a written answer plus the passages it was drawn from