Search

Root resource for all text search APIs

Unique Text Search

Unique content text search

Securityapi_key
Request
Request Body schema: application/json
required
aid
required
string

Application identifier.

query
string

Keywords separated by space.

Responses
200

200 response

400

Invalid request body

403

The request is forbidden (Please input a valid API key)

post/hub/apps/search/text/uniques
Request samples
application/json
{
  • "aid": "b6ee555d61df4c0ae30099d3ba4acf5c-sample-01"
}
Response samples
application/json
{ }

Compound Text Search

Compound text search

Securityapi_key
Request
Request Body schema: application/json
required
aid
required
string

Application identifier.

query
required
string

Keywords separated by space.

Responses
200

200 response

400

Invalid request body

403

The request is forbidden (Please input a valid API key)

post/hub/apps/search/text/compound
Request samples
application/json
{
  • "aid": "b6ee555d61df4c0ae30099d3ba4acf5c-sample-01",
  • "query": "(hell* AND sit)"
}
Response samples
application/json
{
  • "status": {
    },
  • "result": {
    }
}

Keyword Text Search

Keyword text search

Securityapi_key
Request
Request Body schema: application/json
required
aid
required
string

Application identifier.

query
required
string

Keywords separated by space.

Responses
200

200 response

400

Invalid request body

403

The request is forbidden (Please input a valid API key)

post/hub/apps/search/text/keyword
Request samples
application/json
{
  • "aid": "b6ee555d61df4c0ae30099d3ba4acf5c-67690aa2",
  • "query": "hello"
}
Response samples
application/json
{
  • "status": {
    },
  • "result": {
    }
}

Content Text Similarity Search

Content similarity range search

Securityapi_key
Request
Request Body schema: application/json
required
One of:

A request model for text search.

aid
required
string

Application identifier.

cid
required
string

Source content id for similarity search.

text
string

Source content text for similarity search.

min
number [ 0.5 .. 1 ]
Default: 0.8

Minimum similarity score. The default is 0.80.

max
number [ 0.5 .. 1 ]
Default: 1

Maximum similarity score. The default is 1.0.

include_doc
boolean
Default: false

Set to true to include document id for each content hit.

Responses
200

200 response

400

Invalid request body

403

The request is forbidden (Please input a valid API key)

post/hub/apps/search/text/mlt
Request samples
application/json
{
  • "aid": "b6ee555d61df4c0ae30099d3ba4acf5c-sample-01",
  • "cid": "dff02fd2",
  • "min": 0.8,
  • "max": 1
}
Response samples
application/json
{
  • "status": {
    },
  • "result": {
    }
}
➔ Next to PDF Document