Answer Bot API

Answer Bot API makes it possible for the system to read, infer meaning, and deliver precise answers from large sets of documents with high accuracy.

Search from Q&A

POST https://backend.alli.ai/webapi/faq

This API lets you find the most relevant question and answer pairs from your Q&A knowledge base.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to specify a user who makes this API call, you can provide the user's ID here. It can be a new one or be found in the Conversations menu in your dashboard.

USER-EMAIL

string

If you want to update the user's email when using OWN-USER-ID, you can provide the new email address here.

Request Body

Name
Type
Description

autoRegisterCandidates

boolean

The default value is true. When this option has set false, it'll not automatically register the query to candidates when there was no answer for the given query.

hashtagsOperator

string

Either AND or OR. Choose AND if you want each returned result to contain all hashtags. Choose OR if you want each returned result to contain at least one of the hashtags.

hashtags

array

An array of all the hashtags that you would like to appear.

maxResults

integer

The maximum number of results to be returned.

query

string

This is a query string.

format

string

html or text. If it's text, the return value will be in plain text. If it's html, it will return html. If your answer contains styled html, such as different font size and color, you can use html. If you simply want to get an answer as a text, you can use the text. The default value is html.

{"result": 
  [
    {
      "confidence": CONFIDENCE_VALUE, 
      "effectiveConfidence": EFFECTIVE_CONFIDENCE_VALUE, 
      "question": "QUESTION_1", 
      "answer": "ANSWER_1",
      "id": "ID_1",
      "hashtags": [],
      "lastUpdatedDate": "DATE",
      "agentFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
              },
      "userFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
              }
    }, ... 
  ],
  "count": 3,
  "hashId": "HASH_ID"
}

Search from Documents

POST https://backend.alli.ai/webapi/mrc

Documents API finds an answer from your unstructured text documents and even from complex tables.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to specify a user who makes this API call, you can provide the user's ID here. It can be a new one or be found in the Conversations menu in your dashboard.

USER-EMAIL

string

If you want to update the user's email when using OWN-USER-ID, you can provide the new email address here.

Request Body

Name
Type
Description

returnPreview

boolean

If true, the html body and css will be returned for each search result. The default value is false. Note: This parameter will be deprecated on 12/9/2021 due to technical changes made to the preview feature.

autoRegisterCandidates

boolean

The default value is true. When this option has set false, it'll not automatically register the query to candidates when there was no answer for the given query.

hashtagsOperator

string

Either AND or OR. Choose AND if you want each returned result's document to have all of the specified hashtags. Choose OR if you want each returned result's document to have at least one of the specified hashtag.

maxResults

integer

Number of results to see

query

string

This is a query string.

hashtags

array

Documents you uploaded to the dashboard have hashtags. You can set the search scope to these hash-tagged documents.

format

string

It can be 'html' or 'text'. If it's text, the return value will be in plain text. If it's html, it will return html. If your answer contains styled html, such as different font size and color, you can use html. If you simply want to get an answer as a text, you can use the text.

{
    "result": [
        {
            "answer": "ANSWER_1",
            "answerHash": "ANSWER_HASH_1",
            "confidence": CONFIDENCE_1,
            "effectiveConfidence": EFFECTIVE_CONFIDENCE_1,
            "documentId": "DOCUMENT_ID_1",
            "documentName": "DOCUMENT_NAME_1",
            "hashtags": [],
            "pageNo": PAGE_NUMBER,
            "createdDate": "DATE",
            "agentFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "userFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "body": "PREVIEW_HTML_BODY",
            "css": "PREVIEW_CSS"
        }
    ]
}

Get Single Q&A

GET https://backend.alli.ai/webapi/single_faq

This is the method to get all the details of a single Q&A.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

id

string

The id of the FAQ you are looking for.

format

string

The format of the answer value for this FAQ. Default is HTML.

{
    "result": {
        "question": "Who is there?",
        "answer": "Elmo",
        "id": "RkFROjYwMmY2ZTQ0YWZmMWQ5YmQ0NmM5Y2VkNw==",
        "userFeedback": {
            "positiveCount": 0,
            "negativeCount": 0
        },
        "agentFeedback": {
            "positiveCount": 0,
            "negativeCount": 1
        },
        "lastUpdatedDate": "2021-02-19",
        "createdDate": "2021-02-19",
        "hashtags": []
    }
}

Get Single Document

GET https://backend.alli.ai/webapi/single_document

This is the method to get all details of a single document.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

id

string

The id of the document.

      "id": "S25vd2xlZGdlQmFzZTo1ZjMzODFkZmNhYWJjYWUyMjkzYjFhY2U=",
      "documentName": "Policy document 1.docx",
      "createdDate": "2020-11-12",
      "agentFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
            },
            "userFeedback": {
            "positiveCount": 0,
            "negativeCount": 0
        },
      "hashtags" : ["hashtag1", "hashtag2"]
    }
}

Q&A Feedbacks

GET https://backend.alli.ai/webapi/faq_feedbacks

This API lets you get the list of feedbacks given to Q&A pairs for each search query.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to only see feedbacks given by a specific agent, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to only see feedbacks given by a specific user, you can provide the user's ID here. It can be found in the Conversations menu in your dashboard.

Request Body

Name
Type
Description

offset

integer

offset allows you to specify the ranking number of the first item on the page.

limit

integer

