Partilhar via

Referência da API de recuperação de vídeo

  • Artigo

Autenticação

Inclua os seguintes cabeçalhos 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>

Description

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 realizada.

Parâmetros

Nome Localizada em Description Obrigatório Type
indexName path O nome do índice a ser criado. Sim string
api-version query Versão da API solicitada. Sim string
corpo corpo 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 GetIngestionIndexResponseModel

GetIndex

URL

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

Description

Recupera o índice com o nome especificado.

Parâmetros

Nome Localizada em Description Obrigatório Type
indexName path O nome do índice a ser recuperado. Sim string
api-version query Versão da API solicitada. Sim string

Respostas

Código Description Type
200 Com êxito GetIngestionIndexResponseModel
default Erro ErrorResponse

UpdateIndex

URL

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

Description

Atualiza um índice com o nome especificado.

Parâmetros

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

Respostas

Código Description Type
200 Com êxito GetIngestionIndexResponseModel
default Erro ErrorResponse

DeleteIndex

URL

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

Description

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

Parâmetros

Nome Localizada em Description Obrigatório Type
indexName path O nome do índice a ser excluído. Sim string
api-version query Versão da API solicitada. Sim string

Respostas

Código Description
204 Sem conteúdo

ListIndexes

URL

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

Description

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

Parâmetros

Nome Localizada em Description Obrigatório Type
$skip query Número de conjuntos de dados a serem ignorados. Não integer
$top query Número de conjuntos de dados a serem retornados após ignorar. Não integer
api-version query Versão da API solicitada. Sim string

Respostas

Código Description Type
200 Com êxito GetIngestionIndexResponseModelCollectionApiModel
default Erro ErrorResponse

CriarIngestão

URL

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

Description

A solicitação de ingestão pode ter carga útil de vídeo. Pode ter um dos três modos (adicionar, atualizar ou remover). O modo Adicionar 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 Localizada em Description Obrigatório Type
indexName path O nome do índice para o qual a ingestão deve ser criada. Sim string
inestionName path O nome da ingestão a ser criada. Sim string
api-version query Versão da API solicitada. Sim string
corpo corpo 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 Aceite IngestionResponseModel

GetIngestion

URL

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

Description

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

Parâmetros

Nome Localizada em Description Obrigatório Type
indexName path O nome do índice para o qual o status de ingestão a ser verificado. Sim string
inestionName path O nome da ingestão a ser recuperada. Sim string
nível de detalhe query Um nível para indicar o nível de detalhe por status de ingestão de documento. Não string
api-version query Versão da API solicitada. Sim string

Respostas

Código Description Type
200 Com êxito IngestionResponseModel
default Erro ErrorResponse

ListIngestions

URL

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

Description

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

Parâmetros

Nome Localizada em Description Obrigatório Type
indexName path O nome do índice para o qual recuperar as ingestões. Sim string
api-version query Versão da API solicitada. Sim string

Respostas

Código Description Type
200 Com êxito IngestionResponseModelCollectionApiModel
default Erro ErrorResponse

ListDocuments

URL

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

Description

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

Parâmetros

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

Respostas

Código Description Type
200 Com êxito IngestionDocumentResponseModelCollectionApiModel
default Erro ErrorResponse

SearchByText

URL

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

Description

Executa uma pesquisa baseada em texto no índice especificado.

Parâmetros

Nome Localizada em Description Obrigatório Type
indexName path O nome do índice a pesquisar. Sim string
api-version query Versão da API solicitada. Sim string
corpo corpo O corpo da solicitação que contém a consulta e outros parâmetros. Sim SearchQueryTextRequestModel

Respostas

Código Description Type
200 Com êxito SearchResultDocumentModelCollectionApiModel
default Erro ErrorResponse

Modelos

CreateIngestionIndexRequestModel

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

