Referencia de la API REST automática (beta)

Note

Auto está disponible en beta para asociados externos cuyo perfil de aplicación está habilitado para Auto. La superficie de API y el contrato pueden cambiar.

Punto final:POST https://api.microsoft.ai/v3/auto

Todas las solicitudes requieren una clave de API o Microsoft Entra ID token de acceso. Consulte Autenticación para obtener instrucciones de configuración.

Solicitud de ejemplo

curl -X POST "https://api.microsoft.ai/v3/auto" \
  -H "x-apikey: <Your API key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "Microsoft AI announcements",
    "language": "en",
    "region": "US",
    "location": "lat:47.6062;long:-122.3321",
    "mode": "fast",
    "maxResponseLength": 30000,
    "responseFilter": ["web", "news"]
  }'

Parameters

Parámetro Required Tipo Default Description
query Sí string - Consulta de búsqueda, de 1 a 1000 caracteres. Admite site: operadores y -site: .
language No string en Lenguaje de interfaz ISO 639-1 de dos letras.
region No string US Mercado de dos letras o código de país o región.
mode No string fast fast da prioridad a la velocidad; advanced da prioridad a la integralidad.
maxResponseLength No integer 30000 Longitud máxima de respuesta total. Los valores inferiores a 1500 se fijan a 1500; Los valores superiores a 5000000 se fijan a 500000.
location No string - Contexto geográfico en lat:<latitude>;long:<longitude> formato, por ejemplo lat:47.6062;long:-122.3321.
responseFilter No Matriz de cadenas - Tipos de respuesta aptos: web, news, weathertimezone, , images, . videos

Respuesta

Una respuesta de evidencia correcta devuelve 200 OK. Cada resultado contiene un objeto de evidencia con tipo y las citas que lo admiten. Las pruebas no admitidas o con formato incorrecto se omiten junto con sus citas. Si se omite cada resultado de evidencia proporcionado, results está vacío.

AutoEvidenceResponse

Field Tipo Description
results matriz de AutoEvidenceResult Elementos de evidencia emparejados con citas en el ámbito de ese resultado.
traceId string Identificador de correlación para la depuración y compatibilidad.

AutoEvidenceResult

Field Tipo Description
evidence AutoEvidence Evidencia con tipo generada.
citations matriz de AutoEvidenceCitation Las citas que solo admiten este resultado de evidencia.

AutoEvidence

El propio type discriminador del objeto de evidencia selecciona el esquema de content.

type content
text Evidencia de cadena devuelta para los resultados web y noticias.
media/image Objeto de resultado de imagen.
media/video Objeto de resultado de vídeo.
structured/weather Objeto Weather.
structured/timeZone Objeto de zona horaria.

La evidencia de texto de noticias también puede incluir con thumbnailurl, widthy height. El contenido estructurado sigue las mismas reglas de visibilidad de campo público que su respuesta de búsqueda correspondiente.

AutoEvidenceCitation

Field Tipo Description
contentSource string Origen de la cita.
title string Título de la cita.
url string Dirección URL de cita.
lastUpdatedAt string Marca de tiempo actualizada por última vez.
crawledAt string Marca de tiempo de rastreo.
language string Idioma del contenido.
isAdult booleano Indica si la cita contiene contenido para adultos.

Respuesta de ejemplo

{
  "results": [
    {
      "evidence": {
        "type": "text",
        "content": "Microsoft announced a new set of AI capabilities."
      },
      "citations": [
        {
          "contentSource": "web",
          "url": "https://www.microsoft.com/en-us/ai",
          "title": "Microsoft AI",
          "language": "en",
          "isAdult": false
        }
      ]
    }
  ],
  "traceId": "00000000000000000000000000000000"
}

Códigos de error

Código de estado Description
200 La solicitud se realizó correctamente, incluida una búsqueda válida sin resultados.
400 Parámetros no válidos o JSON con formato incorrecto.
401 Faltan o no son credenciales de autenticación no válidas.
403 El perfil autenticado no está habilitado para Auto.
429 Se ha superado la tasa o el límite de cuota.
500 Error interno del servicio.
503 Un servicio necesario no está disponible.
504 Se agota el tiempo de espera de la solicitud.

Para ver el esquema de error compartido y las instrucciones de reintento, consulte Control de errores.

Contenido relacionado

  • Se actualizó por última vez el