limit allows you to set the number of objects returned on one page. The maximum value is 100.

{
  "result": [
    {
      "query": "QUERY_1",
      "feedbacks": [
        {
          "faqId": "FAQ_ID_1_1", 
          "positive": true or false
        }, ...
      ]
    }, ...
  ],
  "count": COUNT_1
}

Q&A Feedback

POST https://backend.alli.ai/webapi/faq_feedback

This API lets you give or cancel feedback given to a Q&A pair for a search query.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

Request Body

Name
Type
Description

query

string

The query you want to give or cancel feedback for, toward the Q&A.

id

string

The ID for the Q&A you want to give or cancel feedback for the query. It is created whenever a Q&A search happens and bound to the query and the Q&A pair. It can be retrieved using the Q&A API above.

isPositive

boolean

When the value is true, positive feedback is given to the Q&A for the query. When it's false, negative feedback is given. When it's null, it cancels the feedback.

{
    "result": {
        "faqTrainSearchResult": {
            "faq": {
                "id": "ID"
            },
            "agentFeedback": {
                "positiveCount": NUMBER,
                "negativeCount": NUMBER
            }
        }
    },
    "errors": null
}

Q&A User Feedback

POST https://backend.alli.ai/webapi/faq/user_feedback

The feedback registered with the above API will be submitted as user feedback. This API registers user feedback (user feedback is what the users who use the Alli chatbot and approve or disprove of answers submit).

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

OWN-USER-ID

string

If you want to specify a user who makes this API call, you can provide the user's ID here. It can be a new one or be found in the Conversations menu in your dashboard.

USER-EMAIL

string

If you want to update the user's email when using OWN-USER-ID, you can provide the new email address here.

Request Body

Name
Type
Description

prev

boolean

A boolean as to the previous feedback you'd assigned this query (only should be used to modify previous feedback)

positive

boolean

A boolean as to whether the feedback is positive or negative

query

string

The query that you made, that you're providing feedback for

id

string

The ID of the Q&A object you want to provide feedback (can be found in the "faq" field of the /webapi/faq response).

{
    "result": {
        "userFeedback": {
            "positiveCount": 1,
            "negativeCount": 0
        }
    }
}

Upload Q&As

POST https://backend.alli.ai/webapi/upload_faq_file

You can upload multiple Q&As in the tsv, csv, xlsx, and zip format using this API.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

Request Body

Name
Type
Description

file

string

Your local Q&A file location. xlsx, tsv, csv, and zip files are supported.

{
    "result": "success",
    "notUploaded": [
        {
            "question": "QUESTION_1",
            "state": "dup"
        },
        {
            "question": "QUESTION_2",
            "state": "up"
        }
    ]
}

Add Q&A

POST https://backend.alli.ai/webapi/register_faq

You can add a new Q&A or update an existing Q&A using this API.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

Request Body

Name
Type
Description

status

string

ON or OFF. When on, registered Q&A will be turned on for Q&A search.

question

string

The question part of the Q&A.

similarQuestions

array

Similar questions that has the same answer. You can add multiple similar questions.

answer

string

The answer part of the Q&A. If the same question exists in the database, this answer will replace the existing one.

hashtags

array

Hashtags added to the Q&A. You can add multiple hashtags.

memo

string

Memo on the Q&A to share with agents.

{
    "result": {
        "status": "created",
        "id": "Q&A_ID"
    },
    "errors": null
}

Delete Q&A

POST https://backend.alli.ai/webapi/delete_faq

You can delete a Q&A using this API.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

id

string

The ID of the Q&A you want to delete.

{
    "result": {
        "status": "deleted"
    },
    "errors": null
}

List Q&As

GET https://backend.alli.ai/webapi/faqs

You can list Q&As in the Knowledge Base using this API.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

searchTerm

string

Keyword search query to filter the list. You can use operators to run advanced searches. "TERM1 TERM2" for AND, "TERM1 OR TERM2" for OR, and "\"TERM\"" for exact match.

isUsed

boolean

If true, only turned-on Q&As will be listed, If false, only turned-off Q&As will.

hashtags

array

Hashtags to filter the list. You can add multiple hashtags.

hashtagsOperator

string

and or or. If it's and, hashtags filter for multiple hashtags works with AND logic. If or, OR logic.

createdByAgent

boolean

If true, the list will only include Q&As created by agents. If false, only the other Q&As will be included. Please note that createdByAgent, answeredByMrc, autoGenerated, editedByAgent filters are mutually exclusive, and OR logic is applied if two or more of them are used.

answeredByMrc

boolean

If true, the list will only include Q&As that are the answers are automatically extracted from uploaded Documents. If false, only the other Q&As will be included.

autoGenerated

boolean

If true, the list will only include auto-generated Q&As. If false, only the other Q&As will be included.

editedByAgent

boolean

If true, the list will only include Q&A's edited by any agent after registered. If false, only the other Q&As will be included.

format

string

html or text. If your answers contain styled html, such as different font size or color, you can use html to get answers in html format. If you simply want to get answers as a text, you can use the text. The default value is html.

offset

integer

offset allows you to specify the ranking number of the first item on the page.

limit

integer

limit allows you to set the number of objects returned on one page. The maximum and the default value is 1000.

