openapi: 3.0.3
info:
  title: 获取情绪参数列表
  version: v1
  description: |
    这是一个用于获取情绪参数列表的 API。

    有关如何使用情绪分析的方法，请参阅[情绪分析](/amivoice-api/manual/sentiment-analysis)。

servers:
  - url: https://acp-dsrpp.amivoice.com

tags:
  - name: sentiment-analysis
    x-displayName: 获取情绪参数列表

paths:
  /v1/sentiment-analysis/{language}/result-parameters.json:
    get:
      tags:
        - sentiment-analysis
      summary: 获取情绪参数列表
      operationId: listSentimentAnalysisParameters
      security:
        - bearerAuth: []
      description: |
        获取情绪参数的列表。
      parameters:
        - name: language
          in: path
          required: true
          description: |
            语言代码

            指定用于显示的语言代码。目前仅支持`ja`。
          schema:
            type: string
            enum:
              - ja
            example: ja
      responses:
        "200":
          description: |
            以 JSON 格式返回情绪分析结果的参数。

            每个参数的说明以数组形式提供以下项目的数据：

            | 参数 | 说明 |
            | ------------ | ------------------------------------------ |
            | name | 情绪分析结果响应中包含的名称 |
            | display_name | 手册中记载的情绪参数名 |
            | minimum | 最小值 |
            | maximum | 最大值 |
          content:
            application/json:
              schema:
                type: object
                properties:
                  sentiment_analysis:
                    type: object
                    properties:
                      result_parameters:
                        type: object
                        properties:
                          display_language:
                            type: string
                            description: 显示语言
                            example: ja
                          definitions:
                            type: array
                            description: 每个参数的说明
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: 情绪分析结果响应中包含的名称
                                display_name:
                                  type: string
                                  description: 手册中记载的情绪参数名
                                minimum:
                                  type: number
                                  description: 最小值
                                maximum:
                                  type: number
                                  description: 最大值
        "400":
          description: |
            请求无效时返回。

            | 错误消息 | 错误情况 |
            |---|---|
            | No authorization header | 未设置 Authorization header |
            | Invalid authentication credentials | 未设置令牌 |
            | Invalid authorization header format | Authorization header 格式不正确 |
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessage"
              example:
                message: "No authorization header"
        "401":
          description: |
            认证失败时返回。

            | 错误消息 | 错误情况 |
            |---|---|
            | Failed to authorize for the app_key | 使用指定的 API key 进行认证失败 |
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessage"
              example:
                message: "Failed to authorize for the app_key"

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        请在`Authorization` header 中指定 API key。

        ```text
        Authorization: Bearer {API_KEY}
        ```
  schemas:
    ErrorMessage:
      type: object
      title: 错误响应
      properties:
        message:
          type: string
          description: 错误消息
