Referência da API de Recuperação de Vídeo

Autenticação

Inclua os cabeçalhos a seguir ao fazer uma chamada para qualquer API neste documento.

ocp-apim-subscription-key: YOUR_COMPUTER_VISION_KEY Versão: 2023-05-01-preview

CreateIndex

URL

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

Descrição

Esse método cria um índice, que pode ser usado para ingerir documentos. Um índice precisa ser criado antes que a ingestão possa ser executada.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice a ser criado.	Sim	string
api-version	consulta	Versão da API solicitada.	Sim	string
body	body	O corpo da solicitação que contém os metadados que podem ser usados para pesquisa.	Sim	CreateIngestionIndexRequestModel

Respostas

Código	Description	Type
201	Criado em	GetIngestionIndexResponseModel

GetIndex

URL

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

Descrição

Recupera o índice com o nome especificado.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice a ser recompilado.	Sim	string
api-version	consulta	Versão da API solicitada.	Sim	string

Respostas

Código	Description	Type
200	Êxito	GetIngestionIndexResponseModel
default	Erro	ErrorResponse

UpdateIndex

URL

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

Descrição

Atualiza um índice com o nome especificado.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice a ser atualizado.	Sim	string
api-version	consulta	Versão da API solicitada.	Sim	string
body	body	O corpo da solicitação que contém as atualizações a serem aplicadas ao índice.	Sim	UpdateIngestionIndexRequestModel

Respostas

Código	Description	Type
200	Êxito	GetIngestionIndexResponseModel
default	Erro	ErrorResponse

DeleteIndex

URL

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

Descrição

Exclui um índice e todos os documentos de ingestão associados.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice a ser excluído.	Sim	string
api-version	consulta	Versão da API solicitada.	Sim	string

Respostas

Código	Descrição
204	Sem conteúdo

ListIndexes

URL

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

Descrição

Recupera uma lista de todos os índices em todas as ingestões.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
$skip	consulta	Número de conjuntos de dados a serem ignorados.	Não	Número inteiro
$top	consulta	Número de conjuntos de dados a serem retornados após ignorar.	Não	Número inteiro
api-version	consulta	Versão da API solicitada.	Sim	string

Respostas

Código	Description	Type
200	Êxito	GetIngestionIndexResponseModelCollectionApiModel
default	Erro	ErrorResponse

CreateIngestion

URL

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

Descrição

A solicitação de ingestão pode ter conteúdo de vídeo. Ele pode ter um dos três modos (adicionar, atualizar ou remover). O modo de adição criará uma ingestão e processará o vídeo. O modo de atualização atualizará apenas os metadados. Para reprocessar o vídeo, a ingestão precisa ser excluída e recriada.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice ao qual a ingestão deve ser criada.	Sim	string
ingestionName	path	O nome da ingestão a ser criada.	Sim	string
api-version	consulta	Versão da API solicitada.	Sim	string
body	body	O corpo da solicitação que contém a solicitação de ingestão a ser criada.	Sim	CreateIngestionRequestModel

Respostas

Código	Description	Type
202	Accepted	IngestionResponseModel

GetIngestion

URL

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

Descrição

Obtém o status de ingestão para o índice e o nome de ingestão especificados.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice para o qual o status de ingestão será verificado.	Sim	string
ingestionName	path	O nome da ingestão a ser recuperada.	Sim	string
detailLevel	consulta	Um nível para indicar o nível de detalhes por status de ingestão de documento.	Não	string
api-version	consulta	Versão da API solicitada.	Sim	string

Respostas

Código	Description	Type
200	Êxito	IngestionResponseModel
default	Erro	ErrorResponse

ListIngestions

URL

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

Descrição

Recupera todas as ingestões para o índice específico.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice para o qual recuperar as ingestões.	Sim	string
api-version	consulta	Versão da API solicitada.	Sim	string

Respostas

Código	Description	Type
200	Êxito	IngestionResponseModelCollectionApiModel
default	Erro	ErrorResponse

ListDocuments

URL

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

Descrição

Recupera todos os documentos para o índice específico.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice para o qual recuperar os documentos.	Sim	string
$skip	consulta	Número de conjuntos de dados a serem ignorados.	Não	Número inteiro
$top	consulta	Número de conjuntos de dados a serem retornados após ignorar.	Não	Número inteiro
api-version	consulta	Versão da API solicitada.	Sim	string

Respostas

