Retrieval-augmented generation

URL

/v3/openapi/apps/$app_name/rag?fetch_fields=name&query=config=format:fulljson&&query=name:'opensearch'&&sort=id&&raw_query="opensearch"&&chat={"name":"chat_test","prompt_parameters":{"param":"value"}}

• $app_name: The name of your application. The Premium and Standard editions support multiple applications and require an application name for access. This applies to applications that are in service. You can also use an offline application ID to access the offline search service.

  

• The preceding URL omits request headers, encoding, and other parameters.

• The preceding URL omits the host address of the application.

• For definitions, usage details, and examples of all query parameters in the URL, see the Query parameters section below.

Request parameters

For more information about the rules for concatenating query parameters, see the V3 API signature mechanism document.

This section describes the parameters that are specific to the Retrieval-Augmented Generation (RAG) API. All other parameters are the same as those for the Search processing API.

Request example

http://host/v3/openapi/apps/$app_name/rag?fetch_fields=name&query=config=format:fulljson&&query=name:'opensearch'&&sort=id&&raw_query="opensearch"&&chat={"name":"chat_test","prompt_parameters":{"param":"value"}}

Result

The response is returned as a streaming output:

1. The first response contains only the search results, similar to the response from the search API.

   {
     "status": "OK",
     "request_id": "c7e8c3fc1d3886050d7a58fee19964ca",
     "result": {
       "searchtime": 0.02588,
       "total": 1,
       "num": 1,
       "viewtotal": 1,
       "compute_cost": [
       ],
       "items": [{...}],
       "facet": []
     }
   }

2. Intermediate responses contain only the conversation content. The `result` object is empty.

   {
     "status": "OK",
     "request_id": "c7e8c3fc1d3886050d7a58fee19964ca",
     "result": {},
     "chat": {
       "text": "",
     }
   }

3. The final response contains all content, including the rendered `prompt`.

   {
     "status": "OK",
     "request_id": "c7e8c3fc1d3886050d7a58fee19964ca",
     "result": {
       "searchtime": 0.02588,
       "total": 1,
       "num": 1,
       "viewtotal": 1,
       "compute_cost": [
       ],
       "items": [{...}],
       "facet": []
     },
     "chat": {
       "text": "",
       "prompt": ""
     }
   }

Response parameters

Error codes