REST Resource: corpora.documents

Recurso: Documento

Una Document es una colección de elementos Chunk. Un Corpus puede tener un máximo de 10,000 Document.

Representación JSON
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Campos
name

string

Inmutable. Identificador. El nombre del recurso Document. El ID (nombre sin el prefijo “corpora/*/documents/”) puede contener hasta 40 caracteres alfanuméricos en minúscula o guiones (-). No puede comenzar ni terminar con un guion. Si el nombre está vacío durante la creación, se derivará un nombre único de displayName junto con un sufijo aleatorio de 12 caracteres. Ejemplo: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Opcional. Es el nombre visible legible de la Document. El nombre visible no debe superar los 512 caracteres, incluidos los espacios. Ejemplo: "Documentación de Semantic Retriever"

customMetadata[]

object (CustomMetadata)

Opcional. El usuario proporcionó metadatos personalizados almacenados como pares clave-valor que se usan para las consultas. Un Document puede tener un máximo de 20 CustomMetadata.

updateTime

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización de Document.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Solo salida. La marca de tiempo de la creación de Document.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Métodos

create

Crea un Document vacío.

delete

Borra un Document.

get

Obtiene información sobre un Document específico.

list

Enumera todos los Document en una Corpus.

patch

Actualiza un objeto Document.

query

Realiza búsquedas semánticas en un Document.