Search for documents by semantic similarity

Search for documents by semantic similarity.

get

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.

Query parameters

qstringOptional

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

nintegerOptional

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

200

Successful retrieval of documents

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

HTTPcURLJavaScriptPython

GET /api/v1/documents/search/ HTTP/1.1
Host: api.rememberizer.ai
Accept: */*

{
  "data": [
    {
      "chunk_id": "text",
      "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": {
            "status": {
              "indexed": 1,
              "indexing": 1,
              "error": 1
            },
            "total_size": 1,
            "document_count": 1
          }
        }
      },
      "matched_content": "text",
      "distance": 1
    }
  ],
  "message": "text",
  "code": "text"
}