Dela via


Referens för API för videohämtning

Autentisering

Ta med följande rubriker när du anropar ett API i det här dokumentet.

Ocp-Apim-Subscription-Key: YOUR_COMPUTER_VISION_KEY Version: 2023-05-01-preview

CreateIndex

webbadress

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

beskrivning

Den här metoden skapar ett index som sedan kan användas för att mata in dokument. Ett index måste skapas innan inmatning kan utföras.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på det index som ska skapas. Ja sträng
api-version query Begärd API-version. Ja sträng
brödtext brödtext Begärandetexten som innehåller metadata som kan användas för sökning. Ja CreateIngestionIndexRequestModel

Svar

Kod Description Typ
201 Skapades GetIngestionIndexResponseModel

GetIndex

webbadress

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

beskrivning

Hämtar indexet med det angivna namnet.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på indexet som ska hämtas. Ja sträng
api-version query Begärd API-version. Ja sträng

Svar

Kod Description Typ
200 Framgång GetIngestionIndexResponseModel
standard Fel ErrorResponse

UpdateIndex

webbadress

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

beskrivning

Uppdaterar ett index med det angivna namnet.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på det index som ska uppdateras. Ja sträng
api-version query Begärd API-version. Ja sträng
brödtext brödtext Begärandetexten som innehåller de uppdateringar som ska tillämpas på indexet. Ja UpdateIngestionIndexRequestModel

Svar

Kod Description Typ
200 Framgång GetIngestionIndexResponseModel
standard Fel ErrorResponse

DeleteIndex

webbadress

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

beskrivning

Tar bort ett index och alla tillhörande inmatningsdokument.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på det index som ska tas bort. Ja sträng
api-version query Begärd API-version. Ja sträng

Svar

Kod beskrivning
204 Inget innehåll

ListIndex

webbadress

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

beskrivning

Hämtar en lista över alla index för alla inmatningar.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
$skip query Antal datauppsättningar som ska hoppas över. Nej integer
$top query Antal datauppsättningar som ska returneras efter hoppar över. Nej integer
api-version query Begärd API-version. Ja sträng

Svar

Kod Description Typ
200 Framgång GetIngestionIndexResponseModelCollectionApiModel
standard Fel ErrorResponse

Skapaingestion

webbadress

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

beskrivning

Inmatningsbegäran kan ha videonyttolast. Det kan ha något av de tre lägena (lägg till, uppdatera eller ta bort). Lägg till läge skapar en inmatning och bearbetar videon. Uppdateringsläget uppdaterar endast metadata. För att kunna bearbeta videon igen måste inmatningen tas bort och återskapas.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på det index som inmatningen ska skapas till. Ja sträng
ingestionName path Namnet på den inmatning som ska skapas. Ja sträng
api-version query Begärd API-version. Ja sträng
brödtext brödtext Begärandetexten som innehåller inmatningsbegäran som ska skapas. Ja CreateIngestionRequestModel

Svar

Kod Description Typ
202 Godkänd IngestionResponseModel

GetIngestion

webbadress

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

beskrivning

Hämtar inmatningsstatusen för det angivna index- och inmatningsnamnet.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på det index som inmatningsstatusen ska kontrolleras för. Ja sträng
ingestionName path Namnet på den inmatning som ska hämtas. Ja sträng
detailLevel query En nivå som anger informationsnivå per dokumentinmatningsstatus. Nej sträng
api-version query Begärd API-version. Ja sträng

Svar

Kod Description Typ
200 Framgång IngestionResponseModel
standard Fel ErrorResponse

Listingestions

webbadress

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

beskrivning

Hämtar alla inmatningar för det specifika indexet.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på det index som inmatningarna ska hämtas för. Ja sträng
api-version query Begärd API-version. Ja sträng

Svar

Kod Description Typ
200 Framgång IngestionResponseModelCollectionApiModel
standard Fel ErrorResponse

ListDokument

webbadress

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

beskrivning

Hämtar alla dokument för det specifika indexet.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på det index som dokumenten ska hämtas för. Ja sträng
$skip query Antal datauppsättningar som ska hoppas över. Nej integer
$top query Antal datauppsättningar som ska returneras efter hoppar över. Nej integer
api-version query Begärd API-version. Ja sträng

Svar

Kod Description Typ
200 Framgång IngestionDocumentResponseModelCollectionApiModel
standard Fel ErrorResponse

SearchByText

webbadress

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

