> ## 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.

# 竞品口碑对比

> 查询指定品牌在指定时间范围内与监测竞品的口碑（情感）对比，返回各竞品与我方品牌的综合情感得分、正面/负面/中性占比及各情感条数，便于横向对比品牌口碑表现。

查询指定品牌在指定时间范围内与监测竞品的口碑（情感）对比，返回各竞品与我方品牌的综合情感得分、正面/负面/中性占比及各情感条数，便于横向对比品牌口碑表现。

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

## 接口速查

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

## 请求头

**AIBase-API-Key** `string` *required*

开发者 API Key，例如 `AIBase_xxx`。用于身份认证、有效期与调用权限校验，请仅在服务端保存和使用。

**Content-Type** `string` *required*

固定为 `application/json`。

**AIBase-Request-Id** `string`

开发者自定义请求 ID，用于请求追踪；不传时系统自动生成 UUID。

## 请求体

**apiCode** `string` *required*

固定为 `competitor.sentiment`。

**data** `object` *required*

业务请求参数对象。

**data.brandId** `string` *required*

品牌 ID。所属品牌 ID，为空返回 4001

**data.llmName** `string`

AI平台。按 AI 平台筛选，如 deepseek；不传返回全部平台

**data.startDate** `string`

开始日期。格式 yyyy-MM-dd；默认最近 7 天

**data.endDate** `string`

结束日期。格式 yyyy-MM-dd；默认今天，不能晚于今天

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

```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":"competitor.sentiment","data":{"brandId":"brand-001","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",
}

payload = {
  "apiCode": "competitor.sentiment",
  "data": {
    "brandId": "brand-001",
    "startDate": "2026-09-01",
    "endDate": "2026-09-23"
  }
}

res = requests.post(
    "https://geobaseapi.aibase.com/v1/openapi/execute",
    headers=headers,
    json=payload,
    timeout=60,
)
res.raise_for_status()
body = res.json()

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

```javascript Node.js theme={null}
const payload = {
  "apiCode": "competitor.sentiment",
  "data": {
    "brandId": "brand-001",
    "startDate": "2026-09-01",
    "endDate": "2026-09-23"
  }
};

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(payload),
});

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

```java Java theme={null}
String body = """
{
  "apiCode": "competitor.sentiment",
  "data": {
    "brandId": "brand-001",
    "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());
```

## 返回参数

业务结果位于 data，为数组结构，每个元素对应一个品牌（我方品牌与监测竞品）的口碑统计。无数据时 data 为空数组 \[]。

**data\[].competitorName** `string`

品牌名称。品牌或竞品名称，包含我方品牌自身。

**data\[].sentimentScore** `number`

综合情感得分。该品牌的综合情感得分。

**data\[].positiveRatio** `number`

正面占比。正面评价占比（%）。

**data\[].negativeRatio** `number`

负面占比。负面评价占比（%）。

**data\[].neutralRatio** `number`

中性占比。中性评价占比（%）。

**data\[].positiveCnt** `integer`

正面条数。正面评价条数。

**data\[].negativeCnt** `integer`

负面条数。负面评价条数。

**data\[].neutralCnt** `integer`

中性条数。中性评价条数。

**data\[].totalCnt** `integer`

总条数。参与统计的评价总条数。

```json 200 (成功响应) theme={null}
{
  "code": 200,
  "msg": "成功",
  "data": [
    {
      "competitorName": "竞品A",
      "sentimentScore": 72.5,
      "positiveRatio": 58.2,
      "negativeRatio": 15.3,
      "neutralRatio": 26.5,
      "positiveCnt": 120,
      "negativeCnt": 32,
      "neutralCnt": 55,
      "totalCnt": 207
    },
    {
      "competitorName": "我方品牌",
      "sentimentScore": 68.0,
      "positiveRatio": 52.0,
      "negativeRatio": 18.5,
      "neutralRatio": 29.5,
      "positiveCnt": 96,
      "negativeCnt": 34,
      "neutralCnt": 55,
      "totalCnt": 185
    }
  ],
  "timeStamp": 1788830174812
}
```

## 接入注意事项

1. apiCode 必须固定为 competitor.sentiment。
2. brandId 为必填参数，为空返回 4001（所需参数不足）。
3. startDate/endDate 格式必须为 yyyy-MM-dd，默认最近 7 天，最大查询跨度 6 个月。
4. 返回结构为品牌口碑维度数组（非分页）；无数据时 data 为空数组 \[]，解析时做好空值兼容。
5. positiveRatio、negativeRatio、neutralRatio 为百分比数值。
6. totalCnt 为参与情感统计的评价总条数，等于正面、负面、中性条数之和。

> [accordion] Java 返回对象
>
> ```java theme={null}
> public class CompetitorSentiment {
>     private String competitorName;
>     private BigDecimal sentimentScore;
>     private BigDecimal positiveRatio;
>     private BigDecimal negativeRatio;
>     private BigDecimal neutralRatio;
>     private Long positiveCnt;
>     private Long negativeCnt;
>     private Long neutralCnt;
>     private Long totalCnt;
> }
> ```
>
> 完整响应类型可表示为 `ReturnResult<List<CompetitorSentiment>>`（`ReturnResult` 定义见 6.2.5）。

> [accordion] TypeScript 类型
>
> ```typescript theme={null}
> export interface CompetitorSentiment {
>   competitorName: string | null;
>   sentimentScore: number | null;
>   positiveRatio: number | null;
>   negativeRatio: number | null;
>   neutralRatio: number | null;
>   positiveCnt: number;
>   negativeCnt: number;
>   neutralCnt: number;
>   totalCnt: number;
> }
> ```
>
> 可按以上 TypeScript 类型定义解析响应数据。

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


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