REST Resource: projects.locations.corpora.indexes

Recurso: Índice

Un índice es un recurso de Corpus. Contiene una versión indexada de los recursos y las anotaciones. Cuando se implemente en un extremo, permitirá a los usuarios buscar en el índice.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "deployedIndexes": [
    {
      object (DeployedIndexReference)
    }
  ],

  // Union field asset_filter can be only one of the following:
  "entireCorpus": boolean
  // End of list of possible types for union field asset_filter.
}
Campos
name

string

Solo salida. Es el nombre del recurso de Index. Formato: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}
displayName

string

Opcional. Es el nombre visible opcional del índice que especifica el usuario.
description

string

Opcional. Descripción opcional del índice.
state

enum (State)

Solo salida. Es el estado del índice.
createTime

string (Timestamp format)

Solo salida. La marca de tiempo de creación

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

string (Timestamp format)

Solo salida. La marca de tiempo de actualización.

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

object (DeployedIndexReference)

Solo salida. Referencias a la instancia del índice implementada. El índice del corpus VIDEO_ON_DEMAND puede tener como máximo un índice implementado. El índice del corpus de IMÁGENES puede tener varios índices implementados.
Campo de unión asset_filter. Especifica cómo se seleccionan los recursos para este índice. Si no se especifica, el valor predeterminado es entire_corpus. Comportamiento en UpdateIndex: Si update_mask incluye una de las rutas de acceso del campo asset_filter, el índice se volverá a compilar con los recursos más recientes, incluidos sus datos analizados y sus anotaciones. asset_filter puede ser solo uno de los siguientes:
entireCorpus

boolean

Incluye todos los recursos del corpus.

Estado

Es una enumeración que representa los diferentes estados por los que puede pasar un índice durante su ciclo de vida.

Enums
STATE_UNSPECIFIED Es el valor predeterminado. No se debe usar.
CREATING Estado CREATING.
CREATED Estado CREATED.
UPDATING Estado UPDATING.

DeployedIndexReference

Apunta a un DeployedIndex.

Representación JSON 
{
  "indexEndpoint": string
}
Campos
indexEndpoint

string

Inmutable. Es un nombre de recurso de IndexEndpoint.

Métodos

create

 Crea un índice en el corpus.

delete

 Borra un solo índice.

get

 Obtiene los detalles de un solo índice en un corpus.

list

 Muestra una lista de todos los índices de un corpus determinado.

patch

 Actualiza un índice en el corpus.

viewAssets

 Muestra una lista de los recursos dentro de un índice.