beskrivning

Utför en textbaserad sökning på det angivna indexet.

Parameters

Name Finns i beskrivning Obligatoriskt Typ
indexName path Namnet på indexet som ska sökas. Ja sträng
api-version query Begärd API-version. Ja sträng
brödtext brödtext Begärandetexten som innehåller frågan och andra parametrar. Ja SearchQueryTextRequestModel

Svar

Kod Description Typ
200 Framgång SearchResultDocumentModelCollectionApiModel
standard Fel ErrorResponse

Modeller

CreateIngestionIndexRequestModel

Representerar modellen för begäran om att skapa inmatningsindex för JSON-dokumentet.

Namn Type Beskrivning Obligatoriskt
metadataSchema MetadataSchemaModel Nej
funktioner [ FeatureModel ] Hämtar eller anger listan över funktioner för dokumentet. Standardvärdet är "vision". Nej
userData objekt Hämtar eller anger användardata för dokumentet. Nej

CreateIngestionRequestModel

Representerar modellen för att skapa inmatningsbegäran för JSON-dokumentet.

Namn Type Beskrivning Obligatoriskt
Videor [ IngestionDocumentRequestModel ] Hämtar eller anger listan över begäranden om inmatning av videodokument i JSON-dokumentet. Nej
ändring boolean Hämtar eller anger modereringsflaggan som anger om innehållet ska modereras. Nej
generateInsightIntervals boolean Hämtar eller anger flaggan för intervallgenerering som anger om insiktsintervall ska genereras. Nej
documentAuthenticationKind sträng Hämtar eller anger den autentiseringstyp som ska användas för att ladda ned dokumenten.
Uppräkning: "none", "managedIdentity"
Nej
filterDefectedFrames boolean Ramfilterflaggan som anger ramar utvärderas och alla infekterade (t.ex. suddiga, lågljusa, överexponering) kommer att filtreras bort. Nej
includeSpeechTranscript boolean Hämtar eller anger avskriftsgenereringsflaggan som anger om avskriften ska genereras. Nej

DatetimeFilterModel

Representerar ett datetime-filter som ska tillämpas på en sökfråga.

Namn Type Beskrivning Obligatoriskt
fieldName sträng Hämtar eller anger namnet på fältet som ska filtreras på. Ja
startTime sträng Hämtar eller anger starttiden för intervallet som ska filtreras på. Nej
endTime sträng Hämtar eller anger sluttiden för intervallet som ska filtreras på. Nej

ErrorResponse

Svaret returnerades när ett fel inträffar.

Namn Type Beskrivning Obligatoriskt
fel ErrorResponseDetails Ja

ErrorResponseDetails

Felinformation.

Namn Type Beskrivning Obligatoriskt
kod sträng Felkod. Ja
meddelande sträng Felmeddelande. Ja
mål sträng Målet för felet. Nej
information [ ErrorResponseDetails ] Lista över detaljerade fel. Nej
innererror ErrorResponseInnerError Nej

ErrorResponseInnerError

Detaljerat fel.

Namn Type Beskrivning Obligatoriskt
kod sträng Felkod. Ja
meddelande sträng Felmeddelande. Ja
innererror ErrorResponseInnerError Nej

FeatureModel

Representerar en funktion i indexet.

Namn Type Beskrivning Obligatoriskt
name sträng Hämtar eller anger namnet på funktionen.
Uppräkning: "vision", "speech"
Ja
modelVersion sträng Hämtar eller anger modellens version av funktionen. Nej
domain sträng Hämtar eller anger funktionens modelldomän.
Uppräkning: "generic", "surveillance"
Nej

GetIngestionIndexResponseModel

Representerar svarsmodellen get ingestion index för JSON-dokumentet.

Namn Type Beskrivning Obligatoriskt
name sträng Hämtar eller anger egenskapen indexnamn. Nej
metadataSchema MetadataSchemaModel Nej
userData objekt Hämtar eller anger användardata för dokumentet. Nej
funktioner [ FeatureModel ] Hämtar eller anger listan över funktioner i indexet. Nej
eTag sträng Hämtar eller anger etag. Ja
createdDateTime dateTime Hämtar eller anger den skapade datum- och tidsegenskapen. Ja
lastModifiedDateTime dateTime Hämtar eller anger den senast ändrade datum- och tidsegenskapen. Ja

GetIngestionIndexResponseModelCollectionApiModel

Innehåller en matris med resultat som kan vara sidnumrerade.

