Search for documents by semantic similarity

Search for documents by semantic similarity.

Initiate a search operation with a query text of up to 400 words and receive the most semantically similar responses from the stored knowledge. For question-answering, convert your question into an ideal answer and submit it to receive similar real answers.

get

/documents/search/

Query parameters

qstring

Up to 400 words sentence for which you wish to find semantically similar chunks of knowledge.

ninteger

Number of semantically similar chunks of text to return. Use 'n=3' for up to 5, and 'n=10' for more information. If you do not receive enough information, consider trying again with a larger 'n' value.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.rememberizer.ai/api/v1/documents/search/'

200

400

401

500

200

{
  "message": "text",
  "code": "text",
  "data": [
    {
      "chunk_id": "text",
      "matched_content": "text",
      "distance": 1,
      "document": {
        "id": 1,
        "document_id": "text",
        "name": "text",
        "type": "text",
        "path": "text",
        "url": "text",
        "size": "text",
        "created_time": "text",
        "modified_time": "text",
        "integration": {
          "id": 1,
          "integration_type": "text",
          "integration_step": "text",
          "source": "text",
          "document_stats": {
            "total_size": 1,
            "document_count": 1,
            "status": {
              "indexed": 1,
              "indexing": 1,
              "error": 1
            }
          }
        }
      }
    }
  ]
}

Successful retrieval of documents