Código	Description	Type
200	Êxito	IngestionDocumentResponseModelCollectionApiModel
default	Erro	ErrorResponse

SearchByText

URL

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

Descrição

Executa uma pesquisa baseada em texto no índice especificado.

Parâmetros

Nome	Localizado em	Descrição	Obrigatório	Tipo
indexName	path	O nome do índice a ser buscado.	Sim	string
api-version	consulta	Versão da API solicitada.	Sim	string
body	body	O corpo da solicitação que contém a consulta e outros parâmetros.	Sim	SearchQueryTextRequestModel

Respostas

Código	Description	Type
200	Êxito	SearchResultDocumentModelCollectionApiModel
default	Erro	ErrorResponse

Modelos

CreateIngestionIndexRequestModel

Representa o modelo de solicitação de índice de ingestão para o documento JSON.

Nome	Tipo	Descrição	Necessário
metadataSchema	MetadataSchemaModel		Não
features	[ FeatureModel ]	Obtém ou define a lista de recursos do documento. O padrão é "visão".	Não
userData	objeto	Obtém ou define os dados do usuário para o documento.	Não

CreateIngestionRequestModel

Representa o modelo de solicitação de ingestão de criação para o documento JSON.

Nome	Tipo	Descrição	Necessário
vídeos	[ IngestionDocumentRequestModel ]	Obtém ou define a lista de solicitações de ingestão de documento de vídeo no documento JSON.	Não
moderação	boolean	Obtém ou define o sinalizador de moderação, indicando se o conteúdo deve ser moderado.	Não
generateInsightIntervals	boolean	Obtém ou define o sinalizador de geração de intervalo, indicando se intervalos de insight devem ser gerados.	Não
documentAuthenticationKind	string	Obtém ou define o tipo de autenticação que deve ser usado para baixar os documentos. Enum: "none", "managedIdentity"	Não
filterDefectedFrames	boolean	O sinalizador de filtro de quadro que indica quadros será avaliado e todos os quadros desfocados (por exemplo, desfocados, luz baixa, sobreexposição) serão filtrados.	Não
includeSpeechTranscript	boolean	Obtém ou define o sinalizador de geração de transcrição, indicando se a transcrição deve ser gerada.	Não

DatetimeFilterModel

Representa um filtro datetime a ser aplicado em uma consulta de pesquisa.

Nome	Tipo	Descrição	Necessário
fieldName	string	Obtém ou define o nome do campo no qual filtrar.	Sim
startTime	string	Obtém ou define a hora de início do intervalo para filtrar.	Não
endTime	string	Obtém ou define a hora de término do intervalo para filtrar.	Não

ErrorResponse

Resposta retornada quando ocorre um erro.

Nome	Tipo	Descrição	Necessário
error	ErrorResponseDetails		Sim

ErrorResponseDetails

Informações de erro.

Nome	Tipo	Descrição	Obrigatório
código	string	Código do erro.	Sim
message	string	Mensagem de erro.	Sim
destino	string	Destino do erro.	Não
detalhes	[ ErrorResponseDetails ]	Lista de erros detalhados.	Não
innererror	ErrorResponseInnerError		Não

ErrorResponseInnerError

Erro detalhado.

Nome	Tipo	Descrição	Obrigatório
código	string	Código do erro.	Sim
message	string	Mensagem de erro.	Sim
innererror	ErrorResponseInnerError		Não

FeatureModel

Representa um recurso no índice.

Nome	Tipo	Descrição	Obrigatório
name	string	Obtém ou define o nome do recurso. Enum: "vision", "speech"	Sim
modelVersion	string	Obtém ou define a versão do modelo do recurso.	Não
domínio	string	Obtém ou define o domínio do modelo do recurso. Enum: "generic", "surveillance"	Não

GetIngestionIndexResponseModel

Representa o modelo de resposta do índice de ingestão get para o documento JSON.

Nome	Tipo	Descrição	Obrigatório
name	string	Obtém ou define a propriedade nome do índice.	Não
metadataSchema	MetadataSchemaModel		Não
userData	objeto	Obtém ou define os dados do usuário para o documento.	Não
features	[ FeatureModel ]	Obtém ou define a lista de recursos no índice.	Não
eTag	string	Obtém ou define a etag.	Sim
createdDateTime	dateTime	Obtém ou define a propriedade de data e hora criada.	Sim
lastModifiedDateTime	dateTime	Obtém ou define a data e hora em que essa propriedade foi modificada.	Sim

