自动 REST API 参考 （Beta）

Note

自动在 beta 版中适用于启用了自动应用程序配置文件的外部合作伙伴。API 图面和协定可能会更改。

终结点：POST https://api.microsoft.ai/v3/auto

所有请求都需要 API 密钥或Microsoft Entra ID访问令牌。 有关设置说明，请参阅 “身份验证 ”。

示例请求

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

参数 Required 类型 Default Description
query 是 字符串 - 搜索查询，从 1 到 1,000 个字符。 支持 site: 和 -site: 运算符。
language 否 字符串 en 双字母 ISO 639-1 界面语言。
region 否 字符串 US 双字母市场或国家/地区代码。
mode 否 字符串 fast fast 确定速度的优先级; advanced 优先于全面性。
maxResponseLength 否 整数 30000 最大总响应长度。 低于 1500 的值被固定到 1500;超过 500000 的值被固定到 500000。
location 否 字符串 - 地理上下文 lat:<latitude>;long:<longitude> 的格式，例如 lat:47.6062;long:-122.3321。
responseFilter 否 字符串数组 - 符合条件的答案类型：web、、news、timezoneweather、imagesvideos。

响应

成功的证据响应返回 200 OK。 每个结果都包含一个类型化的证据对象和支持它的引文。 不受支持的或格式不正确的证据与引文一起省略。 如果省略每个提供的证据结果， results 则为空。

AutoEvidenceResponse

领域 类型 Description
results AutoEvidenceResult 数组 与引文配对的证据项的范围限定为该结果。
traceId 字符串 用于调试和支持的相关 ID。

AutoEvidenceResult

领域 类型 Description
evidence AutoEvidence 生成的类型化证据。
citations AutoEvidenceCitation 数组 仅支持此证据结果的引文。

AutoEvidence

证据对象自己的 type 歧视性选择架构 content。

type content
text 为 Web 和新闻结果返回的字符串证据。
media/image 图像结果对象。
media/video 视频结果对象。
structured/weather Weather 对象。
structured/timeZone 时区对象。

新闻文本证据也可以包括一个thumbnail和urlwidthheight。 结构化内容遵循与其相应的搜索答案相同的公共字段可见性规则。

AutoEvidenceCitation

领域 类型 Description
contentSource 字符串 引文源。
title 字符串 引文标题。
url 字符串 引文 URL。
lastUpdatedAt 字符串 上次更新时间时间戳。
crawledAt 字符串 爬网时间戳。
language 字符串 内容语言。
isAdult boolean 引文是否包含成人内容。

示例响应

{
  "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"
}

错误代码

状态代码 Description
200 请求成功，包括没有结果的有效搜索。
400 无效的参数或格式不正确的 JSON。
401 缺少或无效的身份验证凭据。
403 未为自动启用经过身份验证的配置文件。
429 超出速率或配额限制。
500 内部服务失败。
503 所需的服务不可用。
504 请求超时。

有关共享错误架构和重试指南，请参阅 错误处理。

相关内容

  • 上次更新时间为