Sign in
Corpora

Retrieves a user corpus.

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

Request

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

Response

OK

idinteger

Unique numeric corpus ID for corpus building.

owner_idinteger

Unique numeric owner ID (usually you).

owner_namestring

Corpus owner name (usually you).

corpnamestring

Unique corpus name for corpus querying.

language_idstring

Language iso-code. ISO 639-1.

language_namestring

Language name in English.

sketch_grammar_idstring

Sketch grammar ID (name of sketch grammar file). 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.

createdstring

Date and time of corpus creation in format YYYY-MM-DD HH:MM:SS.

needs_recompilingboolean

True if corpus documents have been altered since last compilation.

user_can_readboolean

Corpus can be queried by a specific user. Ignore all corpora where this is false.

user_can_referboolean

Corpus can be used as a reference corpus even by anonymous users.

user_can_uploadboolean

Corpus is owned by you or shared with and you can upload documents to it.

user_can_manageboolean

Corpus is owned by you or shared with you with full privileges.

is_sharedboolean

True if corpus is shared with other users.

new_versionstring

If set, the old corpus is deprecated in favor of a new one.

namestring

Corpus name. Given by user.

infostring

Additional info about corpus.

alignedstring[]

Other corpora within the same multi-lingual set (parallel corpus).

docstructurestring

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

is_error_corpusboolean

Current state of corpus.

attrliststring[]

Attributes appearing in corpus documents. Attributes like: word, tag, lempos, pos, lemma, etc.

tagset_idinteger

Tagset ID. Tagset is list of part-of-speech tags (POS tags) for specified language. They are preselected to the most relevant one and can be changed only in user corpora. The terms tagset and templates are interchangeable.

reference_corpusstring

Default reference corpus for keyword extraction.

progressinteger

Compilation status: 0 if not compiled, 100 if compiled successfully, -1 if failed, otherwise in progress.

errorstring

Informs about last compilation error, if any error None.

document_countinteger

The amount of documents the corpus was build from.

can_be_upgradedboolean

True if corpus template is outdated and can be upgraded. The terms tagset and templates are interchangeable.

file_structurestring

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

onion_structurestring

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

expert_modeboolean

Set to True if you are hard-core.

document_orderinteger[]

Not mandatory. Can be set to enforce document order within the corpus.

use_all_structureboolean

Use all structures available in corpus.

Changes