자동완성 API

정보

• 검색을 위해서는 client read secret 혹은 client write secret이 필요합니다.

Overview

Path

POST/v1/search/collections/autocomplete

• 제공된 문자열에 따라 알맞은 title을 가진 Document들을 검색합니다.

Example

---

curl -X POST https://api.invector.co/v1/search/collections/autocomplete \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_READ_SECRET})" \
     -d '{
       "query": "search",
       "collectionsNames": [],
     }'

curl -X POST https://api.invector.co/v1/search/collections/autocomplete \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_READ_SECRET})" \
     -d '{
       "query": "search",
       "collectionsNames": ["Results", "Docs"],
     }'

Authorization

---

Authorization

BasicBasic authorization at Header. Base64 encoding required

client_id

string

client_secret

string

example

 curl -X POST https://api.invector.co/v1/search/collections/autocomplete \
      -H "Content-Type: application/json" \
      -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_READ_SECRET})" \
     ...

Request Body

---

query

string (required)검색 쿼리 문자열입니다.

collectionNames

array of string검색할 collection의 이름입니다. 빈 배열일 경우 모든 collection에서 검색합니다.

example

["Results", "Docs"] or []

Response Body

---

suggestions

array of string자동완성 결과입니다. 검색 결과가 없을 경우 빈 배열을 반환합니다. 최대 10개의 결과를 반환합니다.

example

[
	"History of Search", 
	"Search API",
	"Search Engine",
	"Search Query",
	"Search Result",
	"Search Term",
	"Search Token",
	"Searchable",
	"Searchable Field",
	"Searchable Fields"
]