Image Analysis - Analyze Stream

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-01-preview

Analise a imagem de entrada. A solicitação contém fluxo de imagem com qualquer tipo de conteúdo ['image/*', 'application/octet-stream'], ou um conteúdo JSON que inclui uma propriedade de URL a ser usada para recuperar o fluxo de imagem.

POST /imageanalysis:analyze?overload=stream&api-version=2023-04-01-preview

Com parâmetros opcionais:

POST /imageanalysis:analyze?overload=stream&features={features}&model-name={model-name}&language={language}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2023-04-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API solicitada.
features	query		VisualFeature[]	Os recursos visuais solicitados: marcas, objetos, legenda, denseCaptions, leitura, smartCrops, pessoas. Esse parâmetro precisará ser especificado se o parâmetro "model-name" não for especificado.
gender-neutral-caption	query		boolean	Sinalizador booliano para habilitar legendas neutras de gênero para recursos de legenda e denseCaptions. Se esse parâmetro não for especificado, o valor padrão será "false".
language	query		string	O idioma desejado para geração de saída. Se este parâmetro não for especificado, o valor padrão é “en”. Consulte https://aka.ms/cv-languages para obter uma lista de idiomas com suporte.
model-name	query		string	O nome do modelo treinado personalizado. Esse parâmetro precisará ser especificado se o parâmetro "features" não for especificado.
smartcrops-aspect-ratios	query		string	Uma lista de proporções a serem usadas para o recurso smartCrops. As taxas de proporção são calculadas dividindo a largura de corte de destino pela altura. Os valores com suporte estão entre 0,75 e 1,8 (inclusive). Vários valores devem ser separados por vírgulas. Se esse parâmetro não for especificado, o serviço retornará uma sugestão de corte com uma taxa de proporção que ele achar adequada entre 0,5 e 2,0 (inclusive).

Corpo da solicitação

Media Types: "application/octet-stream", "image/jpeg", "image/gif", "image/tiff", "image/bmp", "image/png"

Nome	Tipo	Description
body	string	Um fluxo de imagem.

Respostas

Nome	Tipo	Description
200 OK	ImageAnalysisResult	Êxito
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

ImageAnalysisResult

Êxito

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Exemplos

AnalyzeImageFromImageStream_CustomModel

Solicitação de exemplo

HTTP

POST /imageanalysis:analyze?overload=stream&model-name=my_model_name&api-version=2023-04-01-preview

"Ynl0ZXM="

Resposta de exemplo

Código de status:: 200

{
  "modelVersion": "2023-04-01-preview",
  "customModelResult": {
    "objectsResult": {
      "values": [
        {
          "id": "1",
          "boundingBox": {
            "x": 197,
            "y": 68,
            "w": 356,
            "h": 394
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.92431640625
            }
          ]
        },
        {
          "id": "2",
          "boundingBox": {
            "x": 0,
            "y": 77,
            "w": 241,
            "h": 359
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.87890625
            }
          ]
        }
      ]
    }
  },
  "metadata": {
    "width": 660,
    "height": 495
  }
}

Definições

Nome	Description
AdultMatch	Um objeto que descreve a correspondência de conteúdo adulto.
AdultResult	Um objeto que descreve se a imagem contém conteúdo orientado para adultos e/ou é picante.
BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
CaptionResult	Uma breve descrição do que a imagem descreve.
CropRegion	Uma região identificada para corte inteligente. Haverá uma região retornada para cada taxa de proporção solicitada.
DenseCaption	Uma breve descrição do que a imagem descreve.
DenseCaptionsResult	Uma lista de legendas.
DetectedObject	Descreve um objeto detectado em uma imagem.
DetectedPerson	Uma pessoa detectada em uma imagem.
DocumentLine	Um objeto de linha de conteúdo que consiste em uma sequência adjacente de elementos de conteúdo, como palavras e marcas de seleção.
DocumentPage	O conteúdo e os elementos de layout extraídos de uma página da entrada.
DocumentSpan	Região contígua da propriedade de conteúdo concatenada, especificada como um deslocamento e comprimento.
DocumentStyle	Um objeto que representa os estilos de texto observados.
DocumentWord	Um objeto de palavra que consiste em uma sequência contígua de caracteres. Para idiomas delimitados sem espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.
ErrorResponse	Resposta retornada quando ocorre um erro.
ErrorResponseDetails	Informações de erro.
ErrorResponseInnerError	Erro detalhado.
ImageAnalysisResult	Descrever os resultados combinados de diferentes tipos de análise de imagem.
ImageMetadataApiModel	As informações de metadados da imagem, como altura e largura.
ImagePredictionResult	Descreve o resultado da previsão de uma imagem.
ObjectsResult	Descreve objetos detectados em uma imagem.
PeopleResult	Um objeto que descreve se a imagem contém pessoas.
ReadResult	Os resultados de uma operação de leitura.
SmartCropsResult	Resultado do corte inteligente.
Tag	Uma observação de entidade na imagem, juntamente com a pontuação de confiança.
TagsResult	Uma lista de marcas com nível de confiança.
VisualFeature	Os recursos visuais solicitados: marcas, objetos, legenda, denseCaptions, leitura, smartCrops, pessoas. Esse parâmetro precisará ser especificado se o parâmetro "model-name" não for especificado.

