Skip to contents

Construct a typed S3 object of class kagi_summarize that describes a Universal Summarizer request. Use kagi_request() to execute the request and obtain the json replies.

Usage

query_summarize(
  url = NULL,
  text = NULL,
  engine = NULL,
  summary_type = NULL,
  target_language = NULL,
  cache = TRUE
)

Arguments

url

Optional character scalar. URL to be summarized. Mutually exclusive with text.

text

Optional character scalar. Raw text to be summarized. Mutually exclusive with url.

engine

Character scalar. Summarizer engine (options: "cecil", "agnes", "muriel", "daphne"). Default: "cecil".

summary_type

Character scalar. Type of summary requested (options: "summary", "takeaway"). Default: "summary".

target_language

Character scalar. Target language ISO code. Supported codes: "EN", "BG", "CS", "DA", "DE", "EL", "ES", "ET", "FI", "FR", "HU", "ID", "IT", "JA", "KO", "LT", "LV", "NB", "NL", "PL", "PT", "RO", "RU", "SK", "SL", "SV", "TR", "UK", "ZH", "ZH-HANT". Default: "EN".

cache

Logical. Whether to allow API-side caching.

Value

A named list of kagi_query_summarize objects to be passed to kagi_request().

Examples

if (FALSE) { # \dontrun{
req <- query_summarize(text = "Lorem ipsum")
req
} # }