Summarization

Generate a summary for the provided context

Generate a summary for the provided context. This is similar to the Complete endpoint, but is designed for summarization tasks. it does not require a conversation ID and does not store the conversation history.

post/ai/v1/summarize

Request

  • Base URL
    https://.clinia.cloud
  • URL
    https://.clinia.cloud/ai/v1/summarize
  • Auth
    API key in header X-Clinia-API-Key

Request body

taskstring required

The summarization task to perform (e.g. "knowledge-answer").

paramsobject required

Key/value inputs for that task, must conform to the JSON-Schema of the chosen task.

targetParamstring

A param name (e.g. "hits") that will be used to store the results of the retriever. Only necessary if retriever is specified.

Example request

{
  "targetParam": "hits"
}

Response

A successful response.

Changes

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