{
    "offset": 0,
    "count": 10,
    "totalCount": 12,
    "results": [
        {
            "id": "Q&A_ID_1",
            "question": "QUESTION_1",
            "answer": "ANSWER_1",
            "hashtags": [
                "HASHTAG_1",
                "HASHTAG_2"
            ],
            "userFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "agentFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "lastUpdatedDate": "2021-05-04",
            "createdDate": "2021-02-23"
        },
        {
            "id": "Q&A_ID_2",
            "question": "QUESTION_2",
            "answer": "ANSWER_2",
            "hashtags": [
                "HASHTAG_1",
                "HASHTAG_3"
            ],
            "userFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "agentFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "lastUpdatedDate": "2021-05-04",
            "createdDate": "2021-02-23"
        }, ...
    ]
}

Q&A Candidates

GET https://backend.alli.ai/webapi/faq_candidates

Using this API, you can get the list of unanswered questions from customers. They're called Candidates.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

hashtags

array

Hashtag array if you want to limit the search scope to the given hashtags

searchTerm

string

Search query to filter the candidates to see. You can use operators to run advanced searches. "TERM1 TERM2" for AND, "TERM1 OR TERM2" for OR, and "\"TERM\"" for exact match.

order

string

How to order the candidates. You can use ATTRIBUTE_[DESC or ASC] format. ATTRIBUTE can be FREQUENCY or CREATED_AT.

state

string

Status of the candidates to see. It can be ALL or ACTIVE or ARCHIVED.

offset

integer

offset allows you to specify the ranking number of the first item on the page.

limit

integer

limit allows you to set the number of objects returned on one page. The maximum value is 100.

{
	"result": {
		"faqCandidates": [
		  {
				"id": "ID_ANSWER_1",
				"frequency": 1,
				"textAnswer": "ANSWER_1",
				"state": "ACTIVE",
				"createdAt": NUMBER,
				"questions": [{
					"id": "ID_QUESTION_1",
					"question": "QUESTION_1",
					"frequency": 1,
					"history": {
						"id": "ID_HISTORY_1"
					}
				}]
			},
		],
		"count": 1
	},
	"errors": null
}

Q&A Candidates

POST https://backend.alli.ai/webapi/add_faq_candidates

Registers a new Q&A Candidate with the system.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to specify a user who makes this API call, you can provide the user's ID here. It can be a new one or be found in the Conversations menu in your dashboard.

USER-EMAIL

string

If you want to update the user's email when using OWN-USER-ID, you can provide the new email address here.

Request Body

Name
Type
Description

queries

string

The list of all queries you would like to register

{
    "result": {
        "candidates": [
            {
                "id": "CANDIDATE_ID_1"
            },
            {
                "id": "CANDIDATE_ID_2"
            }
        ]
    },
    "errors": null
}

Documents Feedbacks

GET https://backend.alli.ai/webapi/mrc_feedbacks

This API lets you get the list of feedbacks given to Document search results (AI-extracted answers from uploaded documents) for each search query.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to only see feedbacks given by a specific agent, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to only see feedbacks given by a specific user, you can provide the user's ID here. It can be found in the Conversations menu in your dashboard.

Request Body

Name
Type
Description

offset

integer

offset allows you to specify the ranking number of the first item on the page.

limit

integer

limit allows you to set the number of objects returned on one page. The maximum value is 100.

{
  "result": [
    {
      "query": "QUERY_1",
      "feedbacks": [
        {
          "documentId": "DOCUMENT_ID_1",
          "answer": "ANSWER_1",
          "answerHash": "ANSWER_HASH_1",
          "positive": true or false
        }, ...
      ]
    }
  ],
  "count": NUMBER
}

Documents Search Feedback

POST https://backend.alli.ai/webapi/mrc_feedback

This API lets you give or cancel feedback given to a Document search result for a search query.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

Request Body

Name
Type
Description

query

string

The query you want to give or cancel feedback for, toward the extracted search result.

id

string

The ID for the document where the answer was extracted from.

answerHash

string

The ID of the Document search result you want to give or cancel feedback for the query. It is created whenever a Documents search happens and bound to the query and the answer pair. It can be retrieved using the Documents API above.

isPositive

boolean

When the value is true, positive feedback is given to the extracted answer for the query. When it's false, negative feedback is given. When it's null, it cancels the feedback.

{
    "result": {
        "mrcFeedbackSearchResult": {
            "agentFeedback": {
                "positiveCount": NUMBER,
                "negativeCount": NUMBER
            }
        }
    },
    "errors": null
}

Documents Search User Feedback

POST https://backend.alli.ai/webapi/mrc/user_feedback

Provide user feedback to the Documents search result.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

OWN-USER-ID

string

If you want to specify a user who makes this API call, you can provide the user's ID here. It can be a new one or be found in the Conversations menu in your dashboard.

USER-EMAIL

string

If you want to update the user's email when using OWN-USER-ID, you can provide the new email address here.

Request Body

Name
Type
Description

answerHash

string

The ID of the Document search result you want to give or cancel feedback for the query. It is created whenever a Documents search happens and bound to the query and the answer pair. It can be retrieved using the Documents API above.

answer

string

The answer that you received to your query from this document.

id

string

The ID for the document where the answer was extracted from.

positive

boolean

When the value is true, positive feedback is given to the extracted answer for the query. When it's false, negative feedback is given. When it's null, it cancels the feedback.

query

string

The query you want to give or cancel feedback for, toward the extracted search result.