AdultMatch

Um objeto que descreve a correspondência de conteúdo adulto.

Nome	Tipo	Description
confidence	number	Um valor que indica o nível de confiança do conteúdo adulto correspondente.
isMatch	boolean	Um valor que indica se a imagem corresponde ao conteúdo adulto.

AdultResult

Um objeto que descreve se a imagem contém conteúdo orientado para adultos e/ou é picante.

Nome	Tipo	Description
adult	AdultMatch	Um objeto que descreve a correspondência de conteúdo adulto.
gore	AdultMatch	Um objeto que descreve a correspondência de conteúdo adulto.
racy	AdultMatch	Um objeto que descreve a correspondência de conteúdo adulto.

BoundingBox

Uma caixa delimitadora para uma área dentro de uma imagem.

Nome	Tipo	Description
h	integer	Altura medida do ponto superior esquerdo da área, em pixels.
w	integer	Largura medida do ponto superior esquerdo da área, em pixels.
x	integer	Coordenada esquerda do ponto superior esquerdo da área, em pixels.
y	integer	Coordenada superior do ponto superior esquerdo da área, em pixels.

CaptionResult

Uma breve descrição do que a imagem descreve.

Nome	Tipo	Description
confidence	number	O nível de confiança que o serviço tem na legenda.
text	string	O texto da legenda.

CropRegion

Uma região identificada para corte inteligente. Haverá uma região retornada para cada taxa de proporção solicitada.

Nome	Tipo	Description
aspectRatio	number	A taxa de proporção da região de corte.
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.

DenseCaption

Uma breve descrição do que a imagem descreve.

Nome	Tipo	Description
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
confidence	number	O nível de confiança que o serviço tem na legenda.
text	string	O texto da legenda.

DenseCaptionsResult

Uma lista de legendas.

Nome	Tipo	Description
values	DenseCaption[]	Uma lista de legendas.

DetectedObject

Descreve um objeto detectado em uma imagem.

Nome	Tipo	Description
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
id	string	Id do objeto detectado.
tags	Tag[]	Confianças de classificação do objeto detectado.

DetectedPerson

Uma pessoa detectada em uma imagem.

Nome	Tipo	Description
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
confidence	number	Pontuação de confiança de ter observado a pessoa na imagem, como um valor que varia de 0 a 1.

DocumentLine

Um objeto de linha de conteúdo que consiste em uma sequência adjacente de elementos de conteúdo, como palavras e marcas de seleção.

Nome	Tipo	Description
boundingBox	number[]	Caixa delimitadora da linha.
content	string	Conteúdo concatenado dos elementos contidos na ordem de leitura.
spans	DocumentSpan[]	Local da linha no conteúdo concatenado da ordem de leitura.

DocumentPage

O conteúdo e os elementos de layout extraídos de uma página da entrada.

Nome	Tipo	Description
angle	number	A orientação geral do conteúdo no sentido horário, medida em graus entre (-180, 180].
height	number	A altura da imagem/PDF em pixels/polegadas, respectivamente.
lines	DocumentLine[]	Linhas extraídas da página, potencialmente contendo elementos textuais e visuais.
pageNumber	integer	Número de página baseado em 1 no documento de entrada.
spans	DocumentSpan[]	Local da página no conteúdo concatenado da ordem de leitura.
width	number	A largura da imagem/PDF em pixels/polegadas, respectivamente.
words	DocumentWord[]	Palavras extraídas da página.

DocumentSpan

Região contígua da propriedade de conteúdo concatenada, especificada como um deslocamento e comprimento.

Nome	Tipo	Description
length	integer	Número de caracteres no conteúdo representado pelo intervalo.
offset	integer	Índice baseado em zero do conteúdo representado pelo intervalo.

DocumentStyle

Um objeto que representa os estilos de texto observados.

Nome	Tipo	Description
confidence	number	Confiança de identificar corretamente o estilo.
isHandwritten	boolean	O conteúdo é manuscrito ou não.
spans	DocumentSpan[]	Local dos elementos de texto no conteúdo concatenado ao qual o estilo se aplica.

DocumentWord

Um objeto de palavra que consiste em uma sequência contígua de caracteres. Para idiomas delimitados sem espaço, como chinês, japonês e coreano, cada caractere é representado como sua própria palavra.