GetIngestionIndexResponseModelCollectionApiModel

Contém uma matriz de resultados que podem ser paginados.

Nome	Tipo	Descrição	Obrigatório
value	[ GetIngestionIndexResponseModel ]	A matriz de resultados.	Sim
nextLink	string	Um link para o próximo conjunto de resultados paginados, se houver mais resultados disponíveis; não está presente caso contrário.	Não

IngestionDocumentRequestModel

Representa uma solicitação de ingestão de documento de vídeo no documento JSON.

Nome	Tipo	Descrição	Necessário
mode	string	Obtém ou define o modo de ingestão do documento. Enum: "add", "update", "remove"	Sim
documentId	string	Obtém ou define a ID do documento.	Não
documentUrl	cadeia de caracteres (uri)	Obtém ou define a URL do documento. A SAS (assinatura de acesso compartilhado), se houver, será removida da URL.	Sim
metadata	objeto	Obtém ou define os metadados do documento como um dicionário de pares nome-valor.	Não
userData	objeto	Obtém ou define os dados do usuário para o documento.	Não

IngestionDocumentResponseModel

Representa um objeto de resposta de documento de ingestão no documento JSON.

Nome	Tipo	Descrição	Necessário
documentId	string	Obtém ou define a ID do documento.	Não
documentUrl	cadeia de caracteres (uri)	Obtém ou define a URL do documento. A SAS (assinatura de acesso compartilhado), se houver, será removida da URL.	Não
metadata	objeto	Obtém ou define os pares chave-valor de metadados.	Não
error	ErrorResponseDetails		Não
createdDateTime	dateTime	Obtém ou define a data e a hora criadas do documento.	Não
lastModifiedDateTime	dateTime	Obtém ou define a última data e hora modificadas do documento.	Não
userData	objeto	Obtém ou define os dados do usuário para o documento.	Não

IngestionDocumentResponseModelCollectionApiModel

Contém uma matriz de resultados que podem ser paginados.

Nome	Tipo	Descrição	Obrigatório
value	[ IngestionDocumentResponseModel ]	A matriz de resultados.	Sim
nextLink	string	Um link para o próximo conjunto de resultados paginados, se houver mais resultados disponíveis; não está presente caso contrário.	Não

IngestionErrorDetailsApiModel

Representa as informações de erro de ingestão para cada documento.

Nome	Tipo	Descrição	Obrigatório
código	string	Código do erro.	Não
message	string	Mensagem de erro.	Não
innerError	IngestionInnerErrorDetailsApiModel		Não

IngestionInnerErrorDetailsApiModel

Representa as informações de erro interno de ingestão para cada documento.

Nome	Tipo	Descrição	Obrigatório
código	string	Código do erro.	Não
message	string	Mensagem de erro.	Não
innerError	IngestionInnerErrorDetailsApiModel		Não

IngestionResponseModel

Representa o modelo de resposta de ingestão para o documento JSON.

Nome	Tipo	Descrição	Obrigatório
name	string	Obtém ou define o nome da ingestão.	Não
state	string	Obtém ou define o estado da ingestão. Enum: "notStarted", "running", "completed", "failed", "partiallySucceeded"	Não
error	ErrorResponseDetails		Não
batchName	string	O nome do lote associado a essa ingestão.	Não
createdDateTime	dateTime	Obtém ou define a data e a hora criadas da ingestão.	Não
lastModifiedDateTime	dateTime	Obtém ou define a última data e hora modificadas da ingestão.	Não
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	A lista de status de ingestão para cada documento.	Não

IngestionResponseModelCollectionApiModel

Contém uma matriz de resultados que podem ser paginados.

Nome	Tipo	Descrição	Obrigatório
value	[ IngestionResponseModel ]	A matriz de resultados.	Sim
nextLink	string	Um link para o próximo conjunto de resultados paginados, se houver mais resultados disponíveis; não está presente caso contrário.	Não

IngestionStatusDetailsApiModel

Representa os detalhes do status de ingestão para cada documento.

Nome	Tipo	Descrição	Necessário
lastUpdateTime	dateTime	Tempo de atualização de status da parte do lote.	Sim
documentId	string	A ID do documento.	Sim
documentUrl	cadeia de caracteres (uri)	A URL do documento.	Não
bem-sucedido	boolean	Um sinalizador para indicar se a inferência foi bem-sucedida.	Sim
error	IngestionErrorDetailsApiModel		Não

