Skip to contents

Build a Kagi search query string

Source: R/query_enrich_web.R
query_enrich_web.Rd

Construct one or more query strings for the Kagi Search API by combining free-text terms with structured operators such as filetype:, site:, inurl:, and intitle:. Use kagi_request() to execute the request and obtain the json replies.

Usage

query_enrich_web(
  query,
  filetype = NULL,
  site = NULL,
  inurl = NULL,
  intitle = NULL,
  expand = TRUE
)

Arguments

query

Character vector of free-text query terms (required). These can include quoted phrases and boolean operators.

filetype

Optional character vector of file type extensions (e.g. "pdf", "docx"). Each is prefixed with filetype:.

site

Optional character vector of domains (e.g. "example.com", "gov"). Each is prefixed with site:.

inurl

Optional character vector of URL substrings that must be present in the result URL. Each is prefixed with inurl:.

intitle

Optional character vector of terms that must appear in the page title. Each is prefixed with intitle:.

expand

Logical, default TRUE. If TRUE, generate a fully crossed set of queries (Cartesian product of all combinations of query, filetype, site, inurl, and intitle). If FALSE, concatenate the arguments into a single combined query string.

Value

A named list containing query strings of class kagi_query_enrich_web, to be used in kagi_request().

Details

This helper makes it easy to build reproducible, complex queries with structured operators. Use expand = TRUE when you want all possible combinations (useful in systematic search contexts). Use expand = FALSE when you want a single combined query.

See also

open_search_query(), kagi_request(), kagi_request_parquet(),

Examples

if (FALSE) { # \dontrun{
# Single combined query
query_search(
  query = "biodiversity",
  filetype = c("pdf", "docx"),
  site = "example.com",
  expand = FALSE
)

# Expanded combinations
query_search(
  query = c("biodiversity", "ecosystem"),
  filetype = c("pdf", "docx"),
  site = c("example.com", "gov"),
  expand = TRUE
)

# Open a generated query manually in browser
open_search_query(query_search("openalex api", site = "docs.openalex.org")[[1]])
} # }