{
    "result": {
        "userFeedback": {
            "positiveCount": 1,
            "negativeCount": 0
        }
    }
}

Upload Documents

POST https://backend.alli.ai/webapi/upload_file

This API method allows you to upload documents for Cognitive Search. Available file formats for the upload: PDF, TXT, MS Word, PowerPoint, Excel, HTM and HTML. To upload a HTML file with linked resources, please compress in a ZIP file along with any relative linked resources before uploading.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

Request Body

Name
Type
Description

file

string

Your local file location

hashtags

array

Hashtags for the uploading file

footerTitle

string

You can type in the source of the answer as a footer for search results from the uploaded file. The footer text will appear next to 'From' in search results.

footerUrl

string

You can put the URL you want to link to the footerTitle.

{
    "result": {
        "id": "DOCUMENT_ID",
        "fileName": "YOUR_FILE_NAME",
        "hashtags": [
            "HASHTAG_1",
            "HASHTAG_2"
        ],
        "footer": "FOOTER_IN_HTML"
    }
}

Upload Documents from S3

POST https://backend.alli.ai/webapi/upload_from_s3

This API lets you transfer documents stored in S3 into Cognitive Search. They will appear as Knowledge Base documents in the dashboard. Available file formats are same in the section of Upload Documents.

Headers

Name
Type
Description

API-KEY

string

Your API KEY can be found in your dashboard settings menu under the General Tab. Please keep in mind that you need to have a Cognitive Search API Key.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

Request Body

Name
Type
Description

footerTitle

string

You can type in the source of the answer as a footer for search results from the uploaded file. The footer text will appear next to 'From' in search results.

footerUrl

string

You can put the URL you want to link to the footerTitle.

hashtags

array

Hashtags for the document.

path

string

S3 path of the file. It should end with the file name. Don't include the bucket name

secretKey

string

Your S3 Secret Key.

accessKey

string

Your S3 Access Key.

bucket

string

Name of S3 bucket containing your file.

{
    "result": {
        "id": "DOCUMENT_ID",
        "fileName": "YOUR_FILE_NAME",
        "hashtags": [
            "HASHTAG_1",
            "HASHTAG_2"
        ],
        "footer": "FOOTER_IN_HTML"
    }
}

Check Document Status

GET https://backend.alli.ai/webapi/check_file_status

Once you upload documents through API, it is converted, parsed, and embedded as vectors. This API shows the status of the process for a document being uploaded.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

id

string

The document id to check the status

{"result": 
    {"id": "YOUR DOCUMENT ID", 
    "status": "initializing"}}

Delete Documents

POST https://backend.alli.ai/webapi/delete_file

This API lets you delete uploaded files.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

ids

array

The document IDs that you want to delete in the array format

{
    "result": {
        "ok": BOOLEAN
    },
    "errors": null
}

List Documents

GET https://backend.alli.ai/webapi/knowledge_bases

This API lets you list out the uploaded documents.

Query Parameters

Name
Type
Description

hashtagsSearchOperator

string

Either AND or OR, logical operator used to match multiple hashtags. Defaults to OR.

status

boolean

The on/off status of the document to filter the list.

searchTerm

string

Keyword search query to filter the list. You can use operators to run advanced searches. "TERM1 TERM2" for AND, "TERM1 OR TERM2" for OR, and "\"TERM\"" for exact match.

hashtags

array

Hashtag information to filter the list.

order

string

The order type of the list. Please see Request Example below to find possible order types.

offset

integer

offset allows you to specify the ranking number of the first item on the page.

limit

integer

limit allows you to set the number of objects returned on one page. The maximum value is 100.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

{
  "result": {
    "items": [
      {
        "id": "DOCUMENT_ID",
        "fileName": "FILENAME",
        "hashtag": ["HASHTAG_1", "HASHTAG_2"],
        "autoHashtag": ["AUTOHASHTAG_1"]
      }
    ]
  },
  "errors": null
}

Rename Documents (Knowledge Base)

POST https://backend.alli.ai/webapi/update_kb_name

This API lets you update the name for an uploaded document.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

filename

string

The new name for the specified document.

id

string

The document ID that you want to rename.

{
    "result": {
        "id": "DOCUMENT_ID",
        "filename": "FILENAME"
    }
}

Update Documents

POST https://backend.alli.ai/webapi/update_document

This API lets you update hashtags, footer title, and footer title link for a document.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

footerTitle

string

You can type in the source of the answer as a footer for search results from the uploaded file. The footer text will appear next to 'From' in search results.

footerUrl

string

You can put the URL you want to link to the footerTitle.

hashtags

array

List of string hashtags you want to add to the document

id

string

The id of the document you want to update

{
    "result": {
        "knowledgeBase": {
            "id": "DOCUMENT_ID",
            "hashtags": [
                "HASHTAG_1",
                "HASHTAG_2"
            ],
            "footer": "FOOTER_IN_HTML"
        }
    },
    "errors": null
}

Knowledge Base Toggle Status

POST https://backend.alli.ai/webapi/toggle_documents

This API lets you change the status of many documents (AKA knowledge bases) at once

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu under the General tab

Request Body

Name
Type
Description

use

boolean

Whether to turn all the status of all the knowledge bases to on (True) or off (False)

ids

array

This is a list of the ids of the knowledge bases that you want to toggle.

