Condividi tramite

Informazioni di riferimento sull'API recupero video

  • Articolo

Autenticazione

Includere le intestazioni seguenti quando si effettua una chiamata a qualsiasi API in questo documento.

Ocp-Apim-Subscription-Key: Versione: YOUR_COMPUTER_VISION_KEY2023-05-01-preview

CreateIndex

URL

PUT /retrieval/indexes/{indexName}?api-version=<version_number>

Descrizione

Questo metodo crea un indice, che può quindi essere usato per inserire documenti. Prima di poter eseguire l'inserimento, è necessario creare un indice.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice da creare. Sì string
api-version query Versione dell'API richiesta. Sì string
body body Corpo della richiesta contenente i metadati che possono essere usati per la ricerca. Sì CreateIngestionIndexRequestModel

Risposte

Codice Description Tipo
201 Creato GetIngestionIndexResponseModel

GetIndex

URL

GET /retrieval/indexes/{indexName}?api-version=<version_number>

Descrizione

Recupera l'indice con il nome specificato.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice da recuperare. Sì string
api-version query Versione dell'API richiesta. Sì string

Risposte

Codice Description Tipo
200 Riuscita GetIngestionIndexResponseModel
impostazione predefinita Error ErrorResponse

UpdateIndex

URL

PATCH /retrieval/indexes/{indexName}?api-version=<version_number>

Descrizione

Aggiorna un indice con il nome specificato.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice da aggiornare. Sì string
api-version query Versione dell'API richiesta. Sì string
body body Corpo della richiesta contenente gli aggiornamenti da applicare all'indice. Sì UpdateIngestionIndexRequestModel

Risposte

Codice Description Tipo
200 Riuscita GetIngestionIndexResponseModel
impostazione predefinita Error ErrorResponse

DeleteIndex

URL

DELETE /retrieval/indexes/{indexName}?api-version=<version_number>

Descrizione

Elimina un indice e tutti i documenti di inserimento associati.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice da eliminare. Sì string
api-version query Versione dell'API richiesta. Sì string

Risposte

Codice Descrizione
204 Nessun contenuto

ListIndexes

URL

GET /retrieval/indexes?api-version=<version_number>

Descrizione

Recupera un elenco di tutti gli indici in tutti gli inserimenti.

Parametri

Nome Posizione Descrizione Richiesto Type
$skip query Numero di set di dati da ignorare. No integer
$top query Numero di set di dati da restituire dopo l'omissione. No integer
api-version query Versione dell'API richiesta. Sì string

Risposte

Codice Description Tipo
200 Riuscita GetIngestionIndexResponseModelCollectionApiModel
impostazione predefinita Error ErrorResponse

CreateIngestion

URL

PUT /retrieval/indexes/{indexName}/ingestions/{ingestionName}?api-version=<version_number>

Descrizione

La richiesta di inserimento può avere payload video. Può avere una delle tre modalità (aggiungere, aggiornare o rimuovere). La modalità aggiungi creerà un inserimento ed eseguirà l'elaborazione del video. La modalità di aggiornamento aggiornerà solo i metadati. Per rielaborare il video, l'inserimento deve essere eliminato e ricreato.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice in cui deve essere creato l'inserimento. Sì string
ingestionName path Nome dell'inserimento da creare. Sì string
api-version query Versione dell'API richiesta. Sì string
body body Corpo della richiesta contenente la richiesta di inserimento da creare. Sì CreateIngestionRequestModel

Risposte

Codice Description Tipo
202 Accettata IngestionResponseModel

GetIngestion

URL

GET /retrieval/indexes/{indexName}/ingestions/{ingestionName}?api-version=<version_number>

Descrizione

Ottiene lo stato di inserimento per l'indice e il nome di inserimento specificati.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice per cui controllare lo stato di inserimento. Sì string
ingestionName path Nome dell'inserimento da recuperare. Sì string
detailLevel query Livello per indicare il livello di dettaglio per ogni stato di inserimento di documenti. No string
api-version query Versione dell'API richiesta. Sì string

Risposte

Codice Description Tipo
200 Riuscita IngestionResponseModel
impostazione predefinita Error ErrorResponse

ListIngestions

URL

GET /retrieval/indexes/{indexName}/ingestions?api-version=<version_number>

Descrizione

Recupera tutti gli inserimenti per l'indice specifico.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice per il quale recuperare gli inserimenti. Sì string
api-version query Versione dell'API richiesta. Sì string

Risposte

