Question Autocomplete API

curl --request POST \
  --url 'https://api.askmiso.com/v1/qa/question_autocomplete?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "what is g",
  "rows": 5
}
'

import requests

url = "https://api.askmiso.com/v1/qa/question_autocomplete?api_key="

payload = {
    "q": "what is g",
    "rows": 5
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({q: 'what is g', rows: 5})
};

fetch('https://api.askmiso.com/v1/qa/question_autocomplete?api_key=', 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://api.askmiso.com/v1/qa/question_autocomplete?api_key=",
  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([
    'q' => 'what is g',
    'rows' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.askmiso.com/v1/qa/question_autocomplete?api_key="

	payload := strings.NewReader("{\n  \"q\": \"what is g\",\n  \"rows\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.askmiso.com/v1/qa/question_autocomplete?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"q\": \"what is g\",\n  \"rows\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.askmiso.com/v1/qa/question_autocomplete?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"q\": \"what is g\",\n  \"rows\": 5\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "completions": [
      {
        "question": "<string>",
        "weight": 1
      }
    ],
    "took": 0,
    "miso_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "message": "success"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Q&A APIs

Question Autocomplete API

Question Autocomplete is an important feature for Q&A applications. It not only saves your users from typing the complete questions, but also showcases what questions your app is capable answering. This is important because Q&A is an advanced search feature that not every user is familar with.

Miso generates autocomplete candidates from the question bank you uploaded (see Question Bank Upload API). Given a partial question string, Question Autocomplete API will suggest question candidates that match the query the user is typing.

For example, let’s first upload three questions to the question bank:

POST /v1/qa/questions
{"data": [
    {"question": "What is python?"},
    {"question": "What is pypy?"},
    {"question": "How to sort a list in Python?"}
]}

Then, immediately after the above request finished, you can send the request below to get autocompletion candidates for any partial query string. For example, if the query string the user types so far is “what is p”:

POST /v1/qa/question_autocomplete
{
    "q": "what is p",
    "rows": 5
}

The API will respond the completion candidates like the following:

{
    "data":
        "completions": [
            {"question": "What is python?"},
            {"question": "What is pypy?"}
        ]
    }
}

The API supports adaptive fuzzy matching such that even if there are typos in the query string, the API is still able to return the question candidates with the correct spellings. For example, if the query string is “How to sorta”. The API is still able to match the completion candidate: “How to sort a list in Python?”

The API is optimized for instant experience and has an average response time lower than 50ms.

POST

question_autocomplete

Question Autocomplete API

curl --request POST \
  --url 'https://api.askmiso.com/v1/qa/question_autocomplete?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "q": "what is g",
  "rows": 5
}
'

import requests

url = "https://api.askmiso.com/v1/qa/question_autocomplete?api_key="

payload = {
    "q": "what is g",
    "rows": 5
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({q: 'what is g', rows: 5})
};

fetch('https://api.askmiso.com/v1/qa/question_autocomplete?api_key=', 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://api.askmiso.com/v1/qa/question_autocomplete?api_key=",
  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([
    'q' => 'what is g',
    'rows' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.askmiso.com/v1/qa/question_autocomplete?api_key="

	payload := strings.NewReader("{\n  \"q\": \"what is g\",\n  \"rows\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.askmiso.com/v1/qa/question_autocomplete?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"q\": \"what is g\",\n  \"rows\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.askmiso.com/v1/qa/question_autocomplete?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"q\": \"what is g\",\n  \"rows\": 5\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "completions": [
      {
        "question": "<string>",
        "weight": 1
      }
    ],
    "took": 0,
    "miso_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "message": "success"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

query

required

Your secret API key is used to access every Miso API endpoint. You should secure this key and only use it on a backend server. Never leave this key in your client-side JavaScript code. If the private key is compromised, you can revoke it in Dojo and get a new one.

Specify your secret key in the api_key query parameter. For example:

POST /v1/users?api_key=039c501ac8dfcac91c6f05601cee876e1cc07e17

Body

application/json

Post question autocomplete request

string

required

The query user has entered so far

Minimum string length: 1

Example:

"what is g"

rows

integer

default:5

Number of autocomplete results to return.

Response

Successful Response

Autocomplete Response

data

QAAutocompleteResponseBody · object

required

Autocomplete Response

Show child attributes

message

string

default:success

Upload Question Bank API

⌘I