Namn Type Beskrivning Obligatoriskt
värde [ GetIngestionIndexResponseModel ] Matrisen med resultat. Ja
nextLink sträng En länk till nästa uppsättning sidnumrerade resultat, om det finns fler tillgängliga resultat. inte finns i övrigt. Nej

IngestionDocumentRequestModel

Representerar en begäran om inmatning av videodokument i JSON-dokumentet.

Namn Type Beskrivning Obligatoriskt
läge sträng Hämtar eller anger inmatningsläget för dokumentet.
Uppräkning: "add", "update", "remove"
Ja
documentId sträng Hämtar eller anger dokument-ID:t. Nej
documentUrl string (uri) Hämtar eller anger dokumentets URL. Eventuella signaturer för delad åtkomst (SAS) tas bort från URL:en. Ja
metadata objekt Hämtar eller anger metadata för dokumentet som en ordlista med namn/värde-par. Nej
userData objekt Hämtar eller anger användardata för dokumentet. Nej

IngestionDocumentResponseModel

Representerar ett inmatningsdokumentsvarsobjekt i JSON-dokumentet.

Namn Type Beskrivning Obligatoriskt
documentId sträng Hämtar eller anger dokument-ID:t. Nej
documentUrl string (uri) Hämtar eller anger dokumentets URL. Eventuella signaturer för delad åtkomst (SAS) tas bort från URL:en. Nej
metadata objekt Hämtar eller anger nyckel/värde-paren med metadata. Nej
fel ErrorResponseDetails Nej
createdDateTime dateTime Hämtar eller anger det skapade datumet och tiden för dokumentet. Nej
lastModifiedDateTime dateTime Hämtar eller anger dokumentets senast ändrade datum och tid. Nej
userData objekt Hämtar eller anger användardata för dokumentet. Nej

IngestionDocumentResponseModelCollectionApiModel

Innehåller en matris med resultat som kan vara sidnumrerade.

Namn Type Beskrivning Obligatoriskt
värde [ IngestionDocumentResponseModel ] Matrisen med resultat. Ja
nextLink sträng En länk till nästa uppsättning sidnumrerade resultat, om det finns fler tillgängliga resultat. inte finns i övrigt. Nej

IngestionErrorDetailsApiModel

Representerar information om inmatningsfel för varje dokument.

Namn Type Beskrivning Obligatoriskt
kod sträng Felkod. Nej
meddelande sträng Felmeddelande. Nej
innerError IngestionInnerErrorDetailsApiModel Nej

IngestionInnerErrorDetailsApiModel

Representerar information om inmatning av inre fel för varje dokument.

Namn Type Beskrivning Obligatoriskt
kod sträng Felkod. Nej
meddelande sträng Felmeddelande. Nej
innerError IngestionInnerErrorDetailsApiModel Nej

IngestionResponseModel

Representerar inmatningssvarsmodellen för JSON-dokumentet.

Namn Type Beskrivning Obligatoriskt
name sträng Hämtar eller anger namnet på inmatningen. Nej
tillstånd string Hämtar eller anger inmatningens tillstånd.
Uppräkning: "notStarted", "running", "completed", "failed", "partiallySucceeded"
Nej
fel ErrorResponseDetails Nej
batchName sträng Namnet på batchen som är associerad med den här inmatningen. Nej
createdDateTime dateTime Hämtar eller anger det skapade datumet och tiden för inmatningen. Nej
lastModifiedDateTime dateTime Hämtar eller anger det senast ändrade datumet och tiden för inmatningen. Nej
fileStatusDetails [ IngestionStatusDetailsApiModel ] Listan över inmatningsstatusar för varje dokument. Nej

IngestionResponseModelCollectionApiModel

Innehåller en matris med resultat som kan vara sidnumrerade.

Namn Type Beskrivning Obligatoriskt
värde [ IngestionResponseModel ] Matrisen med resultat. Ja
nextLink sträng En länk till nästa uppsättning sidnumrerade resultat, om det finns fler tillgängliga resultat. inte finns i övrigt. Nej

IngestionStatusDetailsApiModel

Representerar information om inmatningsstatus för varje dokument.

Namn Type Beskrivning Obligatoriskt
lastUpdateTime dateTime Statusuppdateringstid för batchsegmentet. Ja
documentId sträng Dokument-ID:t. Ja
documentUrl string (uri) Dokumentets URL. Nej
Lyckades boolean En flagga som anger om slutsatsdragningen lyckades. Ja
fel IngestionErrorDetailsApiModel Nej

