Mairaフィードバック

Mairaでは、会話にフィードバックを送信することができます。フィードバックを提供するためのエンドポイントが2つあります。

PUT /v1/gpt/conversations: GPT会話に対してバルクでフィードバックを提出するためのエンドポイント。
PUT /v1/gpt/conversations/{conversation_id}: 単一の会話に対してフィードバックを提出するためのエンドポイント。

以下は、PUT /v1/gpt/conversations のリクエストボディの例です。

{
  "updates": [
    {
      "message": "GPTの応答についての体験",
      "type": "positive",
      "rating": 5,
      "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

ここでの updates にはフィードバックと共に更新される会話のリストを含みます。パラメータを詳しく説明いたします：

message: Optional[str] - GPTの応答に対するユーザーの体験を説明するフィードバックメッセージ type: Optional[str] - フィードバックの種類。positiveまたはnegativeのいずれかのみを指定できます。
rating: Optional[int] - フィードバックの評価を整数で表したもの。下限は0です。上限を設定するには、GPT設定で max_feedback_rating を使用します（"Mairaの設定と会話の要約"チュートリアルのMaira "設定"セクションを参照） conversation_id: str - フィードバックを提供する会話のID

同様に、PUT /v1/gpt/conversations/{conversation_id} を使用して特定の一つの会話にフィードバックを送信することができます。この場合、conversation_id パラメータを指定します。リクエストボディは似ていますが、パラメータはより少ないです。

{
  "message": "GPTの応答についての体験",
  "type": "positive",
  "rating": 5
}