REST Resource: projects.locations.corpora.indexes

Ressource: Index

Un indice est une ressource dans Corpus. Il contient une version indexée des éléments et des annotations. Lorsqu'il est déployé sur un point de terminaison, il permet aux utilisateurs de rechercher dans l'index.

Représentation 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.
}
Champs
name

string

Uniquement en sortie. Nom de la ressource Index. Format : projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}
displayName

string

Facultatif. Nom à afficher facultatif de l'index spécifié par l'utilisateur.
description

string

Facultatif. Description facultative de l'index.
state

enum (State)

Uniquement en sortie. État de l'index.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la mise à jour.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
deployedIndexes[]

object (DeployedIndexReference)

Uniquement en sortie. Références à l'instance d'index déployée. Le corpus VIDEO_ON_DEMAND ne peut pas comporter plus d'un index déployé. L'index du corpus IMAGE peut avoir plusieurs index déployés.
Champ d'union asset_filter. Indique comment les composants sont sélectionnés pour cet index. La valeur par défaut est "entire_corpus" si elle n'est pas spécifiée. Comportement dans UpdateIndex: si update_mask inclut l'un des chemins de champ asset_filter, l'index sera reconstruit avec les derniers composants, y compris leurs données analysées et leurs annotations. asset_filter ne peut être qu'un des éléments suivants :
entireCorpus

boolean

Incluez tous les composants du corpus.

État

Énumération représentant les différents états par lesquels un indice peut passer au cours de sa durée de vie.

Enums
STATE_UNSPECIFIED Valeur par défaut. Ne doit pas être utilisé.
CREATING État CREATING.
CREATED État CREATED.
UPDATING État UPDATING.

DeployedIndexReference

Pointe vers un DeployedIndex.

Représentation JSON 
{
  "indexEndpoint": string
}
Champs
indexEndpoint

string

Immuable. Nom de ressource de l'IndexEndpoint.

Méthodes

create

 Crée un index sous le corpus.

delete

 Supprimez un seul index.

get

 Récupère les détails d'un seul indice dans un corpus.

list

 Répertoriez tous les index d'un corpus donné.

patch

 Met à jour un index dans le corpus.

viewAssets

 Répertorie les composants d'un index.