Compartir a través de


Image Analysis - Analyze Image

Analice la imagen de entrada. La solicitud contiene una secuencia de imagen con cualquier tipo de contenido ['image/*', 'application/octet-stream'] o una carga JSON que incluye una propiedad url que se usará para recuperar la secuencia de imágenes.

POST /imageanalysis:analyze?api-version=2023-04-01-preview
POST /imageanalysis:analyze?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 identificador URI

Nombre En Requerido Tipo Description
api-version
query True

string

Versión de API solicitada.

features
query

VisualFeature[]

Las características visuales solicitadas: etiquetas, objetos, caption, denseCaptions, read, smartCrops, people. Este parámetro debe especificarse si no se especifica el parámetro "model-name".

gender-neutral-caption
query

boolean

Marca booleana para habilitar subtítulos neutros de género para las características caption y denseCaptions. Si no se especifica este parámetro, el valor predeterminado es "false".

language
query

string

Idioma deseado para la generación de resultados. Si esta no se especifica este parámetro, se usa el valor predeterminado "en". Consulte https://aka.ms/cv-languages para obtener una lista de los idiomas admitidos.

model-name
query

string

Nombre del modelo entrenado personalizado. Este parámetro debe especificarse si no se especifica el parámetro "features".

smartcrops-aspect-ratios
query

string

Lista de relaciones de aspecto que se van a usar para la característica smartCrops. Las relaciones de aspecto se calculan dividiendo el ancho del recorte de destino por el alto. Los valores admitidos están comprendidos entre 0,75 y 1,8 (ambos incluidos). Varios valores deben estar separados por comas. Si no se especifica este parámetro, el servicio devolverá una sugerencia de recorte con una relación de aspecto que se ajuste entre 0,5 y 2,0 (ambos incluidos).

Cuerpo de la solicitud

Nombre Requerido Tipo Description
url True

string

Dirección URL accesible públicamente de una imagen.

Respuestas

Nombre Tipo Description
200 OK

ImageAnalysisResult

Correcto

Other Status Codes

ErrorResponse

Error

Encabezados

x-ms-error-code: string

Ejemplos

AnalyzeImage_CustomModel

Solicitud de ejemplo

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

{
  "url": "https://example.com/image.jpg"
}

Respuesta de muestra

{
  "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
            }
          ]
        }
      ]
    }
  },
  "modelVersion": "2023-04-01-preview",
  "metadata": {
    "width": 660,
    "height": 495
  }
}

Definiciones

Nombre Description
AdultMatch

Objeto que describe la coincidencia de contenido para adultos.

AdultResult

Objeto que describe si la imagen contiene contenido orientado a adultos o es racy.

BoundingBox

Un rectángulo delimitador para un área dentro de una imagen.

CaptionResult

Una breve descripción de lo que representa la imagen.

CropRegion

Una región identificada para el recorte inteligente. Se devolverá una región para cada relación de aspecto solicitada.

DenseCaption

Una breve descripción de lo que representa la imagen.

DenseCaptionsResult

Lista de subtítulos.

DetectedObject

Describe un objeto detectado en una imagen.

DetectedPerson

Una persona detectada en una imagen.

DocumentLine

Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección.

DocumentPage

Contenido y elementos de diseño extraídos de una página de la entrada.

DocumentSpan

Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud.

DocumentStyle

Objeto que representa estilos de texto observados.

DocumentWord

Objeto de palabra que consta de una secuencia contigua de caracteres. Para idiomas no delimitados por espacios, como chino, japonés y coreano, cada carácter se representa como su propia palabra.

ErrorResponse

Respuesta devuelta cuando se produce un error.

ErrorResponseDetails

Información de error.

ErrorResponseInnerError

Error detallado.

ImageAnalysisResult

Describir los resultados combinados de diferentes tipos de análisis de imágenes.

ImageMetadataApiModel

La información de metadatos de la imagen, como el alto y el ancho.

ImagePredictionResult

Describe el resultado de predicción de una imagen.

ImageUrl

Un documento JSON con una dirección URL que apunta a la imagen que se va a analizar.

ObjectsResult

Describe los objetos detectados en una imagen.

PeopleResult

Objeto que describe si la imagen contiene personas.

ReadResult

Resultados de una operación de lectura.

SmartCropsResult

Resultado de recorte inteligente.

Tag

Observación de entidad en la imagen, junto con la puntuación de confianza.

