Method: projects.locations.corpora.searchAssets

Suche im Medien-Asset.

HTTP-Anfrage

POST https://visionai.googleapis.com/v1/{corpus=projects/*/locations/*/corpora/*}:searchAssets

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
corpus

string

Pflichtangabe. Das übergeordnete Corpus, in dem gesucht werden soll. Format: `projects/{projectId}/locations/{locationId}/corpora/{corpus_id}`

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "pageSize": integer,
  "pageToken": string,
  "contentTimeRanges": {
    object (DateTimeRangeArray)
  },
  "criteria": [
    {
      object (Criteria)
    }
  ],
  "exclusionCriteria": [
    {
      object (Criteria)
    }
  ],
  "facetSelections": [
    {
      object (FacetGroup)
    }
  ],
  "resultAnnotationKeys": [
    string
  ],
  "searchQuery": string,

  // Union field sort_spec can be only one of the following:
  "schemaKeySortingStrategy": {
    object (SchemaKeySortingStrategy)
  }
  // End of list of possible types for union field sort_spec.
}
Felder
pageSize

integer

Die Anzahl der Ergebnisse, die auf dieser Seite zurückgegeben werden sollen. Wenn der Wert 0 ist, entscheidet der Server über die entsprechende pageSize.
pageToken

string

Das Fortsetzungstoken zum Abrufen der nächsten Seite. Wenn das Feld leer ist, wird die erste Seite abgerufen.
contentTimeRanges

object (DateTimeRangeArray)

Zeiträume, in die die entsprechenden Videoinhalte fallen müssen. Wenn keine Zeiträume angegeben werden, gibt es keine Zeitbeschränkung. Dieses Feld wird genauso wie die folgenden Kriterien behandelt, aber aus praktischen Gründen separat definiert, da es häufig verwendet wird. Wenn das Enddatum in der Zukunft liegt, wird es auf den Zeitpunkt des Eingangs der Anfrage begrenzt.
criteria[]

object (Criteria)

Kriterien, die auf Suchergebnisse angewendet werden.
exclusionCriteria[]

object (Criteria)

Kriterien, die aus den Suchergebnissen ausgeschlossen werden sollen. fetchMatchedAnnotations wird ignoriert.
facetSelections[]

object (FacetGroup)

Speichert den aktuellen Status der Facettenauswahl. Hier werden nur Facettengruppen mit der Auswahl des Nutzers angezeigt. Der Auswahlstatus ist entweder „Ausgewählt“ oder „Nicht ausgewählt“. Als Suchkriterien werden nur ausgewählte Attribut-Buckets verwendet.
resultAnnotationKeys[]

string

Eine Liste von Anmerkungsschlüsseln, mit denen die Anmerkungen angegeben werden, die mit jedem Suchergebnis abgerufen und zurückgegeben werden sollen. Die Anmerkungsgranularität muss „GRANULARITY_ASSET_LEVEL“ sein und die Suchstrategie darf nicht „NO_SEARCH“ sein.
searchQuery

string

Globale Suchanfrage. Ermöglicht es Nutzern, Assets zu suchen, ohne angeben zu müssen, zu welchem Feld der Wert gehört.
Union-Feld sort_spec. Sortierspezifikation. Wenn dieses Feld nicht angegeben ist, gilt standardmäßig: - STREAM_VIDEO: Die Suchergebnisse werden nach der Startzeit sortiert. Für sort_spec ist nur einer der folgenden Werte zulässig:
schemaKeySortingStrategy

object (SchemaKeySortingStrategy)

Sortieren Sie nach dem Wert unter dem Datenschemaschlüssel.

Antworttext

Antwortnachricht für corpora.searchAssets.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "searchResultItems": [
    {
      object (SearchResultItem)
    }
  ],
  "nextPageToken": string,
  "facetResults": [
    {
      object (FacetGroup)
    }
  ]
}
Felder
searchResultItems[]

object (SearchResultItem)

Zurückgegebene Suchergebnisse.
nextPageToken

string

Das Fortsetzungstoken für die nächste Seite.
facetResults[]

object (FacetGroup)

Die Ergebnisse der Facettensuche einer bestimmten Suchanfrage, die die bereits ausgewählten Facet-Werte des Nutzers und aktualisierte Ergebnisse der Facettensuche enthält.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource corpus:

  • visionai.assets.search

Weitere Informationen finden Sie in der IAM-Dokumentation.

SchemaKeySortingStrategy

Eine Strategie, mit der angegeben wird, wie nach dem Datenschemaschlüssel sortiert werden soll.

