Search

Natural language search (NLWeb)

NLWeb 0.55 endpoint over the live catalog, the knowledge base, and the developer docs. Also served at https://www.adadiamonds.com/ask. Send Accept: text/event-stream or streaming=true for SSE.

get/api/v1/ask

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/ask
  • Auth: none required

Query parameters

querystring required

Natural language query, e.g. 1.5 carat oval under $5000.

site'adadiamonds.com' | 'diamonds' | 'engagement-rings' | 'jewelry' | 'knowledge-base' | 'developers'

Restrict to one corpus.

mode'list' | 'summarize' | 'generate'
streamingboolean

true answers as text/event-stream.

prevstring

Comma-separated previous queries for context.

query_idstring

Client-chosen id echoed in _meta.query_id.

Response

Answer (or an application-level failure with HTTP 200).

summarystring

Present for mode=summarize or generate; built deterministically from the top results.

Example response

{
  "_meta": {
    "version": "0.55"
  },
  "results": [
    {
      "@type": "Product"
    }
  ],
  "structuredData": [
    {
      "@type": "Product"
    }
  ]
}

Changes

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