MetadataSchemaFieldModel

Representerar ett fält i metadataschemat.

Namn Type Beskrivning Obligatoriskt
name sträng Hämtar eller anger namnet på fältet. Ja
sökbart boolean Hämtar eller anger ett värde som anger om fältet är sökbart. Ja
filtrerbart boolean Hämtar eller anger ett värde som anger om fältet kan filtreras. Ja
type sträng Hämtar eller anger typen av fält. Det kan vara sträng eller datetime.
Uppräkning: "string", "datetime"
Ja

MetadataSchemaModel

Representerar metadataschemat för dokumentet.

Namn Type Beskrivning Obligatoriskt
språk string Hämtar eller anger språket för metadataschemat. Standardvärdet är "en". Nej
Fält [ MetadataSchemaFieldModel ] Hämtar eller anger listan med fält i metadataschemat. Ja

SearchFiltersModel

Representerar filtren som ska tillämpas på en sökfråga.

Namn Type Beskrivning Obligatoriskt
stringFilters [ StringFilterModel ] Hämtar eller ställer in strängfiltren som ska tillämpas på sökfrågan. Nej
datetimeFilters [ DatetimeFilterModel ] Hämtar eller anger de datetime-filter som ska tillämpas på sökfrågan. Nej
featureFilters [ sträng ] Hämtar eller anger vilka funktionsfilter som ska tillämpas på sökfrågan. Nej

SearchQueryTextRequestModel

Representerar en sökfrågeförfrågansmodell för textbaserad sökning.

Namn Type Beskrivning Obligatoriskt
queryText sträng Hämtar eller anger frågetexten. Ja
filter SearchFiltersModel Nej
ändring boolean Hämtar eller anger ett booleskt värde som anger om modereringen är aktiverad eller inaktiverad. Nej
top integer Hämtar eller anger antalet resultat som ska hämtas. Ja
hoppa över integer Hämtar eller anger antalet resultat som ska hoppa över. Ja
additionalIndexNames [ sträng ] Hämtar eller anger de ytterligare indexnamn som ska inkluderas i sökfrågan. Nej
deduplicerad boolean Om du vill ta bort liknande videoramar. Ja
dedupMaxDocumentCount integer Maximalt antal dokument efter deduplicering. Ja
disableMetadataSearch boolean Hämtar eller anger ett booleskt värde som anger om metadata är inaktiverade i sökningen eller inte. Ja

SearchResultDocumentModel

Representerar ett sökfrågesvar.

Namn Type Beskrivning Obligatoriskt
documentId sträng Hämtar eller anger ID för dokumentet. Nej
documentKind sträng Hämtar eller anger typen av dokument, som kan vara "video". Nej
start sträng Hämtar eller anger starttiden för dokumentet. Den här egenskapen gäller endast för videodokument. Nej
end sträng Hämtar eller anger sluttiden för dokumentet. Den här egenskapen gäller endast för videodokument. Nej
bäst sträng Hämtar eller anger tidsstämpeln för dokumentet med högsta relevanspoäng. Den här egenskapen gäller endast för videodokument. Nej
relevans dubbel Hämtar eller anger relevanspoängen för dokumentet. Ja
additionalMetadata objekt Hämtar eller anger ytterligare metadata som är relaterade till sökning. Nej

SearchResultDocumentModelCollectionApiModel

Innehåller en matris med resultat som kan vara sidnumrerade.

Namn Type Beskrivning Obligatoriskt
värde [ SearchResultDocumentModel ] Matrisen med resultat. Ja
nextLink sträng En länk till nästa uppsättning sidnumrerade resultat, om det finns fler tillgängliga resultat. inte finns i övrigt. Nej

StringFilterModel

Representerar ett strängfilter som ska tillämpas på en sökfråga.

Namn Type Beskrivning Obligatoriskt
fieldName sträng Hämtar eller anger namnet på fältet som ska filtreras på. Ja
values [ sträng ] Hämtar eller anger de värden som ska filtreras på. Ja

UpdateIngestionIndexRequestModel

Representerar modellen för begäran om uppdateringsinmatningsindex för JSON-dokumentet.

Namn Type Beskrivning Obligatoriskt
metadataSchema MetadataSchemaModel Nej
userData objekt Hämtar eller anger användardata för dokumentet. Nej