NLWeb ask, list mode: the General articles matching a query, in NLWeb's list shape

No model is called: generate_mode summarize or generate is answered as a list, and _meta.note says so. streaming=true, or Accept: text/event-stream, sends the same list as server-sent events (one result_batch, then complete). Also at https://www.edgechat.ai/ask; POST takes the same fields as a JSON body.

get/ask

Request

  • Base URL: https://www.edgechat.ai/api/v1
  • URL: https://www.edgechat.ai/api/v1/ask
  • Auth: none declared

Query parameters

querystring required

A subject's name or words from its title.

decontextualized_querystring

Used in place of query when given.

num_resultsinteger
generate_mode'list' | 'summarize' | 'generate'
modestring

An older name for generate_mode.

streaming'true' | 'false'
query_idstring

Echoed back; a new one is made when absent.

sitestring

Accepted and ignored: this site holds one collection.

prevstring

Accepted and ignored.

last_ansstring

Accepted and ignored.

item_to_rememberstring

Accepted and ignored.

fieldsstring

Comma-separated keys: each result (or the answer, when it has no results) keeps only these.

Response

The matching articles, best first

query_idstring
querystring
did_you_meanstring

Example response

{
  "license": {
    "spdx": "LicenseRef-Edgepedia-Community-1.0"
  }
}

Changes

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