Search

Find documents similar to a source document.

Find documents similar to a supplied document. Billed like a search. Search-capacity rejection returns 429; retry with bounded backoff respecting Retry-After.

post/v2/search/similar

Request

  • Base URL: https://api.machinelibrary.ai
  • URL: https://api.machinelibrary.ai/v2/search/similar
  • Auth: one of:
    • API key in header X-Api-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.machinelibrary.ai/v2/oauth/authorize, token URL https://api.machinelibrary.ai/v2/oauth/token, scopes: search)

Request body

document_idstring required

Source document whose whole-document representation seeds similarity retrieval.

filter_languagesstring[] nullable

Restrict results to ISO language codes.

filter_typesstring[] nullable

Restrict results to document types.

limitinteger

Response

Ranked similar documents.

corrected_querystring nullable
embed_msinteger nullable
has_nextboolean required
ranking_mode'auto' | 'documents' | 'passages' required

Relevance objective, independent of corpus and lexical/vector retrieval. Results remain document groups for both objectives.

total_hitsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.