{
  "result": {
    "knowledgeBases": [
      {
        "id": "YOUR_FIRST_DOCUMENT_ID",
        "status": true or false
      },
      {
        "id": "YOUR_SECOND_DOCUMENT_ID",
        "status": true or false
      }
    ]
  },
  "errors": null
}

Knowledge Base Auto Hashtag (Classification)

POST https://backend.alli.ai/webapi/kb_auto_hashtag

This API lets you get the hashtag list with classification keywords for the documents.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

ids

array

The document ids you want to retrieve auto hashtags for

{
    "result": {
        "updated": [
            {
                "id": "DOCUMENT_ID",
                "autoHashtags": [
                    {
                        "id": "KNOWLEDGE_BASE_AUTO_HASHTAG_ID",
                        "state": "STATE",
                        "bestConfidence": NUMBER,
                        "autoHashtag": {
                            "hashtag": "HASHTAG_VALUE"
                        }
                    }
                ]
            }
        ]
    },
    "errors": null
}

Knowledge Base Auto Hashtag Feedback (Classification)

POST https://backend.alli.ai/webapi/kb_auto_hashtag_feedback

This API lets you approve or decline classification hashtags for documents

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

autoHashtagFeedbacks

array

List of JSON objects containing hashtag id/state pairs. 'state' can be one of: 'accepted', 'declined', 'suggested'

{
    "result": [
        {
            "id": "KNOWLEDGE_BASE_AUTO_HASHTAG_ID",
            "state": "STATE"
        },
        {
            "id": "KNOWLEDGE_BASE_AUTO_HASHTAG_ID_2",
            "state": "STATE"
        }
    ]
}

Select Answer

POST https://backend.alli.ai/webapi/faq/select_answer

This method should be used to simulate a user looking up a specific FAQ

Path Parameters

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

hashId

string

The id of the Q&A search return result

id

string

The id of the FAQ that you would like to select.

{"result": "Success"}

Agent Management

POST https://backend.alli.ai/webapi/agent_management

Used to create and delete agents from the project.

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

Request Body

Name
Type
Description

locale

string

The language setting of the account being created. Use a two-letter ISO 639-1 code.

password

string

Required when creating a new agent. Password must be valid (contain 3 out 4 following characters: lowercase, uppercase, numeric, non-alphanumeric)

deleteFlag

boolean

True if you want to delete an agent, False if you want to create

email

string

The email of the agent you want to create or delete

{
    "result": {
        "id" : "QWdlbnQ6NWZkMmFjMzIwODQ4MzY1ZDI4NWFjMGUw",
        "status": "deleted" 
    },
    "errors": null
}

Get All Hashtags

GET https://backend.alli.ai/webapi/hashtags

Gets all hashtags from both FAQs and MRCs

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

{
  "result": {
    "sample_tag1": 2,
   "sample_tag2": 1,
  }
}

Q&A Query History

GET https://backend.alli.ai/webapi/faq_histories

Returns the past Q&A Searches that have been done, both through the REST API and the Alli dashboard.

Query Parameters

Name
Type
Description

limit

integer

A limit on the number of results to show (used for pagination)

offset

integer

In the list of all results, the index from which to start listing results (used for pagination)

endDate

string

The latest date from which you want to get history (dates should be in the form YYYY-MM-DD)

startDate

string

The earliest date from which you want to get history (dates should be in the form YYYY-MM-DD)

order

string

Can either be DESC (meaning latest queries come first), or ASC (meaning earliest queries come first)

searchTerm

string

The term that should have appeared in the query

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to only see the query history of a specific agent, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to only see the query history of a specific user, you can provide the user's ID here. It can be found in the Conversations menu in your dashboard.

{
    "result": {
        "histories": [
            {
                "agent": {
                    "id": "QWdlbnQ6NjA0NmMyNWJmNTFjMmVlYjc4Mjg3Zjcy"
                },
                "question": "What is life?",
                "answers": [
                    {
                        "faq": {
                            "id": "RkFROjYwNDZjMmUxM2MzYmQ5MjVmMzgxMGNkOQ=="
                        },
                        "effectiveConfidence": 0.9999999999999927,
                        "confidence": 0.9999999999999927
                    }
                ]
            }
        ],
        "count": 1
    },
    "errors": null
}

Documents Query History

GET https://backend.alli.ai/webapi/mrc_histories

Returns the past Documents Searches that have been done, both through the REST API and the Alli dashboard.

Query Parameters

Name
Type
Description

searchTerm

string

The term that should have appeared in the query

order

string

Can either be DESC (meaning latest queries come first), or ASC (meaning earliest queries come first)

endDate

string

The latest date from which you want to get history (dates should be in the form YYYY-MM-DD)

startDate

string

The earliest date from which you want to get history (dates should be in the form YYYY-MM-DD)

limit

integer

A limit on the number of results to show (used for pagination)

offset

integer

In the list of all results, the index from which to start listing results (used for pagination)

Headers

Name
Type
Description

API-KEY

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to only see the query history of a specific agent, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to only see the query history of a specific user, you can provide the user's ID here. It can be found in the Conversations menu in your dashboard.

