Search Documents

POST 
/documents/search

Search Datasphere Documents

Request

application/json

Body

required

tagsstring[]
Document tags.
Example: ["sports","football","game"]
document_iduuid

Unique ID of a Document.

query_stringstringrequired
Search term.
Example: Most paid athlete
distanceinteger
Specifies how closely related the query is to the document. Low distance means high relevance and similarity. High distance means low relevance and similarity.
Possible values: <= 78.3836717690617
Example: 2
countinteger
Specifies number of returned Chunks.
Example: 5
languagestring
Language of the Document.
Default value: en
Example: fr
pos_to_expandstring[]
Part of Speech considered for expansion or analysis.
Default value: ["NOUN","VERB","ADJ","ADV"]
Example: ["NOUN","VERB"]
max_synonymsinteger
Maximum number of synonyms to consider.
Default value: 10
Example: 7

Responses

200

The request has succeeded.

application/json

Schema

Schema

• Array [

textstringrequired
A search result.
Example: Cristiano Ronaldo is the highest-paid football player in the world in 2024
document_iduuidrequired

Unique ID of a Document.

• ]

Example (from schema)

[
  {
    "text": "Cristiano Ronaldo is the highest-paid football player in the world in 2024",
    "document_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]

422

Client error

application/json

Schema

Schema

errors

object[]

required

Array [

typestringrequired

Error type.

codestringrequired

Error code.

messagestringrequired

Error details.

attributestringrequired

Request parameter associated with this error.

urlstringrequired

Link to developer resource for this error.

]

Example (from schema)

{
  "errors": [
    {
      "type": "validation_error",
      "code": "invalid_parameter",
      "message": "Invalid tags",
      "attribute": "tags",
      "url": "https://developer.signalwire.com/rest/overview/error-codes#{code}"
    }
  ]
}