Nome	Tipo	Description
boundingBox	number[]	Caixa delimitadora da palavra.
confidence	number	Confiança de extrair corretamente a palavra.
content	string	Conteúdo de texto da palavra.
span	DocumentSpan	Região contígua da propriedade de conteúdo concatenada, especificada como um deslocamento e comprimento.

ErrorResponse

Resposta retornada quando ocorre um erro.

Nome	Tipo	Description
error	ErrorResponseDetails	Informações de erro.

ErrorResponseDetails

Informações de erro.

Nome	Tipo	Description
code	string	Código do erro.
details	ErrorResponseDetails[]	Lista de erros detalhados.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponseInnerError

Erro detalhado.

Nome	Tipo	Description
code	string	Código do erro.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.

ImageAnalysisResult

Descrever os resultados combinados de diferentes tipos de análise de imagem.

Nome	Tipo	Description
adultResult	AdultResult	Um objeto que descreve se a imagem contém conteúdo orientado para adultos e/ou é picante.
captionResult	CaptionResult	Uma breve descrição do que a imagem descreve.
customModelResult	ImagePredictionResult	Descreve o resultado da previsão de uma imagem.
denseCaptionsResult	DenseCaptionsResult	Uma lista de legendas.
metadata	ImageMetadataApiModel	As informações de metadados da imagem, como altura e largura.
modelVersion	string	Versão do modelo.
objectsResult	ObjectsResult	Descreve objetos detectados em uma imagem.
peopleResult	PeopleResult	Um objeto que descreve se a imagem contém pessoas.
readResult	ReadResult	Os resultados de uma operação de leitura.
smartCropsResult	SmartCropsResult	Resultado do corte inteligente.
tagsResult	TagsResult	Uma lista de marcas com nível de confiança.

ImageMetadataApiModel

As informações de metadados da imagem, como altura e largura.

Nome	Tipo	Description
height	integer	A altura da imagem em pixels.
width	integer	A largura da imagem em pixels.

ImagePredictionResult

Descreve o resultado da previsão de uma imagem.

Nome	Tipo	Description
objectsResult	ObjectsResult	Descreve objetos detectados em uma imagem.
tagsResult	TagsResult	Uma lista de marcas com nível de confiança.

ObjectsResult

Descreve objetos detectados em uma imagem.

Nome	Tipo	Description
values	DetectedObject[]	Uma matriz de objetos detectados.

PeopleResult

Um objeto que descreve se a imagem contém pessoas.

Nome	Tipo	Description
values	DetectedPerson[]	Uma matriz de pessoas detectadas.

ReadResult

Os resultados de uma operação de leitura.

Nome	Tipo	Description
content	string	Concatenar a representação de cadeia de caracteres de todos os elementos textuais e visuais na ordem de leitura.
pages	DocumentPage[]	Uma lista de páginas analisadas.
stringIndexType	string	O método usado para calcular o deslocamento e o comprimento da cadeia de caracteres, os valores possíveis incluem: 'textElements', 'unicodeCodePoint', 'utf16CodeUnit' etc.
styles	DocumentStyle[]	Estilos de fonte extraídos.

SmartCropsResult

Resultado do corte inteligente.

Nome	Tipo	Description
values	CropRegion[]	Regiões recomendadas para cortar a imagem.

Tag

Uma observação de entidade na imagem, juntamente com a pontuação de confiança.

Nome	Tipo	Description
confidence	number	O nível de confiança que a entidade foi observada.
name	string	Nome da entidade.

TagsResult

Uma lista de marcas com nível de confiança.

Nome	Tipo	Description
values	Tag[]	Uma lista de marcas com nível de confiança.

VisualFeature

Os recursos visuais solicitados: marcas, objetos, legenda, denseCaptions, leitura, smartCrops, pessoas. Esse parâmetro precisará ser especificado se o parâmetro "model-name" não for especificado.

Nome	Tipo	Description
caption	string
denseCaptions	string
objects	string
people	string
read	string
smartCrops	string
tags	string

Compartilhar via

Image Analysis - Analyze Stream

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

AnalyzeImageFromImageStream_CustomModel

Solicitação de exemplo

Resposta de exemplo

Definições

AdultMatch

AdultResult

BoundingBox

CaptionResult

CropRegion

DenseCaption

DenseCaptionsResult

DetectedObject

DetectedPerson

DocumentLine

DocumentPage

DocumentSpan

DocumentStyle

DocumentWord

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

ImageAnalysisResult

ImageMetadataApiModel

ImagePredictionResult

ObjectsResult

PeopleResult

ReadResult

SmartCropsResult

Tag

TagsResult

VisualFeature

Recursos adicionais