{
    "result": {
        "histories": [
            {
                "agent": {
                    "id": "QWdlbnQ6NWZiNzc5MGIwZjE3Zjc5ZmNiNzVlYzFh"
                },
                "question": "program memory of c004",
                "answers": [
                    {
                        "knowledgeBase": {
                            "id": "S25vd2xlZGdlQmFzZTo2MDUyODM0ODFiYzgxNDcwZTEzNGRjNDQ=",
                            "fileName": "specification_en.pdf"
                        },
                        "answer": "{\"blocks\": [{\"key\": \"kn13\", \"type\": \"unstyled\", \"text\": \"Type capacity program memory program memory - C004, B04KR: 80KB\", \"depth\": 0, \"inlineStyleRanges\": [], \"entityRanges\": [], \"data\": {}}, {\"key\": \"2vjf\", \"text\": \" \", \"type\": \"unstyled\", \"depth\": 0, \"inlineStyleRanges\": [], \"entityRanges\": [], \"data\": {}}, {\"key\": \"45cb\", \"text\": \"— From specification_en.pdf\", \"type\": \"unstyled\", \"depth\": 0, \"inlineStyleRanges\": [{\"offset\": 0, \"length\": 27, \"style\": \"ITALIC\"}], \"entityRanges\": [{\"offset\": 7, \"length\": 20, \"key\": 0}], \"data\": {}}], \"entityMap\": {\"0\": {\"type\": \"LINK\", \"mutability\": \"MUTABLE\", \"data\": {\"url\": \"https://staging-download.alli.ai/download_document/UHJvamVjdDo1ZmI3NzkwYjBmMTdmNzlmY2I3NWVjMWM=/S25vd2xlZGdlQmFzZTo2MDUyODM0ODFiYzgxNDcwZTEzNGRjNDQ=\"}}}}",
                        "answerHash": "6648c76e9be27864557f84ab7822cde8",
                        "answerFormat": "DRAFTJS",
                        "hashtags": [],
                        "feedbackAvailable": true,
                        "columnFilterValues": []
                    },
                    ...
                    {
                        "knowledgeBase": {
                            "id": "S25vd2xlZGdlQmFzZTo2MDUyODM0ODFiYzgxNDcwZTEzNGRjNDQ=",
                            "fileName": "specification_en.pdf"
                        },
                        "answer": "{\"blocks\": [{\"key\": \"87us\", \"type\": \"unstyled\", \"text\": \"Type capacity reload memory reload memory - C004, B04KR: 2048KB\", \"depth\": 0, \"inlineStyleRanges\": [], \"entityRanges\": [], \"data\": {}}, {\"key\": \"p0wr\", \"text\": \" \", \"type\": \"unstyled\", \"depth\": 0, \"inlineStyleRanges\": [], \"entityRanges\": [], \"data\": {}}, {\"key\": \"qpau\", \"text\": \"— From specification_en.pdf\", \"type\": \"unstyled\", \"depth\": 0, \"inlineStyleRanges\": [{\"offset\": 0, \"length\": 27, \"style\": \"ITALIC\"}], \"entityRanges\": [{\"offset\": 7, \"length\": 20, \"key\": 0}], \"data\": {}}], \"entityMap\": {\"0\": {\"type\": \"LINK\", \"mutability\": \"MUTABLE\", \"data\": {\"url\": \"https://staging-download.alli.ai/download_document/UHJvamVjdDo1ZmI3NzkwYjBmMTdmNzlmY2I3NWVjMWM=/S25vd2xlZGdlQmFzZTo2MDUyODM0ODFiYzgxNDcwZTEzNGRjNDQ=\"}}}}",
                        "answerHash": "9537b6560701930d079f39ced8be1b3e",
                        "answerFormat": "DRAFTJS",
                        "hashtags": [],
                        "feedbackAvailable": true,
                        "columnFilterValues": []
                    }
                ]
            }
        ],
        "count": 1
    },
    "errors": null
}

Uploading Q&A and Documents

Please sign up and sign in to the Alli dashboard first. You must select 'Cognitive Search' for the Project Type when you sign up. Go to the Q&A tab on the dashboard to upload question-answer pairs. If you want to upload unstructured text data such as Word, PDF, Powerpoint, and Excel file, go to the Documents tab in the dashboard and upload the documents.

If you want to automatically sync with your data source, such as MS OneDrive, please go to the Source tab. Uploading the document via API is in the Upload Document section in this page.

Getting the API KEY

Please provide your API key in the request header API-KEY. Your API key can be found in your dashboard Settings menu, under the General tab.

Providing Agent or User Information

For certain endpoints, you can add agent or user information in the request header to specify who makes the call.

Agent information can be provided in the request header AGENT-EMAIL. You can find your agents' email information in your dashboard Settings > Agent menu. Below is an example.

-H 'AGENT-EMAIL: agent_1@email.com'

A user ID can be provided in the request header OWN-USER-ID. The user ID can be either a new one or an existing one, and if a new user ID is provided, Alli will create a new user with that ID. Any future API calls with the same OWN-USER-ID header will be considered as they're from the same user.

If you want to update the user's email address at the same time, you can provide the email address in the request header USER-EMAIL. Below is an example.

-H 'OWN-USER-ID: 5f1234567a409876c082487z' \
-H 'USER-EMAIL: user_1@email.com'

You cannot use non-ASCII characters for OWN-USER-ID. If the user ID includes any non-ASCII characters, you can encode the ID to base64 and use base64:CONVERTED_ID.

You can find saved user ID and email information in your Alli dashboard Customers menu.

Error Messages

