yujunjun/unstructured
1
0
Fork 0
mirror of https://github.com/Unstructured-IO/unstructured.git synced 2025-07-03 23:20:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
unstructured/docs/source/api.rst

33 lines
1.4 KiB
ReStructuredText
Raw Normal View History

docs: Add Unstructured API documentation (#928) * fran-unstructured/Add unstructured API documentation * fran-unstructured/add api docs to index.rst * fran-unstructured/add api docs with changes requested
2023-07-14 14:28:57 -04:00
Unstructured API
#################
Reorganized the Examples section in Documentation & add Databricks example (#1855) To test: > cd docs && make html Change logs: * Examples are reorganized to have its own page * Removed two old examples, ie. "file-utils" & "sentiment analysis". * Added two examples: "RAG with Unstructured, LangChain, and ChromaDB" & "Multi-Files Processing with S3 Connector and API" * Reorganized and added detailed API documentation: (i) usage, (ii) SDKs, (iii) Azure Marketplace, (iv) AWS Marketplace, (v) parameters and validation errors
2023-11-29 17:24:43 -08:00
Try our hosted API! You can get your API key `here <https://unstructured.io/api-key>`__ now and start using it today.
docs: Add Unstructured API documentation (#928) * fran-unstructured/Add unstructured API documentation * fran-unstructured/add api docs to index.rst * fran-unstructured/add api docs with changes requested
2023-07-14 14:28:57 -04:00
Reorganized the Examples section in Documentation & add Databricks example (#1855) To test: > cd docs && make html Change logs: * Examples are reorganized to have its own page * Removed two old examples, ie. "file-utils" & "sentiment analysis". * Added two examples: "RAG with Unstructured, LangChain, and ChromaDB" & "Multi-Files Processing with S3 Connector and API" * Reorganized and added detailed API documentation: (i) usage, (ii) SDKs, (iii) Azure Marketplace, (iv) AWS Marketplace, (v) parameters and validation errors
2023-11-29 17:24:43 -08:00
You will find a more comprehensive overview of the API capabilities. For detailed information on request and response schemas, refer to the `API documentation <https://api.unstructured.io/general/docs#/>`__.
docs: Add Unstructured API documentation (#928) * fran-unstructured/Add unstructured API documentation * fran-unstructured/add api docs to index.rst * fran-unstructured/add api docs with changes requested
2023-07-14 14:28:57 -04:00
Fixed Sphinx warning errors (#1438) Fixed issue #1437 - resolved the Warning errors when building sphinx with `make html`. test: 1. `cd docs` folder and `rm -rf build` 2. `pip install -r requirements.txt` 3. run `make html`
2023-09-25 21:20:16 -07:00
NOTE: You can also host the API locally. For more information check the `Using the API Locally <https://github.com/Unstructured-IO/unstructured-api>`__ section.
docs: Add Unstructured API documentation (#928) * fran-unstructured/Add unstructured API documentation * fran-unstructured/add api docs to index.rst * fran-unstructured/add api docs with changes requested
2023-07-14 14:28:57 -04:00
Supported File Types
*********************
========== ========================================================================================================
Category Output
========== ========================================================================================================
Plaintext ``.eml``, ``.html``, ``.json``, ``.md``, ``.msg``, ``.rst``, ``.rtf``, ``.txt``, ``.xml``
Images ``.jpeg``, ``.png``
Documents. ``.csv``, ``.doc``, ``.docx``, ``.epub``, ``.odt``, ``.pdf``, ``.ppt``, ``.pptx``, ``.tsv``, ``.xlsx``
========== ========================================================================================================
NOTE: Currently, the pipeline is capable of recognizing the file type and choosing the relevant partition function to process the file.
Reorganized the Examples section in Documentation & add Databricks example (#1855) To test: > cd docs && make html Change logs: * Examples are reorganized to have its own page * Removed two old examples, ie. "file-utils" & "sentiment analysis". * Added two examples: "RAG with Unstructured, LangChain, and ChromaDB" & "Multi-Files Processing with S3 Connector and API" * Reorganized and added detailed API documentation: (i) usage, (ii) SDKs, (iii) Azure Marketplace, (iv) AWS Marketplace, (v) parameters and validation errors
2023-11-29 17:24:43 -08:00
.. toctree::
:maxdepth: 1
doc: update API doc to sync with new parameter in prod API (#1020) * sync readme
2023-08-01 19:47:32 -04:00
Reorganized the Examples section in Documentation & add Databricks example (#1855) To test: > cd docs && make html Change logs: * Examples are reorganized to have its own page * Removed two old examples, ie. "file-utils" & "sentiment analysis". * Added two examples: "RAG with Unstructured, LangChain, and ChromaDB" & "Multi-Files Processing with S3 Connector and API" * Reorganized and added detailed API documentation: (i) usage, (ii) SDKs, (iii) Azure Marketplace, (iv) AWS Marketplace, (v) parameters and validation errors
2023-11-29 17:24:43 -08:00
apis/api_sdks
apis/usage_methods
apis/azure_marketplace
apis/api_parameters
apis/validation_errors
Reference in New Issue Copy Permalink