> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aibase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 平台场景意图分布

> 查询指定品牌在指定时间范围内各 AI 平台的场景意图分布表现，按场景意图（`promptIntent`）分组返回各平台在意图下的曝光率、Top3 占比率、有效命中AI对话问题数量与

查询指定品牌在指定时间范围内各 AI 平台的场景意图分布表现，按场景意图（`promptIntent`）分组返回各平台在意图下的曝光率、Top3 占比率、有效命中AI对话问题数量与平均提及位次。`promptIntent` 为空时归入「未知」。

<Info>
  **执行模式：SYNC · 实时请求。**
  请求发出后服务端同步执行业务，结果直接在当前响应的 `data` 中返回，不存在异步任务、无需轮询、无需二次查询。
</Info>

## 接口速查

| 项目 | 当前接口约定 |
| - | - |
| 接口状态 | 已上线 |
| 请求方式 | `POST` |
| 请求地址 | `https://geobaseapi.aibase.com/v1/openapi/execute` |
| 业务标识 | `llm.intention` |
| 执行模式 | **SYNC · 实时请求**（直接返回，无需轮询） |
| 身份认证 | Header `AIBase-API-Key` |
| 请求格式 | `application/json` |
| 返回结构 | 按意图分组（意图名 → 统计数组），无数据时为空数组 |

## 请求头

<ParamField header="AIBase-API-Key" type="string" required>
  开发者 API Key，例如 `AIBase_xxx`。用于身份认证、有效期与调用权限校验，请仅在服务端保存和使用。
</ParamField>

<ParamField header="Content-Type" type="string" required>
  固定为 `application/json`。
</ParamField>

<ParamField header="AIBase-Request-Id" type="string">
  开发者自定义请求 ID，用于请求追踪；不传时系统自动生成 UUID。
</ParamField>

## 请求体

<ParamField body="apiCode" type="string" required>
  固定为 `llm.intention`
</ParamField>

<ParamField body="data.brandId" type="string" required>
  所属品牌 ID，为空返回 `4001`
</ParamField>

<ParamField body="data.llmName" type="string">
  按 AI 平台筛选，如 `deepseek`；不传返回全部平台
</ParamField>

<ParamField body="data.startDate" type="string">
  格式 `yyyy-MM-dd`；默认最近 7 天
</ParamField>

<ParamField body="data.endDate" type="string">
  格式 `yyyy-MM-dd`；默认今天，不能晚于今天
</ParamField>