Please read the error message you get if you don't get the response that you expected. For example, if you don't use the right HTTP method for the API, you'll get this type of error as response:

{“error”: “Method Not Allowed POST: /webapi/faq_feedbacks”}

Search from Q&A

POST https://backend.alli.ai/webapi/faq

This API lets you find the most relevant question and answer pairs from your Q&A knowledge base.

Headers

Name
Type
Description

API-KEY*

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard.

OWN-USER-ID

string

If you want to specify a user who makes this API call, you can provide the user's ID here. It can be a new one or be found in the Conversations menu in your dashboard.

USER-EMAIL

string

If you want to update the user's email when using OWN-USER-ID, you can provide the new email address here.

Request Body

Name
Type
Description

autoRegisterCandidates

boolean

The default value is true. When this option has set false, it'll not automatically register the query to candidates when there was no answer for the given query.

hashtagsOperator

string

Either AND or OR. Choose AND if you want each returned result to contain all hashtags. Choose OR if you want each returned result to contain at least one of the hashtags.

hashtags

array

An array of all the hashtags that you would like to appear.

maxResults

integer

The maximum number of results to be returned.

query*

string

This is a query string.

format

string

html or text. If it's text, the return value will be in plain text. If it's html, it will return html. If your answer contains styled html, such as different font size and color, you can use html. If you simply want to get an answer as a text, you can use the text. The default value is html.

The API will find the most relevant question and answers from your Q&A database.

confidence: It shows the confidence value from AI model. Shown as a number value between 0 and 1.

effectiveConfidence: When you provide feedback to the query result, it automatically trains the AI model. Effective confidence is the adjusted score with these users' and agents' feedback. Shown as a number value between 0 and 1.

question: This is the question part of the selected Q&A pair.

answer: This is the answer part of the selected Q&A pair.

id: This is used to identify the result to give or cancel feedback.

hashtags: Hashtags registered for the Q&A.

lastUpdatedDate: The date when the Q&A is last updated.

agentFeedback: The feedback from agents (through dashboard and REST calls) about this Q&A.

userFeedback: The feedback from users (through conversation) about this Q&A.

count: The number of suggested Q&As.

hashId: This hash id is being used when you call select_answer later.

The number of search results and the threshold follows your dashboard setting. Please check your settings in Q&A > Settings.

{"result": 
  [
    {
      "confidence": CONFIDENCE_VALUE, 
      "effectiveConfidence": EFFECTIVE_CONFIDENCE_VALUE, 
      "question": "QUESTION_1", 
      "answer": "ANSWER_1",
      "id": "ID_1",
      "hashtags": [],
      "lastUpdatedDate": "DATE",
      "agentFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
              },
      "userFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
              }
    }, ... 
  ],
  "count": 3,
  "hashId": "HASH_ID"
}

Request Example

Please replace YOUR_API_KEY with your one in the example below. Please see getting-api-key section.

curl -d '{ 
  "query": "How much is it?",
  "maxResults": 3, 
  "hashtags": ["wiki", "knowledge"], 
  "hashtagsOperator": "OR",
  "format": "text"}' \
-H 'API-KEY: YOUR API KEY' \
-H 'Content-Type: application/json' \
https://backend.alli.ai/webapi/faq

Response Example

{"result": 
  [
    {
      "confidence": 0.8371959004827834, 
      "effectiveConfidence": 0.9698303406362148, 
      "question": "How is the product priced?", 
      "answer": "We have a pricing table that includes a free plan.",
      "id": "ClMVIjCoNDAiZDLyNWZhM1O3YTUIIKZjPPRcER==",
      "hashtags": [],
      "lastUpdatedDate": "2020-11-19",
      "agentFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
            },
      "userFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
            }
    },
    {
      "confidence": 0.6119840535714456, 
      "effectiveConfidence": 0.7738889000171243, 
      "question": "Do you have a pricing table?", 
      "answer": "Yes we do. Please check out our website",
      "id": "RkFROjVmNDAwZDMyNWZhM2Y4YTA1ZDZjNWUwMQ==",
      "hashtags": [],
      "lastUpdatedDate": "2020-11-20",
      "agentFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
            },
      "userFeedback": {
                "positiveCount": 1,
                "negativeCount": 0
            } 
  ],
  "count": 2,
  "hashId": "d4ca12d4e64766er0c2b45f4aa5463a4"
}

Search from Documents

POST https://backend.alli.ai/webapi/mrc

Documents API finds an answer from your unstructured text documents and even from complex tables.

Headers

Name
Type
Description

API-KEY*

string

Your API key can be found in your dashboard Settings menu, under the General tab.

AGENT-EMAIL

string

If you want to specify an agent who makes this API call, you can provide the agent's email address here. It can be found under Settings > Agents in your dashboard. The permission settings for the agent to access documents or folders are applied by sending this info.

OWN-USER-ID

string

If you want to specify a user who makes this API call, you can provide the user's ID here. It can be a new one or be found in the Conversations menu in your dashboard. The permission settings for non-agent users to access documents or folders are applied by sending this info.

USER-EMAIL

string

If you want to update the user's email when using OWN-USER-ID, you can provide the new email address here.

Request Body

Name
Type
Description

returnPreview

boolean

If true, the html body and css for the html type preview will be returned for each search result. The default value is false.

autoRegisterCandidates

boolean

The default value is true. When this option has set false, it'll not automatically register the query to candidates when there was no answer for the given query.

