Connectors Reference
Provides API access to Artificial Intelligence, NLP, Machine Translation and more. Specially designed AI and NLP functions for legal industry
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Translate_Text ([internal]string Content-Type, Send translation request send translation request) |
Translate Text |
|
Translate Documents |
|
|
Document Similarity NLP |
|
|
Top Keywords |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Translate Text
Description: Translates text from target language to source language
Syntax:
LegalBotAITools.Translate_Text ([internal]string Content-Type, Send translation request send translation request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string Values: [application/json] |
content type of the request |
True |
|
|
send translation request |
|
|
True |
Returns:
Summary: Translate Documents
Description: Translates file content from source language to target language.
Syntax:
LegalBotAITools.Translate_Documents ([internal]string Content-Type, Send document translation request Send document translation request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string Values: [application/json] |
content type of the request |
True |
|
|
Send document translation request |
Send document translation request
|
|
True |
Returns:
Type:Receive document translation request
Summary: Document Similarity NLP
Description: Calculates the similarity of two documents using Natural Language Processing
Syntax:
LegalBotAITools.Document_Similarity_NLP ([internal]string Content-Type, Send NLP document similarity Document similarity with NLP)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string Values: [application/json] |
content type of the request |
True |
|
|
Document similarity with NLP |
|
|
True |
Returns:
Type:Receive NLP document similarity
Summary: Top Keywords
Description: Extracts and returns the top N keywords from a document.
Syntax:
LegalBotAITools.Top_Keywords ([internal]string Content-Type, Send top N keywords request send top N keywords request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string Values: [application/json] |
content type of the request |
True |
|
|
send top N keywords request |
|
|
True |
Returns:
Type:Receive NLP keywords
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
string
|
|
|
document_link |
string
|
|
|
transactionID |
string
|
|
|
fileName |
string
|
|
|
credits_used |
integer
|
|
|
credits_remaining |
integer
|
|
|
insufficient_credits |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
string
|
|
|
similarity |
number
|
|
|
transactionID |
string
|
|
|
text_analysed |
string
|
|
|
credits_used |
integer
|
|
|
credits_remaining |
integer
|
|
|
insufficient_credit |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
string
|
|
|
top_keywords |
array of (string)
|
|
|
transactionID |
string
|
|
|
credits_used |
integer
|
|
|
credits_remaining |
integer
|
|
|
insufficient_credits |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
message |
string
|
|
|
transactionID |
string
|
|
|
TranslatedText |
string
|
|
|
credits_used |
integer
|
|
|
credits_remaining |
integer
|
|
|
insufficient_credits |
boolean
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
source_language |
string
|
The source language of the document. Language codes follow ISO 639-1 Code two letter format other than Chinese simplified: zh-Hans and Chinese traditional: zh-Hant. Source language may be in Auto. It is also possible to write the English version of the name e.g. English, German, French, Russian. It is possible to specify Auto as a value. |
|
target_language |
string
|
The target language you want the document translated into. Language codes follow ISO 639-1 Code two letter format other than Chinese simplified: zh-Hans and Chinese traditional: zh-Hant. Source language may be in Auto. It is also possible to write the English version of the name e.g. English, German, French, Russian. |
|
file |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fileContent |
string
|
The file content of the document in Base64 string format. The file can be in HTML, PDF, .docx, .doc, .odt, .rtf, .txt, .pptx, .ppt, .xlsx format. |
|
name |
string
|
The name of the file with extension |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
clean |
boolean
|
If set to true the text to be analyzed will be cleaned from punctuation, excessive white space and turned into lower case according to LegalBot.io model Values: [, ] |
|
use_stopwords |
boolean
|
If set to true the text will be processed to remove words which do not contain important significance Values: [, ] |
|
stop_word_model |
string
|
The LegalBot.io custom stop word model to use when processing the document. Values: [None, Basic, Legal_v1, user_only] |
|
user_defined_stopwords |
string
|
User specific stop words to remove from the string. Each word separated by comma. |
|
lemmatize |
boolean
|
If set to true each word will be processed to change the word to its root word or lemma e.g. runs, running, ran = run Values: [, ] |
|
stemming |
boolean
|
If set to true each word will be processed to the word to its stem word e.g. intelligent = intellig Values: [, ] |
|
exclude_words_shorter_than |
integer
|
Excludes words from analysis if their string length is shorter than number specified |
|
file1 |
|
|
|
file2 |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fileContent |
string
|
File content of the first document. File can be in HTML, PDF, .docx, .doc, .odt, .rtf or .txt format. File must be converted to Base64 string format. |
|
name |
string
|
The name of the first file |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fileContent |
string
|
File content of the second document. File can be in HTML, PDF, .docx, .doc, .odt, .rtf or .txt format. File must be converted to Base64 string format. |
|
name |
string
|
The name of the second file |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
clean |
boolean
|
If set to true the text to be analyzed will be cleaned from punctuation, excessive white space and turned into lower case according to LegalBot.io model Values: [, ] |
|
use_stopwords |
boolean
|
If set to true the text will be processed to remove words which do not contain important significance Values: [, ] |
|
stop_word_model |
string
|
The LegalBot.io custom stop word model to use when processing the document. Values: [None, Basic, Legal_v1, user_only] |
|
user_defined_stopwords |
string
|
User specific stop words to remove from the string. Each word separated by comma. |
|
num_keywords |
integer
|
The number of keywords to return |
|
key_word_model |
string
|
The NLP keyword extraction model to use. "word" or "noun" keywords Values: [word, noun] |
|
exclude_words_shorter_than |
integer
|
Excludes words from analysis if their string length is shorter than number specified |
|
file |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fileContent |
string
|
File content of the first document. File can be in HTML, PDF, .docx, .doc, .odt, .rtf or .txt format. File must be converted to Base64 string format. |
|
name |
string
|
The name of the file |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
target_language |
string
|
The target language to translate the text into. Language codes follow ISO 639-1 Code two letter format other than Chinese simplified: zh-Hans and Chinese traditional: zh-Hant. Source language may be in Auto. It is also possible to write the English version of the name e.g. English, German, French, Russian |
|
source_language |
string
|
The source language of the text. Language codes follow ISO 639-1 Code two letter format other than Chinese simplified: zh-Hans and Chinese traditional: zh-Hant. Source language may be in Auto. It is also possible to write the English version of the name e.g. English, German, French, Russian. It is possible to specify Auto as a value. |
|
text_to_translate |
string
|
This is the text you want translated |