REST Resource: projects.locations.corpora.indexes

Recurso: índice

Um índice é um recurso no Corpus. Ele contém uma versão indexada dos recursos e das anotações. Quando implantado em um endpoint, ele permite que os usuários pesquisem o índice.

Representação 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

Apenas saída. Nome do recurso de índice. Formato: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}
displayName

string

Opcional. Nome de exibição opcional do índice especificado pelo usuário.
description

string

Opcional. Descrição opcional do índice.
state

enum (State)

Apenas saída. Estado do índice.
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de criação.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora da atualização.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
deployedIndexes[]

object (DeployedIndexReference)

Apenas saída. Referências à instância de índice implantada. O índice do corpus VIDEO_ON_DEMAND pode ter no máximo um índice implantado. O índice do corpus IMAGE pode ter vários índices implantados.
Campo de união asset_filter. Especifica como os recursos são selecionados para este índice. O padrão é "entire_corpus" se não for especificado. Comportamento no UpdateIndex: se update_mask incluir um dos caminhos de campo asset_filter, o índice será recriado com os recursos mais recentes, incluindo os dados e as anotações analisados. asset_filter pode ser apenas de um dos tipos a seguir:
entireCorpus

boolean

Inclua todos os recursos do corpus.

Estado

Enum que representa os diferentes estados pelos quais um índice pode passar durante o ciclo de vida.

Enums
STATE_UNSPECIFIED O valor padrão. Não pode ser usado.
CREATING Estado CRIANDO.
CREATED Estado CREATED.
UPDATING Estado ATUALIZANDO.

DeployedIndexReference

Aponta para um DeployedIndex.

Representação JSON 
{
  "indexEndpoint": string
}
Campos
indexEndpoint

string

Imutável. Um nome de recurso do IndexEndpoint.

Métodos

create

 Cria um índice no corpus.

delete

 Excluir um único índice.

get

 Recebe os detalhes de um único índice em um corpus.

list

 Lista todos os índices em um determinado corpus.

patch

 Atualiza um índice no corpus.

viewAssets

 Lista os recursos em um índice.