TagsResult

Lista de etiquetas con nivel de confianza.

VisualFeature

Las características visuales solicitadas: etiquetas, objetos, caption, denseCaptions, read, smartCrops, people. Este parámetro debe especificarse si no se especifica el parámetro "model-name".

AdultMatch

Objeto que describe la coincidencia de contenido para adultos.

Nombre Tipo Description
confidence

number

Valor que indica el nivel de confianza del contenido para adultos coincidente.

isMatch

boolean

Valor que indica si la imagen coincide con el contenido para adultos.

AdultResult

Objeto que describe si la imagen contiene contenido orientado a adultos o es racy.

Nombre Tipo Description
adult

AdultMatch

Objeto que describe la coincidencia de contenido para adultos.

gore

AdultMatch

Objeto que describe la coincidencia de contenido para adultos.

racy

AdultMatch

Objeto que describe la coincidencia de contenido para adultos.

BoundingBox

Un rectángulo delimitador para un área dentro de una imagen.

Nombre Tipo Description
h

integer

Alto medido desde el punto superior izquierdo del área, en píxeles.

w

integer

Ancho medido desde el punto superior izquierdo del área, en píxeles.

x

integer

Coordenada izquierda del punto superior izquierdo del área, en píxeles.

y

integer

Coordenada superior del punto superior izquierdo del área, en píxeles.

CaptionResult

Una breve descripción de lo que representa la imagen.

Nombre Tipo Description
confidence

number

Nivel de confianza que el servicio tiene en el título.

text

string

Texto del título.

CropRegion

Una región identificada para el recorte inteligente. Se devolverá una región para cada relación de aspecto solicitada.

Nombre Tipo Description
aspectRatio

number

Relación de aspecto de la región de cultivo.

boundingBox

BoundingBox

Un rectángulo delimitador para un área dentro de una imagen.

DenseCaption

Una breve descripción de lo que representa la imagen.

Nombre Tipo Description
boundingBox

BoundingBox

Un rectángulo delimitador para un área dentro de una imagen.

confidence

number

Nivel de confianza que el servicio tiene en el título.

text

string

Texto del título.

DenseCaptionsResult

Lista de subtítulos.

Nombre Tipo Description
values

DenseCaption[]

Lista de subtítulos.

DetectedObject

Describe un objeto detectado en una imagen.

Nombre Tipo Description
boundingBox

BoundingBox

Un rectángulo delimitador para un área dentro de una imagen.

id

string

Identificador del objeto detectado.

tags

Tag[]

Confianzas de clasificación del objeto detectado.

DetectedPerson

Una persona detectada en una imagen.

Nombre Tipo Description
boundingBox

BoundingBox

Un rectángulo delimitador para un área dentro de una imagen.

confidence

number

Puntuación de confianza de haber observado la persona en la imagen, como un valor comprendido entre 0 y 1.

DocumentLine

Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección.

Nombre Tipo Description
boundingBox

number[]

Rectángulo delimitador de la línea.

content

string

Contenido concatenado de los elementos contenidos en orden de lectura.

spans

DocumentSpan[]

Ubicación de la línea en el contenido concatenado del orden de lectura.

DocumentPage

Contenido y elementos de diseño extraídos de una página de la entrada.

Nombre Tipo Description
angle

number

Orientación general del contenido en dirección en sentido de las agujas del reloj, medida en grados entre (-180, 180].

height

number

Alto de la imagen/PDF en píxeles/pulgadas, respectivamente.

lines

DocumentLine[]

Líneas extraídas de la página, que pueden contener elementos textuales y visuales.

pageNumber

integer

Número de página basado en 1 en el documento de entrada.

spans

DocumentSpan[]

Ubicación de la página en el contenido concatenado del orden de lectura.

width

number

Ancho de la imagen/PDF en píxeles/pulgadas, respectivamente.

words

DocumentWord[]

Palabras extraídas de la página.

DocumentSpan

Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud.

Nombre Tipo Description
length

integer

Número de caracteres del contenido representado por el intervalo.

offset

integer

Índice de base cero del contenido representado por el intervalo.

DocumentStyle

Objeto que representa estilos de texto observados.

Nombre Tipo Description
confidence

number

Confianza de identificar correctamente el estilo.

isHandwritten

boolean

Es el contenido escrito a mano o no.

spans

DocumentSpan[]

Ubicación de los elementos de texto en el contenido concatenado al que se aplica el estilo.

