- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Autorizzazioni IAM
- SchemaKeySortingStrategy
- Opzione
- AggregateMethod
- FacetGroup
- FacetBucket
- Intervallo
Cerca l'asset media.
Richiesta HTTP
POST https://visionai.googleapis.com/v1alpha1/{corpus=projects/*/locations/*/corpora/*}:searchAssets
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
corpus |
Obbligatorio. Il corpus principale in cui eseguire la ricerca. Formato: "projects/{projectId}/locations/{locationId}/corpora/{corpus_id}" |
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "pageSize": integer, "pageToken": string, "contentTimeRanges": { object ( |
Campi | |
---|---|
pageSize |
Il numero di risultati da restituire in questa pagina. Se è 0, il server decide il valore appropriato di pageSize. |
pageToken |
Il token di continuazione per recuperare la pagina successiva. Se è vuoto, significa che sta recuperando la prima pagina. |
contentTimeRanges |
Gli intervalli di tempo entro i quali devono rientrare i contenuti video corrispondenti. Se non vengono forniti intervalli, non ci saranno limitazioni di tempo. Questo campo viene trattato come i criteri riportati di seguito, ma viene definito separatamente per praticità, in quanto viene utilizzato di frequente. Tieni presente che se endTime è nel futuro, verrà bloccato al momento di ricezione della richiesta. |
criteria[] |
Criteri applicati ai risultati di ricerca. |
exclusionCriteria[] |
Criteri da escludere dai risultati di ricerca. Tieni presente che |
facetSelections[] |
Memorizza lo stato di selezione del livello più recente. Qui verranno presentati solo i gruppi di aspetti con la selezione dell'utente. Lo stato di selezione è selezionato o deselezionato. Come criteri di ricerca verranno utilizzati solo i bucket delle sfaccettature selezionati. |
resultAnnotationKeys[] |
Un elenco di chiavi di annotazione per specificare le annotazioni da recuperare e restituire con ogni risultato di ricerca. La granularità dell'annotazione deve essere GRANULARITY_ASSET_LEVEL e la relativa strategia di ricerca non deve essere NO_SEARCH. |
searchQuery |
Query di ricerca globale. Consente all'utente di cercare le risorse senza dover specificare a quale campo appartiene il valore. |
Campo unione sort_spec . Specifica di ordinamento. Se questo campo non è specificato, per impostazione predefinita: - STREAM_VIDEO: i risultati di ricerca sono ordinati in base all'ora di inizio. sort_spec può essere solo uno dei seguenti: |
|
schemaKeySortingStrategy |
Ordina in base al valore sotto la chiave dello schema di dati. |
Corpo della risposta
Messaggio di risposta per corpora.searchAssets.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "searchResultItems": [ { object ( |
Campi | |
---|---|
searchResultItems[] |
Risultati di ricerca restituiti. |
nextPageToken |
Il token di continuazione della pagina successiva. |
facetResults[] |
Risultati di ricerca dei facet di una determinata query, che contengono i valori dei facet già selezionati dall'utente e i risultati di ricerca dei facet aggiornati. |
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/cloud-platform
Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.
Autorizzazioni IAM
Richiede la seguente autorizzazione IAM per la risorsa corpus
:
visionai.assets.search
Per ulteriori informazioni, consulta la documentazione di IAM.
SchemaKeySortingStrategy
Una strategia per specificare come ordinare in base alla chiave dello schema di dati.
Rappresentazione JSON |
---|
{
"options": [
{
object ( |
Campi | |
---|---|
options[] |
Le opzioni nella parte anteriore hanno una priorità maggiore rispetto a quelle nella parte posteriore. |
Opzione
Opzione per una chiave dello schema di dati.
Rappresentazione JSON |
---|
{
"dataSchemaKey": string,
"sortDecreasing": boolean,
"aggregateMethod": enum ( |
Campi | |
---|---|
dataSchemaKey |
I dati utilizzati per l'ordinamento. |
sortDecreasing |
Indica se ordinare in ordine decrescente o crescente. Per impostazione predefinita, i risultati sono ordinati in ordine crescente. |
aggregateMethod |
Metodo aggregato per la chiave dello schema di dati corrente. |
AggregateMethod
Quando un risultato ha più valori con la stessa chiave, specifica quale valore viene utilizzato per l'ordinamento. Per impostazione predefinita, AGGREGATE_METHOD_LARGEST viene utilizzato quando i risultati sono ordinati in ordine decrescente, mentre AGGREGATE_METHOD_SMALLEST viene utilizzato quando i risultati sono ordinati in ordine crescente.
Enum | |
---|---|
AGGREGATE_METHOD_UNSPECIFIED |
Il metodo aggregato non specificato verrà sovrascritto come indicato sopra. |
AGGREGATE_METHOD_LARGEST |
Prendi il valore più grande (alfabetico o numerico) da ordinare. |
AGGREGATE_METHOD_SMALLEST |
Prendi il valore più piccolo (alfabetico o numerico) da ordinare. |
FacetGroup
Un gruppo di bucket delle sfaccettature da passare avanti e indietro tra il backend e il frontend.
Rappresentazione JSON |
---|
{ "facetId": string, "displayName": string, "buckets": [ { object ( |
Campi | |
---|---|
facetId |
ID univoco del gruppo di aspetti. |
displayName |
Nome visualizzato del facet. Da utilizzare dall'interfaccia utente per il rendering delle sfaccettature. |
buckets[] |
Bucket associati al facet. Ad esempio, per l'aspetto "Squadra", il bucket può essere 49ers, patriots e così via. |
bucketType |
Tipo di bucket dei facet. |
fetchMatchedAnnotations |
Se true, restituisce le annotazioni corrispondenti alla query per la selezione di questo gruppo di aspetti. Questa opzione è applicabile solo ai livelli basati su annotazioni a livello di partizione. Supporta i seguenti valori di aspetto: - INTEGER - STRING (solo DataSchema.SearchStrategy.EXACT_SEARCH) |
FacetBucket
Contiene il valore del facet, lo stato delle selezioni e i metadati.
Rappresentazione JSON |
---|
{ "selected": boolean, // Union field |
Campi | |
---|---|
selected |
Indica se è selezionato un bucket di aspetti. Questo campo rappresenta la selezione delle sfaccettature da parte dell'utente. Viene impostato dal frontend in SearchVideosRequest. |
Campo unione bucket_value . Bucket associato a un facet. Ad esempio, il bucket dell'aspetto "squadra" può essere "49ers", "patriots" e così via; il bucket dell'aspetto "giocatore" può essere "tom brady", "drew brees" e così via. bucket_value può essere solo uno dei seguenti: |
|
value |
Valore singolare. |
range |
Valore dell'intervallo. |
Intervallo
L'intervallo di valori [start, end] per cui viene applicata la suddivisione in parti.
Rappresentazione JSON |
---|
{ "start": { object ( |
Campi | |
---|---|
start |
Inizio dell'intervallo. L'assenza indica un limite (ad es. -inf). |
end |
Fine dell'intervallo. L'inesistenza indica un limite (ad es. inf). |