Corpus Search

Computes collocation candidates from a concordance.

Changed on
get/search/collx

Request

  • The document declares no server URL.
  • Auth: HTTP basic

Query parameters

corpnamestring required

Corpus name. To query your own corpus (e.g. username john, corpus mycorpus), use value user/john/mycorpus.

qstring

The CQL query. Regexes are supported for lemma, phrase and word types. The iquery supports simplified wildcards (see concordance_query[iquery]). If you decide to use the concordance_query in a json parameter, you do not have to use this parameter.

usesubcorpstring

The name of the subcorpus. The default value empty string refers to the entire corpus. An example for preloaded/bnc2_tt21 can be Written Academic or 1960-1974.

cattrstring

The (positional attribute)[https://www.sketchengine.eu/my_keywords/positional-attribute/] (lemma, word form etc.) used in the computation.

csortfn't' | 'm' | '3' | 'l' | 's' | 'p' | 'r' | 'f' | 'd'

Function according to which the result is sorted.

cbgrfnsstring

Defines the types of statistics (association measures) to be computed.

t -> T-score

m -> MI

3 -> MI3

l -> log likelihood

s -> min. sensitivity

p -> MI.log_f

r -> relative freq.

f -> absolute freq.

d -> logDice.

To send one value just type the value for example t. If you need to send more values write it as ["t","m","d","3","l","s","p"].

cfromwinteger

The left boundary of the window in which the collocations should be identified. Defined by the token position left or right of KWIC.

ctowinteger

The right boundary of the window in which the collocations should be identified. Defined by the token position left or right of KWIC.

cminfreqinteger

The minimum frequency of the token in the corpus.

cminbgrinteger

The minimum frequency of the token in the window defined by cfromw and ctow.

cmaxitemsinteger

Sets the maximum number of items in the response.

jsonobject

An optinal way of wraping parameters. It is possible to send all relevant parametres via this parameter only. It is classic JSON format.

The most frequent uses are:

queryselector: To select the query type. Supported options are: cqlrow, iqueryrow, lemmarow, charrow, phraserow, wordrow.

iquery: Use with iqueryrow.

cql: Use with cqlrow.

lemma: Use with lemmarow.

lpos: The part of speech of the lemma.

qmcase: Sets the attribute to its lowercased version, i.e. the data are extracted from a lowercased version of the corpus. It used for case insensitive analysis. 1 = case sensitive), 0 = lowercased corpus/case insensitive).

char: Use with charrow.

phrase: Use with phraserow.

word: Use with wordrow

cbgrfns: If you need to send more cbgrfnsDefines the types of statistics (association measures) to be computed. See example.

{
  "concordance_query": [
    {
      "queryselector": "iqueryrow",
      "iquery": "test"
    }
  ],
  "cbgrfns": [
    "t",
    "m",
    "3",
    "l",
    "s",
    "p",
    "r",
    "f",
    "d"
  ]
}

Response

OK

lastpageinteger
wllimitinteger
concsizeinteger
api_versionstring
manatee_versionstring

Example response

{
  "Head": [
    {
      "n": "Cooccurrence count",
      "s": "f",
      "style": " style=\"word-wrap: break-word; width: 5em;\""
    }
  ],
  "Items": [
    {
      "str": "Belvin",
      "freq": 7,
      "coll_freq": 5,
      "Stats": [
        {
          "s": "2.64537",
          "n": "t"
        }
      ],
      "pfilter": "q=P-5+5+1+%5Bword%3D%22Belvin%22%5D",
      "nfilter": "q=N-5+5+1+%5Bword%3D%22Belvin%22%5D"
    }
  ],
  "wllimit": 1000,
  "concsize": 22685,
  "Desc": [
    {
      "op": "Query",
      "arg": "[lemma=\"test\"]",
      "nicearg": "test",
      "rel": 202.22,
      "size": 22685,
      "tourl": "q=q%5Blemma%3D%22test%22%5D"
    }
  ],
  "api_version": "5.63.1",
  "manatee_version": "2.36.7-SkE-2.223.6",
  "request": {
    "csortfn": "m",
    "corpname": "preloaded/bnc2",
    "q": "q[lemma=\"test\"]"
  }
}

Changes