Codice Description Tipo
200 Riuscita IngestionResponseModelCollectionApiModel
impostazione predefinita Error ErrorResponse

ListDocuments

URL

GET /retrieval/indexes/{indexName}/documents?api-version=<version_number>

Descrizione

Recupera tutti i documenti per l'indice specifico.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice per il quale recuperare i documenti. Sì string
$skip query Numero di set di dati da ignorare. No integer
$top query Numero di set di dati da restituire dopo l'omissione. No integer
api-version query Versione dell'API richiesta. Sì string

Risposte

Codice Description Tipo
200 Riuscita IngestionDocumentResponseModelCollectionApiModel
impostazione predefinita Error ErrorResponse

SearchByText

URL

POST /retrieval/indexes/{indexName}:queryByText?api-version=<version_number>

Descrizione

Esegue una ricerca basata su testo sull'indice specificato.

Parametri

Nome Posizione Descrizione Richiesto Type
indexName path Nome dell'indice da cercare. Sì string
api-version query Versione dell'API richiesta. Sì string
body body Corpo della richiesta contenente la query e altri parametri. Sì SearchQueryTextRequestModel

Risposte

Codice Description Tipo
200 Riuscita SearchResultDocumentModelCollectionApiModel
impostazione predefinita Error ErrorResponse

Modelli

CreateIngestionIndexRequestModel

Rappresenta il modello di richiesta di indice di inserimento per il documento JSON.

Nome Tipo Descrizione Richiesto
metadataSchema MetadataSchemaModel No
modelli di ARM [ FeatureModel ] Ottiene o imposta l'elenco di funzionalità per il documento. Il valore predefinito è "visione". No
userData oggetto Ottiene o imposta i dati utente per il documento. No

CreateIngestionRequestModel

Rappresenta il modello di richiesta di inserimento per il documento JSON.

Nome Tipo Descrizione Richiesto
videos [ IngestionDocumentRequestModel ] Ottiene o imposta l'elenco delle richieste di inserimento di documenti video nel documento JSON. No
moderazione boolean Ottiene o imposta il flag di moderazione, che indica se il contenuto deve essere moderato. No
generateInsightIntervals boolean Ottiene o imposta il flag di generazione dell'intervallo, che indica se devono essere generati intervalli di informazioni dettagliate. No
documentAuthenticationKind string Ottiene o imposta il tipo di autenticazione da utilizzare per il download dei documenti.
Enumerazione: "none", "managedIdentity"		 No
filterDefectedFrames boolean Flag di filtro dei frame che indica che i fotogrammi verranno valutati e tutti i fotogrammi difetti (ad esempio sfocati, a bassa illuminazione, sovraesposizione) verranno filtrati. No
includeSpeechTranscript boolean Ottiene o imposta il flag di generazione della trascrizione, che indica se deve essere generata la trascrizione. No

DatetimeFilterModel

Rappresenta un filtro datetime da applicare a una query di ricerca.

Nome Tipo Descrizione Richiesto
fieldName string Ottiene o imposta il nome del campo da filtrare. Sì
startTime string Ottiene o imposta l'ora di inizio dell'intervallo su cui filtrare. No
endTime string Ottiene o imposta l'ora di fine dell'intervallo su cui filtrare. No

ErrorResponse

Risposta restituita quando si verifica un errore.

Nome Tipo Descrizione Richiesto
Errore ErrorResponseDetails Sì

ErrorResponseDetails

Informazioni sull'errore.

Nome Tipo Descrizione Richiesto
codice string Codice di errore. Sì
messaggio string Messaggio di errore. Sì
bersaglio string Destinazione dell'errore. No
dettagli [ ErrorResponseDetails ] Elenco di errori dettagliati. No
innererror ErrorResponseInnerError No

ErrorResponseInnerError

Errore dettagliato.

Nome Tipo Descrizione Richiesto
codice string Codice di errore. Sì
messaggio string Messaggio di errore. Sì
innererror ErrorResponseInnerError No

FeatureModel

Rappresenta una funzionalità nell'indice.

Nome Tipo Descrizione Richiesto
name string Ottiene o imposta il nome della funzionalità.
Enumerazione: "vision", "speech"		 Sì
modelVersion string Ottiene o imposta la versione del modello della funzionalità. No
dominio string Ottiene o imposta il dominio del modello della funzionalità.
Enumerazione: "generic", "surveillance"		 No

GetIngestionIndexResponseModel

Rappresenta il modello di risposta dell'indice di inserimento get per il documento JSON.

