Corpora

Updates a user corpus.

Changed on
put/ca/api/corpora/{corpusId}

Request

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

Request body

expert_modeboolean

Set to True if you are hard-core.

namestring

Corpus name. Given by user.

infostring

Additional info about corpus.

document_orderinteger[]

Can be set to enforce document order within the corpus.

lang_filterboolean
file_structurestring

The structure in which individual documents should be wrapped. Usually doc.

onion_structurestring

The structure for deduplication. Usually p (paragraph), doc or Null (no deduplication).'

docstructurestring

Structure in which individual documents should be wrapped. Usually doc.

sketch_grammar_idstring

Sketch grammar ID (name of sketch grammar file). For sketch grammars querying. Sketch grammar is a series of rules written in the CQL query language that search for collocations in a text corpus and categorize them according to their grammatical relations. Example: preloaded/english-penn_tt-3.3.wsdef.m4.

term_grammar_idstring

Term grammar ID (name of term grammar file). Term grammar tells Sketch Engine which words and phrases should indentify as terms. Example: /corpora/wsdef/english-penn_tt-terms-3.1.termdef.m4.

Example request

{
  "name": "Example corpus 2",
  "info": "Example description of user corpus 2",
  "lang_filter": true,
  "file_structure": "doc",
  "onion_structure": "doc",
  "docstructure": "doc",
  "sketch_grammar_id": "preloaded/english-penn_tt-3.3.wsdef.m4",
  "term_grammar_id": "preloaded/english-penn_tt-terms-3.1.termdef.m4"
}

Response

OK

Changes