REST Resource: projects.locations.corpora.indexes

Ressource: Index

Ein Index ist eine Ressource in Corpus. Es enthält eine indexierte Version der Assets und Anmerkungen. Wenn er auf einem Endpunkt bereitgestellt wird, können Nutzer im Index suchen.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Nur Ausgabe. Ressourcenname der Indexressource. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}
displayName

string

Optional. Optionaler vom Nutzer angegebener Anzeigename des Index.
description

string

Optional. Optionale Beschreibung des Index.
state

enum (State)

Nur Ausgabe. Status des Index.
createTime

string (Timestamp format)

Nur Ausgabe. Der Erstellungszeitstempel.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Aktualisierungszeitstempel.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
deployedIndexes[]

object (DeployedIndexReference)

Nur Ausgabe. Verweise auf die bereitgestellte Indexinstanz. Der Index des VIDEO_ON_DEMAND-Korpus kann maximal einen bereitgestellten Index haben. Der Index des IMAGE-Korpus kann mehrere bereitgestellte Indexe haben.
Union-Feld asset_filter. Gibt an, wie Assets für diesen Index ausgewählt werden. Wenn keine Angabe gemacht wird, ist der Standardwert „entire_corpus“. Verhalten bei UpdateIndex: Wenn „update_mask“ einen der Feldpfade von „asset_filter“ enthält, wird der Index mit den neuesten Assets neu erstellt, einschließlich der analysierten Daten und Anmerkungen. Für asset_filter ist nur einer der folgenden Werte zulässig:
entireCorpus

boolean

Schließen Sie alle Assets im Korpus ein.

Bundesland

Eine Aufzählung, die die verschiedenen Status darstellt, die ein Index während seiner Lebensdauer durchlaufen kann.

Enums
STATE_UNSPECIFIED Der Standardwert. Sollte nicht verwendet werden.
CREATING Status: CREATING
CREATED Status: CREATED.
UPDATING Status: AKTUALISIERT.

DeployedIndexReference

Verweist auf einen DeployedIndex.

JSON-Darstellung 
{
  "indexEndpoint": string
}
Felder
indexEndpoint

string

Nicht veränderbar. Der Ressourcenname des Index-Endpunkts.

Methoden

create

 Erstellt einen Index unter dem Korpus.

delete

 Einzelnen Index löschen

get

 Ruft die Details eines einzelnen Index unter einem Korpus ab.

list

 Listet alle Indexe in einem bestimmten Korpus auf.

patch

 Aktualisiert einen Index unter dem Korpus.

viewAssets

 Listet Assets in einem Index auf.