REST Resource: corpora

Resource: Corpus

A Corpus is a collection of Documents. A project can create up to 5 corpora.

JSON representation
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Immutable. Identifier. The Corpus resource name. The ID (name excluding the "corpora/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be derived from displayName along with a 12 character random suffix. Example: corpora/my-awesome-corpora-123a456b789c

displayName

string

Optional. The human-readable display name for the Corpus. The display name must be no more than 512 characters in length, including spaces. Example: "Docs on Semantic Retriever"

createTime

string (Timestamp format)

Output only. The Timestamp of when the Corpus was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The Timestamp of when the Corpus was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

create

Creates an empty Corpus.

delete

Deletes a Corpus.

get

Gets information about a specific Corpus.

list

Lists all Corpora owned by the user.

patch

Updates a Corpus.

query

Performs semantic search over a Corpus.