<Note>
  时间范围规则：`startDate`/`endDate` 不传时默认查询最近 7 天；`endDate` 晚于今天会被自动截断为今天；起止时间跨度最大 6 个月；开始日期晚于结束日期将直接报错。
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl --location 'https://geobaseapi.aibase.com/v1/openapi/execute' \
    --header 'Content-Type: application/json' \
    --header 'AIBase-API-Key: AIBase_xxxxxxxxxxxxxxxx' \
    --header 'AIBase-Request-Id: req-20260924-001' \
    --data '{
      "apiCode": "llm.intention",
      "data": {
        "brandId": "brand-001",
        "llmName": "deepseek",
        "startDate": "2026-09-01",
        "endDate": "2026-09-23"
      }
    }'
  ```

  ```python Python theme={null}
  import os
  import requests

  api_key = os.environ["AIBASE_API_KEY"]
  headers = {
      "AIBase-API-Key": api_key,
      "Content-Type": "application/json",
      "AIBase-Request-Id": "req-20260924-001",
  }

  res = requests.post(
      "https://geobaseapi.aibase.com/v1/openapi/execute",
      headers=headers,
      json={"apiCode": "llm.intention", "data": {"brandId": "brand-001", "llmName": "deepseek", "startDate": "2026-09-01", "endDate": "2026-09-23"}},
      timeout=60,
  )
  res.raise_for_status()
  payload = res.json()

  if payload["code"] == 200:
      print(payload["data"])
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://geobaseapi.aibase.com/v1/openapi/execute", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "AIBase-API-Key": process.env.AIBASE_API_KEY,
      "AIBase-Request-Id": "req-20260924-001",
    },
    body: JSON.stringify({"apiCode": "llm.intention", "data": {"brandId": "brand-001", "llmName": "deepseek", "startDate": "2026-09-01", "endDate": "2026-09-23"}}),
  });

  const payload = await res.json();
  if (payload.code === 200) {
    console.log(payload.data);
  }
  ```

  ```java Java theme={null}
  String body = """
  {
    "apiCode": "llm.intention",
    "data": {
      "brandId": "brand-001",
      "llmName": "deepseek",
      "startDate": "2026-09-01",
      "endDate": "2026-09-23"
    }
  }
  """;

  HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://geobaseapi.aibase.com/v1/openapi/execute"))
      .header("Content-Type", "application/json")
      .header("AIBase-API-Key", "AIBase_xxxxxxxxxxxxxxxx")
      .header("AIBase-Request-Id", "req-20260924-001")
      .POST(BodyPublishers.ofString(body))
      .build();

  HttpResponse<String> response = HttpClient.newHttpClient()
      .send(request, BodyHandlers.ofString());
  System.out.println(response.body());
  ```
</RequestExample>

## 返回参数

业务结果位于 `data`，有数据时为按场景意图名称分组的结构（意图名 → 统计数组）；无数据时 `data` 返回空数组 `[]`（非空对象），解析时需同时兼容两种形态。

<Note>
  本接口 `data` 为按名称分组的映射结构：下表中的 `<分组名>[]` 表示各分组下的统计数组，实际键名为动态值（平台名 / 主题名 / 意图名 / AI 对话问题文本）。
</Note>

<ResponseField name="data" type="object / object[]">
  有数据时为「意图名 → 统计数组」的对象结构；无数据时为空数组 `[]`。
</ResponseField>

<ResponseField name="intent[].llmName" type="string">
  AI 平台名称。
</ResponseField>

<ResponseField name="intent[].promptIntent" type="string">
  场景意图名称，为空时归入「未知」。
</ResponseField>

<ResponseField name="intent[].visibilityRatePercent" type="number">
  该意图下品牌的曝光率（%）。
</ResponseField>

<ResponseField name="intent[].top3Rate" type="number">
  品牌在该意图的 Top3 占比率（%）。
</ResponseField>

<ResponseField name="intent[].hitCount" type="integer">
  该意图下有效命中的 AI 对话问题数量。
</ResponseField>

<ResponseField name="intent[].position" type="number">
  品牌在该意图的平均提及位次。
</ResponseField>

<ResponseExample>
  ```json 200 (成功响应) theme={null}
  {
    "code": 200,
    "msg": "成功",
    "data": {
      "选购推荐": [
        {
          "llmName": "deepseek",
          "promptIntent": "选购推荐",
          "visibilityRatePercent": 82.4,
          "top3Rate": 88.6,
          "hitCount": 96,
          "position": 1.4
        }
      ],
      "未知": [
        {
          "llmName": "chatgpt",
          "promptIntent": "未知",
          "visibilityRatePercent": 55.2,
          "top3Rate": 63.8,
          "hitCount": 42,
          "position": 3.1
        }
      ]
    },
    "timeStamp": 1788830174812
  }
  ```
</ResponseExample>

## 接入注意事项

1. `apiCode` 必须固定为 `llm.intention`。
2. `brandId` 为必填参数，为空返回 `4001`（所需参数不足）。
3. `startDate`/`endDate` 格式必须为 `yyyy-MM-dd`，默认最近 7 天，最大查询跨度 6 个月。
4. 返回结构特殊：有数据时 `data` 为「意图名 → 统计数组」的对象结构；无数据时 `data` 返回空数组 `[]`（非空对象），解析时必须同时兼容数组与对象两种形态。
5. `promptIntent` 为空的记录归入「未知」分组。
6. `hitCount` 为有效命中 AI 对话问题数量，`position` 为平均提及位次。

<AccordionGroup>
  <Accordion title="Java 返回对象">
    ```java theme={null}
    public class PromptIntentVisibility {
        private String llmName;
        private String promptIntent;
        private BigDecimal visibilityRatePercent;
        private BigDecimal top3Rate;
        private Integer hitCount;
        private BigDecimal position;
    }
    ```

    完整响应类型可表示为 `ReturnResult<Map<String, List<PromptIntentVisibility>>>`（`ReturnResult` 定义见 6.2.5）；无数据时 `data` 为已返回的空数组。
  </Accordion>

  <Accordion title="TypeScript 类型">
    ```typescript theme={null}
    export interface PromptIntentVisibility {
      llmName: string;
      promptIntent: string;
      visibilityRatePercent: number | null;
      top3Rate: number | null;
      hitCount: number;
      position: number | null;
    }

    export type LLMIntentionResult = Record<string, PromptIntentVisibility[]> | [];
    ```

    可按以下 TypeScript 类型定义解析响应数据。
  </Accordion>
</AccordionGroup>

<Note>
  本页的 cURL 与 Java 示例来自官方接口文档；Python 与 Node.js 示例为等价转写，未经服务端联调，请以实际返回结果为准。
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.