MetadataSchemaFieldModel

Representa um campo no esquema de metadados.

Nome	Tipo	Descrição	Obrigatório
name	string	Obtém ou define o nome do campo.	Sim
searchable	boolean	Obtém ou define um valor que indica se o campo é pesquisável.	Sim
filterable	boolean	Obtém ou define um valor que indica se o campo é filtrado.	Sim
tipo	string	Obtém ou define o tipo do campo. Pode ser cadeia de caracteres ou datetime. Enum: "string", "datetime"	Sim

MetadataSchemaModel

Representa o esquema de metadados do documento.

Nome	Tipo	Descrição	Necessário
linguagem	string	Obtém ou define o idioma do esquema de metadados. O padrão é "en".	Não
fields	[ MetadataSchemaFieldModel ]	Obtém ou define a lista de campos no esquema de metadados.	Sim

SearchFiltersModel

Representa os filtros a serem aplicados em uma consulta de pesquisa.

Nome	Tipo	Descrição	Necessário
stringFilters	[ StringFilterModel ]	Obtém ou define os filtros de cadeia de caracteres a serem aplicados na consulta de pesquisa.	Não
datetimeFilters	[ DatetimeFilterModel ]	Obtém ou define os filtros datetime a serem aplicados na consulta de pesquisa.	Não
featureFilters	[ cadeia de caracteres ]	Obtém ou define os filtros de recurso a serem aplicados na consulta de pesquisa.	Não

SearchQueryTextRequestModel

Representa um modelo de solicitação de consulta de pesquisa para pesquisa baseada em texto.

Nome	Tipo	Descrição	Necessário
queryText	string	Obtém ou define o texto da consulta.	Sim
filters	SearchFiltersModel		Não
moderação	boolean	Obtém ou define um valor booliano que indica se a moderação está habilitada ou desabilitada.	Não
top	Número inteiro	Obtém ou define o número de resultados a serem recuperados.	Sim
skip	Número inteiro	Obtém ou define o número de resultados a serem ignoradas.	Sim
additionalIndexNames	[ cadeia de caracteres ]	Obtém ou define os nomes de índice adicionais a serem incluídos na consulta de pesquisa.	Não
dedup	boolean	Se deve remover quadros de vídeo semelhantes.	Sim
dedupMaxDocumentCount	Número inteiro	O número máximo de documentos após o dedup.	Sim
disableMetadataSearch	boolean	Obtém ou define um valor booliano que indica se os metadados estão desabilitados na pesquisa ou não.	Sim

SearchResultDocumentModel

Representa uma resposta de consulta de pesquisa.

Nome	Tipo	Descrição	Necessário
documentId	string	Obtém ou define a ID do documento.	Não
documentKind	string	Obtém ou define o tipo do documento, que pode ser "vídeo".	Não
iniciar	string	Obtém ou define a hora de início do documento. Essa propriedade só é aplicável para documentos de vídeo.	Não
end	string	Obtém ou define a hora de término do documento. Essa propriedade só é aplicável para documentos de vídeo.	Não
teste	string	Obtém ou define o carimbo de data/hora do documento com a pontuação de maior relevância. Essa propriedade só é aplicável para documentos de vídeo.	Não
relevância	double	Obtém ou define a pontuação de relevância do documento.	Sim
additionalMetadata	objeto	Obtém ou define os metadados adicionais relacionados à pesquisa.	Não

SearchResultDocumentModelCollectionApiModel

Contém uma matriz de resultados que podem ser paginados.

Nome	Tipo	Descrição	Obrigatório
value	[ SearchResultDocumentModel ]	A matriz de resultados.	Sim
nextLink	string	Um link para o próximo conjunto de resultados paginados, se houver mais resultados disponíveis; não está presente caso contrário.	Não

StringFilterModel

Representa um filtro de cadeia de caracteres a ser aplicado em uma consulta de pesquisa.

Nome	Tipo	Descrição	Necessário
fieldName	string	Obtém ou define o nome do campo no qual filtrar.	Sim
valores	[ cadeia de caracteres ]	Obtém ou define os valores para filtrar.	Sim

UpdateIngestionIndexRequestModel

Representa o modelo de solicitação de índice de ingestão de atualização para o documento JSON.

Nome	Tipo	Descrição	Necessário
metadataSchema	MetadataSchemaModel		Não
userData	objeto	Obtém ou define os dados do usuário para o documento.	Não