Find Similar
curl --request POST \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_id": "<string>",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"text": "<string>",
"libraries": [
{
"id": "<string>",
"document_classes": [
"<string>"
]
}
],
"similarity_threshold": 0.7,
"absolute_duplicates_only": false,
"max_results": 10,
"include": {
"text": true
}
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar"
payload = {
"document_id": "<string>",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"text": "<string>",
"libraries": [
{
"id": "<string>",
"document_classes": ["<string>"]
}
],
"similarity_threshold": 0.7,
"absolute_duplicates_only": False,
"max_results": 10,
"include": { "text": True }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document_id: '<string>',
attachment_filters: [{name: '<string>', id: '<string>', mime_type: '<string>'}],
text: '<string>',
libraries: [{id: '<string>', document_classes: ['<string>']}],
similarity_threshold: 0.7,
absolute_duplicates_only: false,
max_results: 10,
include: {text: true}
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_id' => '<string>',
'attachment_filters' => [
[
'name' => '<string>',
'id' => '<string>',
'mime_type' => '<string>'
]
],
'text' => '<string>',
'libraries' => [
[
'id' => '<string>',
'document_classes' => [
'<string>'
]
]
],
'similarity_threshold' => 0.7,
'absolute_duplicates_only' => false,
'max_results' => 10,
'include' => [
'text' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar"
payload := strings.NewReader("{\n \"document_id\": \"<string>\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"libraries\": [\n {\n \"id\": \"<string>\",\n \"document_classes\": [\n \"<string>\"\n ]\n }\n ],\n \"similarity_threshold\": 0.7,\n \"absolute_duplicates_only\": false,\n \"max_results\": 10,\n \"include\": {\n \"text\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_id\": \"<string>\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"libraries\": [\n {\n \"id\": \"<string>\",\n \"document_classes\": [\n \"<string>\"\n ]\n }\n ],\n \"similarity_threshold\": 0.7,\n \"absolute_duplicates_only\": false,\n \"max_results\": 10,\n \"include\": {\n \"text\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_id\": \"<string>\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"libraries\": [\n {\n \"id\": \"<string>\",\n \"document_classes\": [\n \"<string>\"\n ]\n }\n ],\n \"similarity_threshold\": 0.7,\n \"absolute_duplicates_only\": false,\n \"max_results\": 10,\n \"include\": {\n \"text\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"similar_documents": [
{
"library_id": "<string>",
"document_id": "<string>",
"document_title": "<string>",
"document_link": "<string>",
"similarity_score": 123,
"quoted_text": "<string>",
"attachment_id": "<string>",
"attachment_name": "<string>",
"attachment_mime_type": "<string>",
"attachment_link": "<string>",
"location_info": "<string>",
"location_type": "<string>",
"absolute_duplicate": false
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}document_similarity
Find Similar
Finds similar documents to the given document ID within the tenant’s document repository.
When searching by document, exact attachment-MD5 matches are prioritized and semantic matches fill any
remaining result slots up to max_results.
POST
/
assistant
/
api
/
v1
/
tenants
/
{tenant}
/
documents:findSimilar
Find Similar
curl --request POST \
--url https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_id": "<string>",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"text": "<string>",
"libraries": [
{
"id": "<string>",
"document_classes": [
"<string>"
]
}
],
"similarity_threshold": 0.7,
"absolute_duplicates_only": false,
"max_results": 10,
"include": {
"text": true
}
}
'import requests
url = "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar"
payload = {
"document_id": "<string>",
"attachment_filters": [
{
"name": "<string>",
"id": "<string>",
"mime_type": "<string>"
}
],
"text": "<string>",
"libraries": [
{
"id": "<string>",
"document_classes": ["<string>"]
}
],
"similarity_threshold": 0.7,
"absolute_duplicates_only": False,
"max_results": 10,
"include": { "text": True }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document_id: '<string>',
attachment_filters: [{name: '<string>', id: '<string>', mime_type: '<string>'}],
text: '<string>',
libraries: [{id: '<string>', document_classes: ['<string>']}],
similarity_threshold: 0.7,
absolute_duplicates_only: false,
max_results: 10,
include: {text: true}
})
};
fetch('https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_id' => '<string>',
'attachment_filters' => [
[
'name' => '<string>',
'id' => '<string>',
'mime_type' => '<string>'
]
],
'text' => '<string>',
'libraries' => [
[
'id' => '<string>',
'document_classes' => [
'<string>'
]
]
],
'similarity_threshold' => 0.7,
'absolute_duplicates_only' => false,
'max_results' => 10,
'include' => [
'text' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar"
payload := strings.NewReader("{\n \"document_id\": \"<string>\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"libraries\": [\n {\n \"id\": \"<string>\",\n \"document_classes\": [\n \"<string>\"\n ]\n }\n ],\n \"similarity_threshold\": 0.7,\n \"absolute_duplicates_only\": false,\n \"max_results\": 10,\n \"include\": {\n \"text\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_id\": \"<string>\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"libraries\": [\n {\n \"id\": \"<string>\",\n \"document_classes\": [\n \"<string>\"\n ]\n }\n ],\n \"similarity_threshold\": 0.7,\n \"absolute_duplicates_only\": false,\n \"max_results\": 10,\n \"include\": {\n \"text\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://document-assistant.us.aodocs.app/assistant/api/v1/tenants/{tenant}/documents:findSimilar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_id\": \"<string>\",\n \"attachment_filters\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"mime_type\": \"<string>\"\n }\n ],\n \"text\": \"<string>\",\n \"libraries\": [\n {\n \"id\": \"<string>\",\n \"document_classes\": [\n \"<string>\"\n ]\n }\n ],\n \"similarity_threshold\": 0.7,\n \"absolute_duplicates_only\": false,\n \"max_results\": 10,\n \"include\": {\n \"text\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"similar_documents": [
{
"library_id": "<string>",
"document_id": "<string>",
"document_title": "<string>",
"document_link": "<string>",
"similarity_score": 123,
"quoted_text": "<string>",
"attachment_id": "<string>",
"attachment_name": "<string>",
"attachment_mime_type": "<string>",
"attachment_link": "<string>",
"location_info": "<string>",
"location_type": "<string>",
"absolute_duplicate": false
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The domain of the customer
Example:
"example.com"
Body
application/json
The document ID to find similar documents for. Mutually exclusive with text.
List of attachment filters within the document to consider for finding similar documents. If provided then only the attachments matching one of the rules are used otherwise all attachments will be used. It can be used only if the document_id field is provided.
Show child attributes
Show child attributes
Finds similar documents to this text. Mutually exclusive with document_id.
List of libraries to limit the search for similar documents. If None, then all libraries will be searched.
Show child attributes
Show child attributes
The similarity threshold (between 0 and 1) above which documents are considered similar. Higher values mean more similar documents. Ignored when 'absolute_duplicates_only' is true.
Required range:
0 <= x <= 1If true, return only absolute duplicates (documents sharing an attachment MD5 checksum with the source document); 'similarity_threshold' is ignored. If false, absolute duplicates are returned first and semantically-similar matches are used to fill any remaining result slots up to 'max_results'. Can only be used together with 'document_id'.
The maximum number of similar documents to return.
Which fields to include in the results
Show child attributes
Show child attributes
Response
Successful Response
List of similar documents found.
Show child attributes
Show child attributes