DocumentWord

Objeto de palabra que consta de una secuencia contigua de caracteres. Para idiomas no delimitados por espacios, como chino, japonés y coreano, cada carácter se representa como su propia palabra.

Nombre Tipo Description
boundingBox

number[]

Rectángulo delimitador de la palabra.

confidence

number

Confianza de extraer correctamente la palabra.

content

string

Contenido de texto de la palabra.

span

DocumentSpan

Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud.

ErrorResponse

Respuesta devuelta cuando se produce un error.

Nombre Tipo Description
error

ErrorResponseDetails

Información de error.

ErrorResponseDetails

Información de error.

Nombre Tipo Description
code

string

Código de error.

details

ErrorResponseDetails[]

Lista de errores detallados.

innererror

ErrorResponseInnerError

Error detallado.

message

string

Mensaje de error.

target

string

Destino del error.

ErrorResponseInnerError

Error detallado.

Nombre Tipo Description
code

string

Código de error.

innererror

ErrorResponseInnerError

Error detallado.

message

string

Mensaje de error.

ImageAnalysisResult

Describir los resultados combinados de diferentes tipos de análisis de imágenes.

Nombre Tipo Description
adultResult

AdultResult

Objeto que describe si la imagen contiene contenido orientado a adultos o es racy.

captionResult

CaptionResult

Una breve descripción de lo que representa la imagen.

customModelResult

ImagePredictionResult

Describe el resultado de predicción de una imagen.

denseCaptionsResult

DenseCaptionsResult

Lista de subtítulos.

metadata

ImageMetadataApiModel

La información de metadatos de la imagen, como el alto y el ancho.

modelVersion

string

Versión del modelo.

objectsResult

ObjectsResult

Describe los objetos detectados en una imagen.

peopleResult

PeopleResult

Objeto que describe si la imagen contiene personas.

readResult

ReadResult

Resultados de una operación de lectura.

smartCropsResult

SmartCropsResult

Resultado de recorte inteligente.

tagsResult

TagsResult

Lista de etiquetas con nivel de confianza.

ImageMetadataApiModel

La información de metadatos de la imagen, como el alto y el ancho.

Nombre Tipo Description
height

integer

Alto de la imagen en píxeles.

width

integer

Ancho de la imagen en píxeles.

ImagePredictionResult

Describe el resultado de predicción de una imagen.

Nombre Tipo Description
objectsResult

ObjectsResult

Describe los objetos detectados en una imagen.

tagsResult

TagsResult

Lista de etiquetas con nivel de confianza.

ImageUrl

Un documento JSON con una dirección URL que apunta a la imagen que se va a analizar.

Nombre Tipo Description
url

string

Dirección URL accesible públicamente de una imagen.

ObjectsResult

Describe los objetos detectados en una imagen.

Nombre Tipo Description
values

DetectedObject[]

Matriz de objetos detectados.

PeopleResult

Objeto que describe si la imagen contiene personas.

Nombre Tipo Description
values

DetectedPerson[]

Matriz de personas detectadas.

ReadResult

Resultados de una operación de lectura.

Nombre Tipo Description
content

string

Concatenar la representación de cadena de todos los elementos textuales y visuales en orden de lectura.

pages

DocumentPage[]

Una lista de páginas analizadas.

stringIndexType

string

El método usado para calcular el desplazamiento y la longitud de la cadena, los valores posibles son: "textElements", "unicodeCodePoint", "utf16CodeUnit", etc.

styles

DocumentStyle[]

Estilos de fuente extraídos.

SmartCropsResult

Resultado de recorte inteligente.

Nombre Tipo Description
values

CropRegion[]

Regiones recomendadas para recortar la imagen.

Tag

Observación de entidad en la imagen, junto con la puntuación de confianza.

Nombre Tipo Description
confidence

number

Nivel de confianza de que se observó la entidad.

name

string

Nombre de la entidad.

TagsResult

Lista de etiquetas con nivel de confianza.

Nombre Tipo Description
values

Tag[]

Lista de etiquetas con nivel de confianza.

VisualFeature

Las características visuales solicitadas: etiquetas, objetos, caption, denseCaptions, read, smartCrops, people. Este parámetro debe especificarse si no se especifica el parámetro "model-name".

Nombre Tipo Description
caption

string

denseCaptions

string

objects

string

people

string

read

string

smartCrops

string

tags

string