0% found this document useful (0 votes)
65 views2 pages

API Requirements

Uploaded by

mansoortariq9
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
65 views2 pages

API Requirements

Uploaded by

mansoortariq9
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd

Description of the New Process

1. Create a New Column to Store the Text Content

2. Whenever a New Document is Uploaded or Updated:

- A background job will be dispatched that will call the export text API on the word
processor and store the text response in the database.

3. Change the Documents API Response:

- It will exclude the SFDT content and text content to speed up the process and minimize
the data sent to the frontend.

4. Single Document API Response:

- SFDT content will only be sent in the single document API response to load the document
in the document editor.

5. Word Processor APIs:

- These APIs also need to have database access to get the SFDT content for specific
documents to export the documents as PDF, DOCX.

API Requirements Table


API Endpoint Requires Full Document Requires Full Document
Text Content SFDT

ai/document/query/ ✓
conflicting-terms

ai/document/query/ ✓
inconsistencies

ai/document/query/ ✓
inconsistent-definitions

ai/document/query/ ✓
mismatching-details

ai/chat/query ✓

ai/action/create-tasks ✓

ai/action/meeting-minutes ✓
ai/action/draft-an-email ✓

ai/action/summarise ✓

wordprocessor/exportsfdt ✓

wordprocessor/exportpdf ✓

ai/document/query/ ✓
ambiguities

ai/document/query/ ✓
undefined-terms

ai/document/query/ ✓
complex-language

ai/document/query/non- ✓
standard-clauses

ai/document/query/find- ✓
placeholders

ai/document/query/ ✓
missing-clauses

ai/document/query/points- ✓
to-negotiate

templates/ ✓

ai/draft/explain_this ✓

ai/draft/summarizer ✓

ai/draft/ ✓
complexify_language

ai/draft/simplify_language ✓

ai/draft/make_shorter ✓

ai/draft/make_longer ✓

ai/draft/write_definition ✓

ai/draft/write_clause ✓

You might also like