Nome Tipo Descrizione Richiesto
name string Ottiene o imposta la proprietà del nome dell'indice. No
metadataSchema MetadataSchemaModel No
userData oggetto Ottiene o imposta i dati utente per il documento. No
modelli di ARM [ FeatureModel ] Ottiene o imposta l'elenco di funzionalità nell'indice. No
eTag string Ottiene o imposta l'etag. Sì
createdDateTime dateTime Ottiene o imposta la proprietà data e ora create. Sì
lastModifiedDateTime dateTime Ottiene o imposta la proprietà data e ora dell'ultima modifica. Sì

GetIngestionIndexResponseModelCollectionApiModel

Contiene una matrice di risultati che possono essere impaginati.

Nome Tipo Descrizione Richiesto
value [ GetIngestionIndexResponseModel ] Matrice di risultati. Sì
nextLink string Collegamento al set successivo di risultati impaginati, se sono disponibili altri risultati; non presente in caso contrario. No

IngestionDocumentRequestModel

Rappresenta una richiesta di inserimento di documenti video nel documento JSON.

Nome Tipo Descrizione Richiesto
mode string Ottiene o imposta la modalità di inserimento per il documento.
Enumerazione: "add", "update", "remove"		 Sì
documentId string Ottiene o imposta l'ID documento. No
documentUrl string (uri) Ottiene o imposta l'URL del documento. La firma di accesso condiviso, se presente, verrà rimossa dall'URL. Sì
metadata oggetto Ottiene o imposta i metadati per il documento come dizionario di coppie nome-valore. No
userData oggetto Ottiene o imposta i dati utente per il documento. No

IngestionDocumentResponseModel

Rappresenta un oggetto risposta documento di inserimento nel documento JSON.

Nome Tipo Descrizione Richiesto
documentId string Ottiene o imposta l'ID documento. No
documentUrl string (uri) Ottiene o imposta l'URL del documento. La firma di accesso condiviso, se presente, verrà rimossa dall'URL. No
metadata oggetto Ottiene o imposta le coppie chiave-valore dei metadati. No
Errore ErrorResponseDetails No
createdDateTime dateTime Ottiene o imposta la data e l'ora create del documento. No
lastModifiedDateTime dateTime Ottiene o imposta la data e l'ora dell'ultima modifica del documento. No
userData oggetto Ottiene o imposta i dati utente per il documento. No

IngestionDocumentResponseModelCollectionApiModel

Contiene una matrice di risultati che possono essere impaginati.

Nome Tipo Descrizione Richiesto
value [ IngestionDocumentResponseModel ] Matrice di risultati. Sì
nextLink string Collegamento al set successivo di risultati impaginati, se sono disponibili altri risultati; non presente in caso contrario. No

IngestionErrorDetailsApiModel

Rappresenta le informazioni sull'errore di inserimento per ogni documento.

Nome Tipo Descrizione Richiesto
codice string Codice di errore. No
messaggio string Messaggio di errore. No
innerError IngestionInnerErrorDetailsApiModel No

IngestionInnerErrorDetailsApiModel

Rappresenta le informazioni di inserimento interno-errore per ogni documento.

Nome Tipo Descrizione Richiesto
codice string Codice di errore. No
messaggio string Messaggio di errore. No
innerError IngestionInnerErrorDetailsApiModel No

IngestionResponseModel

Rappresenta il modello di risposta di inserimento per il documento JSON.

Nome Tipo Descrizione Richiesto
name string Ottiene o imposta il nome dell'inserimento. No
state string Ottiene o imposta lo stato dell'inserimento.
Enumerazione: "notStarted", "running", "completed", "failed", "partiallySucceeded"		 No
Errore ErrorResponseDetails No
batchName string Nome del batch associato a questo inserimento. No
createdDateTime dateTime Ottiene o imposta la data e l'ora di creazione dell'inserimento. No
lastModifiedDateTime dateTime Ottiene o imposta la data e l'ora dell'ultima modifica dell'inserimento. No
fileStatusDetails [ IngestionStatusDetailsApiModel ] Elenco degli stati di inserimento per ogni documento. No

IngestionResponseModelCollectionApiModel

Contiene una matrice di risultati che possono essere impaginati.

Nome Tipo Descrizione Richiesto
value [ IngestionResponseModel ] Matrice di risultati. Sì
nextLink string Collegamento al set successivo di risultati impaginati, se sono disponibili altri risultati; non presente in caso contrario. No

IngestionStatusDetailsApiModel

