REST Resource: projects.locations.corpora.indexes

Risorsa: indice

Un indice è una risorsa nel Corpus. Contiene una versione indicizzata degli asset e delle annotazioni. Se viene implementato in un endpoint, consente agli utenti di eseguire ricerche nell'indice.

Rappresentazione 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.
}
Campi
name

string

Solo output. Nome della risorsa dell'indice. Formato: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

displayName

string

Facoltativo. Nome visualizzato facoltativo dell'indice specificato dall'utente.

description

string

Facoltativo. Descrizione facoltativa dell'indice.

state

enum (State)

Solo output. Stato dell'indice.

createTime

string (Timestamp format)

Solo output. Il timestamp di creazione.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo output. Il timestamp dell'aggiornamento.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

deployedIndexes[]

object (DeployedIndexReference)

Solo output. Riferimenti all'istanza dell'indice di cui è stato eseguito il deployment. L'indice del corpus VIDEO_ON_DEMAND può avere al massimo un indice di cui è stato eseguito il deployment. L'indice del corpus di immagini può avere più indici di cui è stato eseguito il deployment.

Campo unione asset_filter. Specifica in che modo vengono selezionati gli asset per questo indice. Se non specificato, il valore predefinito è entire_corpus. Comportamento in UpdateIndex: se update_mask include uno dei percorsi dei campi asset_filter, l'indice verrà ricostruito con gli asset più recenti, inclusi i dati e le annotazioni analizzati. asset_filter può essere solo uno dei seguenti:
entireCorpus

boolean

Includi tutti gli asset del corpus.

Stato

Enum che rappresenta i diversi stati attraverso i quali un indice potrebbe eseguire il ciclo durante il suo ciclo di vita.

Enum
STATE_UNSPECIFIED Il valore predefinito. Non deve essere utilizzato.
CREATING Stato CREATING.
CREATED Stato CREATED.
UPDATING Stato UPDATING.

DeployedIndexReference

Rimanda a un DeployedIndex.

Rappresentazione JSON
{
  "indexEndpoint": string
}
Campi
indexEndpoint

string

Immutabile. Un nome della risorsa dell'endpoint dell'indice.

Metodi

create

Crea un indice nel corpus.

delete

Eliminare un singolo indice.

get

Recupera i dettagli di un singolo indice in un corpus.

list

Elenca tutti gli indici in un determinato corpus.

patch

Aggiorna un indice nel corpus.

viewAssets

Elenca le risorse all'interno di un indice.