Nome Tipo Descrição Obrigatório
metadataSchema MetadataSchemaModel Não
funcionalidades [ Modelo de Recurso ] Obtém ou define a lista de recursos para o 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 Obrigatório
vídeos [ IngestionDocumentRequestModel ] Obtém ou define a lista de solicitações de ingestão de documentos 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 os 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 do filtro de quadros indicando que os quadros serão avaliados e todos os quadros com defeito (por exemplo, desfocado, pouca luz, superexposiçã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 Obrigatório
fieldName string Obtém ou define o nome do campo para filtrar. Sim
startTime string Obtém ou define a hora de início do intervalo a ser filtrado. 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 Obrigatório
error ErrorResponseDetails Sim

ErrorResponseDetails

Informações de erro.

Nome Tipo Descrição Obrigatório
code string Código de erro. Sim
mensagem string Mensagem de erro. Sim
destino string Alvo 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
code string Código de erro. Sim
mensagem string Mensagem de erro. Sim
innererror ErrorResponseInnerError Não

FeatureModel

Representa um recurso no índice.

Nome Tipo Descrição Obrigatório
nome 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 get ingestion index para o documento JSON.

Nome Tipo Descrição Obrigatório
nome string Obtém ou define a propriedade index name. Não
metadataSchema MetadataSchemaModel Não
userData objeto Obtém ou define os dados do usuário para o documento. Não
funcionalidades [ Modelo de Recurso ] Obtém ou define a lista de recursos no índice. Não
eTag string Obtém ou define o etag. Sim
createdDateTime dateTime Obtém ou define a propriedade de data e hora criada. Sim
lastModifiedDateTime dateTime Obtém ou define a propriedade de data e hora da última modificação. Sim

GetIngestionIndexResponseModelCollectionApiModel

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

Nome Tipo Descrição Necessário
valor [ 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 estar presente de outra forma. Não

IngestionDocumentRequestModel

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

Nome Tipo Descrição Obrigatório
modo string Obtém ou define o modo da ingestão do documento.
Enum: "add", "update", "remove"		 Sim
ID do documento string Obtém ou define a ID do documento. Não
documentUrl string (uri) Obtém ou define a URL do documento. A assinatura de acesso compartilhado (SAS), se houver, será removida da URL. Sim
do IdP objeto Obtém ou define os metadados para o 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 Obrigatório
ID do documento string Obtém ou define a ID do documento. Não
documentUrl string (uri) Obtém ou define a URL do documento. A assinatura de acesso compartilhado (SAS), se houver, será removida da URL. Não
do IdP 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 hora de criação do documento. Não
lastModifiedDateTime dateTime Obtém ou define a data e hora da última modificação 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 Necessário
valor [ 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 estar presente de outra forma. Não

IngestionErrorDetailsApiModel

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

Nome Tipo Descrição Obrigatório
code string Código de erro. Não
mensagem 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
code string Código de erro. Não
mensagem 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
nome 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
Nome do lote string O nome do lote associado a esta ingestão. Não
createdDateTime dateTime Obtém ou define a data e hora criadas da ingestão. Não
lastModifiedDateTime dateTime Obtém ou define a data e hora da última modificação da ingestão. Não
fileStatusDetails [ IngestionStatusDetailsApiModel ] A lista de estados de ingestão para cada documento. Não

IngestionResponseModelCollectionApiModel

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

Nome Tipo Descrição Necessário
valor [ 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 estar presente de outra forma. Não

IngestãoStatusDetalhesApiModel

Representa o detalhe do status de ingestão para cada documento.

Nome Tipo Descrição Obrigatório
lastUpdateTime dateTime Tempo de atualização de status do bloco de lote. Sim
ID do documento string O ID do documento. Sim
documentUrl string (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
nome string Obtém ou define o nome do campo. Sim
pesquisável boolean Obtém ou define um valor que indica se o campo é pesquisável. Sim
filtrável boolean Obtém ou define um valor que indica se o campo é filtrável. Sim
tipo string Obtém ou define o tipo do campo. Pode ser string ou datetime.
Enum: "string", "datetime"		 Sim

MetadataSchemaModel

Representa o esquema de metadados para o documento.

Nome Tipo Descrição Obrigatório
idioma string Obtém ou define o idioma do esquema de metadados. O padrão é "en". Não
campos [ 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 Obrigatório
stringFilters [ StringFilterModel ] Obtém ou define os filtros de cadeia de caracteres a serem aplicados na consulta de pesquisa. Não
datetimeFiltros [ DatetimeFilterModel ] Obtém ou define os filtros datetime a serem aplicados na consulta de pesquisa. Não
featureFilters [ string ] 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 Obrigatório
queryText string Obtém ou define o texto da consulta. Sim
filtros SearchFiltersModel Não
moderação boolean Obtém ou define um valor booleano que indica se a moderação está habilitada ou desabilitada. Não
principal integer Obtém ou define o número de resultados a serem recuperados. Sim
skip integer Obtém ou define o número de resultados a serem ignorados. Sim
additionalIndexNames [ string ] Obtém ou define os nomes de índice adicionais a serem incluídos na consulta de pesquisa. Não
dedup boolean Se deseja remover quadros de vídeo semelhantes. Sim
dedupMaxDocumentCount integer O número máximo de documentos após a duplicação. Sim
disableMetadataSearch boolean Obtém ou define um valor booleano 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 Obrigatório
ID do documento string Obtém ou define a ID do documento. Não
documentKind string Obtém ou define o tipo de documento, que pode ser "vídeo". Não
iniciar string Obtém ou define a hora de início do documento. Esta propriedade só é aplicável para documentos de vídeo. Não
end string Obtém ou define a hora de término do documento. Esta propriedade só é aplicável para documentos de vídeo. Não
melhor string Obtém ou define o carimbo de data/hora do documento com a pontuação de relevância mais alta. Esta propriedade só é aplicável para documentos de vídeo. Não
Pertinência duplo Obtém ou define a pontuação de relevância do documento. Sim
Metadados adicionais 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 Necessário
valor [ 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 estar presente de outra forma. Não

StringFilterModel

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

Nome Tipo Descrição Obrigatório
fieldName string Obtém ou define o nome do campo para filtrar. Sim
valores [ string ] 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 Obrigatório
metadataSchema MetadataSchemaModel Não
userData objeto Obtém ou define os dados do usuário para o documento. Não