Rappresenta i dettagli dello stato di inserimento per ogni documento.

Nome Tipo Descrizione Richiesto
lastUpdateTime dateTime Ora di aggiornamento dello stato del blocco batch. Sì
documentId string ID documento. Sì
documentUrl string (uri) URL del documento. No
succeeded boolean Flag per indicare se l'inferenza è riuscita. Sì
Errore IngestionErrorDetailsApiModel No

MetadataSchemaFieldModel

Rappresenta un campo nello schema dei metadati.

Nome Tipo Descrizione Richiesto
name string Ottiene o imposta il nome del campo. Sì
searchable boolean Ottiene o imposta un valore che indica se il campo è ricercabile. Sì
filterable boolean Ottiene o imposta un valore che indica se il campo è filtrabile. Sì
type string Ottiene o imposta il tipo del campo. Potrebbe trattarsi di stringa o datetime.
Enumerazione: "string", "datetime"		 Sì

MetadataSchemaModel

Rappresenta lo schema dei metadati per il documento.

Nome Tipo Descrizione Richiesto
lingua string Ottiene o imposta il linguaggio dello schema dei metadati. Il valore predefinito è "en". No
campi [ MetadataSchemaFieldModel ] Ottiene o imposta l'elenco di campi nello schema dei metadati. Sì

SearchFiltersModel

Rappresenta i filtri da applicare a una query di ricerca.

Nome Tipo Descrizione Richiesto
stringFilters [ StringFilterModel ] Ottiene o imposta i filtri stringa da applicare alla query di ricerca. No
datetimeFilters [ DatetimeFilterModel ] Ottiene o imposta i filtri datetime da applicare alla query di ricerca. No
featureFilters [ string ] Ottiene o imposta i filtri di funzionalità da applicare alla query di ricerca. No

SearchQueryTextRequestModel

Rappresenta un modello di richiesta di query di ricerca per la ricerca basata su testo.

Nome Tipo Descrizione Richiesto
queryText string Ottiene o imposta il testo della query. Sì
filtri SearchFiltersModel No
moderazione boolean Ottiene o imposta un valore booleano che indica se la moderazione è abilitata o disabilitata. No
migliori integer Ottiene o imposta il numero di risultati da recuperare. Sì
skip integer Ottiene o imposta il numero di risultati da ignorare. Sì
additionalIndexNames [ string ] Ottiene o imposta i nomi di indice aggiuntivi da includere nella query di ricerca. No
dedup boolean Indica se rimuovere fotogrammi video simili. Sì
dedupMaxDocumentCount integer Numero massimo di documenti dopo la deduplicazione. Sì
disableMetadataSearch boolean Ottiene o imposta un valore booleano che indica se i metadati sono disabilitati nella ricerca o meno. Sì

SearchResultDocumentModel

Rappresenta una risposta di query di ricerca.

Nome Tipo Descrizione Richiesto
documentId string Ottiene o imposta l'ID del documento. No
documentKind string Ottiene o imposta il tipo di documento, che può essere "video". No
Avvio string Ottiene o imposta l'ora di inizio del documento. Questa proprietà è applicabile solo per i documenti video. No
end string Ottiene o imposta l'ora di fine del documento. Questa proprietà è applicabile solo per i documenti video. No
test string Ottiene o imposta il timestamp del documento con il punteggio di pertinenza più alto. Questa proprietà è applicabile solo per i documenti video. No
pertinenza double Ottiene o imposta il punteggio di pertinenza del documento. Sì
additionalMetadata oggetto Ottiene o imposta i metadati aggiuntivi correlati alla ricerca. No

SearchResultDocumentModelCollectionApiModel

Contiene una matrice di risultati che possono essere impaginati.

Nome Tipo Descrizione Richiesto
value [ SearchResultDocumentModel ] Matrice di risultati. Sì
nextLink string Collegamento al set successivo di risultati impaginati, se sono disponibili altri risultati; non presente in caso contrario. No

StringFilterModel

Rappresenta un filtro stringa da applicare a una query di ricerca.

Nome Tipo Descrizione Richiesto
fieldName string Ottiene o imposta il nome del campo da filtrare. Sì
valori [ string ] Ottiene o imposta i valori da filtrare. Sì

UpdateIngestionIndexRequestModel

Rappresenta il modello di richiesta dell'indice di inserimento degli aggiornamenti per il documento JSON.

Nome Tipo Descrizione Richiesto
metadataSchema MetadataSchemaModel No
userData oggetto Ottiene o imposta i dati utente per il documento. No