hashtagsOperator

string

Either AND or OR. Choose AND if you want each returned result's document to have all of the specified hashtags. Choose OR if you want each returned result's document to have at least one of the specified hashtag.

maxResults

integer

Number of results to see

query*

string

This is a query string.

hashtags

array

Documents you uploaded to the dashboard have hashtags. You can set the search scope to these hash-tagged documents.

format

string

It can be 'html' or 'text'. If it's text, the return value will be in plain text. If it's html, it will return html. If your answer contains styled html, such as different font size and color, you can use html. If you simply want to get an answer as a text, you can use the text.

returnPdfPreview

boolean

If true, the pdfPreview field will be returned for each search result. The default value is false.

returnPdfPreviewRawData

boolean

If true, the pdfPreviewRawData field will be returned for each search result. The default value is false.

sortKey

String

This is a secondary sort key where you set in Document's custom properties

sortDirection

String

This is a secondary sorting order. The value will be "asc" or "desc"

combinedHashtags

array

Documents you uploaded to the dashboard have hashtags. You can set the search scope to allow for groups of hashtags. Note: If "combinedHashtags" are used, you must keep the "hashtags" parameter empty.

combinedHashtagsOperator

string

Either AND or OR. Choose AND if you want both of the combined hashtags in the results.

Choose OR if you want at least one of the combined hashtags in the results.

You will get the result as the following JSON format:

answer: It's the answer extracted from uploaded documents in the dashboard.answerHash: This is used to identify the answer to give or cancel feedback.

answerHash: This is used to identify the answer to give or cancel feedback.

confidence: It shows the confidence value from AI model. Shown as a number value between 0 and 1.

effectiveConfidence: When you provide feedback to the query result, it automatically trains the AI model. Effective confidence is the adjusted score with these users' and agents' feedback. Shown as a number value between 0 and 1.

documentId: The document's ID where the answer is extracted from.

documentName: The document's name where the answer is extracted from.hashtags: The hashtags attached to the document.

pageNo: The page number in the document where the answer was derived.

createdDate: The date when the document was uploaded.

agentFeedback: The feedback from agents (through dashboard and REST calls) about this document

userFeedback: The feedback from users about this document

body: If returnPreview is true in the request, the html body of the document search preview is displayed.

css: If returnPreview is true in the request, the css of the document search preview is displayed.

pdfPreview: If returnPdfPreview is true in the request, the URL to a PDF preview of the document with the answer highlighted is displayed. Note that the URL can be restricted using the Download IP Allowlist setting.

folder: If the answer is found from a folder under the Documents database, the folder name will be returned here.

editor: List of the agents' email who has the editor access to the documents (if they're set in the Alli dashboard).

viewer: List of the agents' email who has the viewer access to the documents. (if they're set in the Alli dashboard).

paragraphIndex: This value is needed to highlight a specific area when requesting a preview. It is used as parameters for the preview API.

The number of search results and the threshold follows your dashboard setting. Please check your setting in Documents > Settings.

{
    "result": [
        {
            "answer": "ANSWER_1",
            "answerHash": "ANSWER_HASH_1",
            "confidence": CONFIDENCE_1,
            "effectiveConfidence": EFFECTIVE_CONFIDENCE_1,
            "documentId": "DOCUMENT_ID_1",
            "documentName": "DOCUMENT_NAME_1",
            "hashtags": [],
            "pageNo": PAGE_NUMBER,
            "paragraphIndex": 0,
            "createdDate": "DATE",
            "agentFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "userFeedback": {
                "positiveCount": 0,
                "negativeCount": 0
            },
            "body": "PREVIEW_HTML_BODY",
            "css": "PREVIEW_CSS",
            "pdfPreview": "PDF_PREVIEW_URL",
            "folder": "folder 1", 
            "editor": ["email_1@allganize.ai", "email_2@allganize.ai"], 
            "viewer": ["email_3@allganize.ai"]
        }
    ]
}

Request Example (hashtags)

Please replace YOUR_API_KEY with your one in the example below. Please see getting-api-key section.

curl -X POST -d '{ 
  "query": "can I disclose the composite ratings?",
  "maxResults": 3, 
  "hashtags": ["wiki", "knowledge"], 
  "hashtagsOperator": "OR",
  "format": "text",
  "returnPdfPreview": true,
  "returnPdfPreviewRawData": true \
-H 'API-KEY: YOUR API KEY' \
-H 'Content-Type: application/json' \
https://backend.alli.ai/webapi/mrc

Request Example (combinedHashtags)

Please replace YOUR_API_KEY with your one in the example below. Please see getting-api-key section.

curl -X POST -d '{ 
  "query": "can I disclose the composite ratings?",
  "maxResults": 3, 
  "hashtags": [], 
  "hashtagsOperator": "OR",
  "combinedHashtags": [["wiki","knowledge"],["elibrary","compliance"]]
  "combinedHashtagsOperator": "AND",
  "format": "text",
  "returnPdfPreview": true,
  "returnPdfPreviewRawData": true }' \
-H 'API-KEY: YOUR API KEY' \
-H 'Content-Type: application/json' \
https://backend.alli.ai/webapi/mrc

Response Example

{
  "count": 2,
  "result": [
    {
      "answer": "an institution’s board of directors and senior management",
      "answerHash": "8430cf3b9af628abc1bb063802db39be",