Search Documents

POST 
/documents/search

Search Datasphere Documents

Request

application/json

Body

required

tags string[]

Document tags.

document_id uuid

Unique ID of a Document.

query_string stringrequired

Search term.

distance integer

Possible values: <= 78.3836717690617

Specifies how closely related the query is to the document. Low distance means high relevance and similarity. High distance means low relevance and similarity.

count integer

Specifies number of returned Chunks.

language string

Default value: en

Language of the Document.

pos_to_expand string[]

Default value: NOUN,VERB,ADJ,ADV

Part of Speech considered for expansion or analysis.

max_synonyms integer

Default value: 10

Maximum number of synonyms to consider.

Responses

200

The request has succeeded.

application/json

Schema

Schema

• Array [

text stringrequired

A search result.

document_id uuidrequired

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 [

type stringrequired

Error type.

code stringrequired

Error code.

message stringrequired

Error details.

attribute stringrequired

Request parameter associated with this error.

url stringrequired

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}"
    }
  ]
}

Loading...