Image Analysis - Analyze Stream

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 uma carga JSON que inclui uma propriedade 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 a geração de saída. Se esse parâmetro não for especificado, o valor padrão será "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 precisa 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 da cultura 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írgula. 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 (byte)

Um fluxo de imagem.

Respostas

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

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 ilustra.
CropRegion

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

Uma breve descrição do que a imagem ilustra.
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 concatenado, 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

Descreva 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

Objeto

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

Nome Tipo Description
confidence

number (double)

minimum: 0
maximum: 1

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

Objeto

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

Objeto

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

Nome Tipo Description
h

integer (int32)

minimum: 1

Altura medida do ponto superior esquerdo da área, em pixels.
w

integer (int32)

minimum: 1

Largura medida do ponto superior esquerdo da área, em pixels.
x

integer (int32)

minimum: 0

Coordenada esquerda do ponto superior esquerdo da área, em pixels.
y

integer (int32)

minimum: 0

Coordenada superior do ponto superior esquerdo da área, em pixels.

CaptionResult

Objeto

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

Nome Tipo Description
confidence

number (double)

minimum: 0
maximum: 1

O nível de confiança que o serviço tem na legenda.
text

string

minLength: 1

O texto da legenda.

CropRegion

Objeto

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

Nome Tipo Description
aspectRatio

number (double)

A taxa de proporção da região de corte.
boundingBox

BoundingBox

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

DenseCaption

Objeto

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

Nome Tipo Description
boundingBox

BoundingBox

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

number (double)

minimum: 0
maximum: 1

O nível de confiança que o serviço tem na legenda.
text

string

minLength: 1

O texto da legenda.

DenseCaptionsResult

Objeto

Uma lista de legendas.

Nome Tipo Description
values

DenseCaption[]

Uma lista de legendas.

DetectedObject

Objeto

Descreve um objeto detectado em uma imagem.

Nome Tipo Description
boundingBox

BoundingBox

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

string

minLength: 1

ID do objeto detectado.
tags

Tag[]

Confianças de classificação do objeto detectado.

DetectedPerson

Objeto

Uma pessoa detectada em uma imagem.

Nome Tipo Description
boundingBox

BoundingBox

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

number (double)

minimum: 0
maximum: 1

Pontuação de confiança de ter observado a pessoa na imagem, como um valor que varia de 0 a 1.

DocumentLine

Objeto

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[] (double)

Caixa delimitadora da linha.
content

string

minLength: 1

Conteúdo concatenado dos elementos contidos na ordem de leitura.
spans

DocumentSpan[]

Local da linha no conteúdo concatenado da ordem de leitura.

DocumentPage

Objeto

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

Nome Tipo Description
angle

number (double)

A orientação geral do conteúdo no sentido horário, medida em graus entre (-180, 180].
height

number (double)

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 (int32)

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 (double)

A largura da imagem/PDF em pixels/polegadas, respectivamente.
words

DocumentWord[]

Palavras extraídas da página.

DocumentSpan

Objeto

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

Nome Tipo Description
length

integer (int32)

Número de caracteres no conteúdo representado pelo intervalo.
offset

integer (int32)

Índice baseado em zero do conteúdo representado pelo intervalo.

DocumentStyle

Objeto

Um objeto que representa os estilos de texto observados.

Nome Tipo Description
confidence

number (double)

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

Objeto

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[] (double)

Caixa delimitadora da palavra.
confidence

number (double)

Confiança de extrair corretamente a palavra.
content

string

minLength: 1

Conteúdo de texto da palavra.
span

DocumentSpan

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

ErrorResponse

Objeto

Resposta retornada quando ocorre um erro.

Nome Tipo Description
error

ErrorResponseDetails

Informações de erro.

ErrorResponseDetails

Objeto

Informações de erro.

Nome Tipo Description
code

string

Código de erro.
details

ErrorResponseDetails[]

Lista de erros detalhados.
innererror

ErrorResponseInnerError

Erro detalhado.
message

string

Mensagem de erro.
target

string

Destino do erro.

ErrorResponseInnerError

Objeto

Erro detalhado.

Nome Tipo Description
code

string

Código de erro.
innererror

ErrorResponseInnerError

Erro detalhado.
message

string

Mensagem de erro.

ImageAnalysisResult

Objeto

Descreva 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 ilustra.
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

minLength: 1

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

Objeto

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

Nome Tipo Description
height

integer (int32)

minimum: 1

A altura da imagem em pixels.
width

integer (int32)

minimum: 1

A largura da imagem em pixels.

ImagePredictionResult

Objeto

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

Objeto

Descreve objetos detectados em uma imagem.

Nome Tipo Description
values

DetectedObject[]

Uma matriz de objetos detectados.

PeopleResult

Objeto

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

Nome Tipo Description
values

DetectedPerson[]

Uma matriz de pessoas detectadas.

ReadResult

Objeto

Os resultados de uma operação de leitura.

Nome Tipo Description
content

string

minLength: 1

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

minLength: 1

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

Objeto

Resultado do corte inteligente.

Nome Tipo Description
values

CropRegion[]

Regiões recomendadas para cortar a imagem.

Tag

Objeto

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

Nome Tipo Description
confidence

number (double)

minimum: 0
maximum: 1

O nível de confiança que a entidade foi observada.
name

string

minLength: 1

Nome da entidade.

TagsResult

Objeto

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

Enumeração

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.

Valor Description
tags
caption
denseCaptions
objects
read
smartCrops
people