JSON-Darstellung 
{
  "options": [
    {
      object (Option)
    }
  ]
}
Felder
options[]

object (Option)

Optionen im Vordergrund haben eine höhere Priorität als Optionen im Hintergrund.

Option

Option für einen Datenschemaschlüssel.

JSON-Darstellung 
{
  "dataSchemaKey": string,
  "sortDecreasing": boolean,
  "aggregateMethod": enum (AggregateMethod)
}
Felder
dataSchemaKey

string

Die Daten, die für die Sortierung verwendet werden.
sortDecreasing

boolean

Ob in absteigender oder aufsteigender Reihenfolge sortiert werden soll. Standardmäßig werden die Ergebnisse in aufsteigender Reihenfolge sortiert.
aggregateMethod

enum (AggregateMethod)

Aggregationsmethode für den aktuellen Datenschemaschlüssel.

AggregateMethod

Wenn ein Ergebnis mehrere Werte mit demselben Schlüssel hat, geben Sie an, welcher Wert für die Sortierung verwendet werden soll. Standardmäßig wird AGGREGATE_METHOD_LARGEST verwendet, wenn die Ergebnisse in absteigender Reihenfolge sortiert werden. AGGREGATE_METHOD_SMALLEST wird verwendet, wenn die Ergebnisse in aufsteigender Reihenfolge sortiert werden.

Enums
AGGREGATE_METHOD_UNSPECIFIED Die nicht angegebene Aggregationsmethode wird wie oben erwähnt überschrieben.
AGGREGATE_METHOD_LARGEST Der größte (lexikographische oder numerische) Wert wird für die Sortierung verwendet.
AGGREGATE_METHOD_SMALLEST Der kleinste (lexikographische oder numerische) Wert wird sortiert.

FacetGroup

Eine Gruppe von Facetten-Buckets, die zwischen Backend und Frontend übergeben werden.

JSON-Darstellung 
{
  "facetId": string,
  "displayName": string,
  "buckets": [
    {
      object (FacetBucket)
    }
  ],
  "bucketType": enum (FacetBucketType),
  "fetchMatchedAnnotations": boolean
}
Felder
facetId

string

Die eindeutige ID der Facettengruppe.
displayName

string

Der Anzeigename der Facette. Wird von der Benutzeroberfläche für das Facett-Rendering verwendet.
buckets[]

object (FacetBucket)

Mit der Facette verknüpfte Buckets. Für die Facette „Team“ kann der Bucket beispielsweise „49ers“ oder „Patriots“ sein.
bucketType

enum (FacetBucketType)

Bucket-Typ der Facette.
fetchMatchedAnnotations

boolean

Wenn „wahr“ ist, werden Anmerkungen zurückgegeben, die mit der Abfrage übereinstimmen, für die Auswahl dieser Facettengruppe. Diese Option gilt nur für Facetten, die auf Anmerkungen auf Partitionsebene basieren. Folgende Facettenwerte werden unterstützt:  – INTEGER  – STRING (nur DataSchema.SearchStrategy.EXACT_SEARCH)

FacetBucket

Enthält den Facettenwert, den Auswahlstatus und die Metadaten.

JSON-Darstellung 
{
  "selected": boolean,

  // Union field bucket_value can be only one of the following:
  "value": {
    object (FacetValue)
  },
  "range": {
    object (Range)
  }
  // End of list of possible types for union field bucket_value.
}
Felder
selected

boolean

Gibt an, ob ein Facetten-Bucket ausgewählt ist. Dieses Feld stellt die Auswahl der Facetten des Nutzers dar. Wird vom Frontend in SearchVideosRequest festgelegt.
Union-Feld bucket_value. Bucket, der mit einer Facette verknüpft ist. Beispielsweise kann der Bucket der Facette „Team“ „49ers“ oder „Patriots“ sein. Der Bucket der Facette „Spieler“ kann „Tom Brady“ oder „Drew Brees“ sein. bucket_value kann nur einer der folgenden Werte sein:
value

object (FacetValue)

Singularwert.
range

object (Range)

Bereichswert.

Bereich

Der Wertebereich [start, end], auf den die Facetten angewendet werden.

JSON-Darstellung 
{
  "start": {
    object (FacetValue)
  },
  "end": {
    object (FacetValue)
  }
}
Felder
start

object (FacetValue)

Beginn des Bereichs. Das Fehlen einer Lösung gibt eine Grenze an (z.B. -inf).
end

object (FacetValue)

Ende des Bereichs. Die Nichtexistenz gibt eine Grenze an (z.B. „inf“).