Aller au contenu principal
Version: 3.6.0

Ajuster

Aperçu​

Le message Ajuster permet à un agent de demander des modifications aux réponses précédemment retournées. Il fournit la capacité d'affiner et d'améliorer le contenu basé sur des instructions spécifiques données en langage naturel.

Référence API​

Point de Terminaison​

  • URL WebSocket : wss://ws-{{tenant}}.oco.optave.{{tld}}
  • Point de Terminaison REST (POST) : https://{{tenant}}.oco.optave.{{tld}}/message/adjust

Pour pouvoir envoyer des messages, il est nécessaire de s'authentifier d'abord.

Charge Utile de Requête​

Le message adjust nécessite une charge utile contenant l'historique de conversation (conversations), connections.threadId, connections.parentId (ID du message à ajuster), les instructions d'ajustement dans attributes (instruction et content), et context.organizationId (l'identifiant d'organisation spécifique à votre client). Les autres champs sont optionnels.

{
  session: {
    sessionId: "a1b2c3d4-e5f6-7890-abcd-123456789012",
    channel: { language: "en-US" },
    interface: { type: "chat" }
  },
  request: {
    requestId: "a1b2c3d4-e5f6-7890-1234-56789ab2345",
    attributes: {
      content: "Hello! How can I assist you today?", // REQUIS - contenu du message à ajuster
      instruction: "Make it more formal", // REQUIS - instruction d'ajustement
      variant: "A"
    },
    connections: {
      journeyId: "",
      parentId: "9e8d7c6b-5a4f-3e2d-1c0b-0987654321ab", // REQUIS - ID du message à ajuster
      threadId: "9e8d7c6b-5a49-3827-1605-948372615abc" // REQUIS
    },
    context: { // généré par optave
      organizationId: "f7e8d9c0-b1a2-3456-7890-123456789abc", // REQUIS
    },
    scope: {
      conversations: [ // REQUIS
        {
          conversationId: "conv-789",
          participants: [
            {
              participantId: "2c4f8a9b-1d3e-5f70-8293-456789012def",
              displayName: "John Doe",
              role: "user"
            }
          ],
          messages: [
            {
              content: "Hi, can you help me?",
              participantId: "2c4f8a9b-1d3e-5f70-8293-456789012def",
              timestamp: "2024-01-15T10:30:00.000Z"
            }
          ]
        }
      ]
    }
  }
}

Réponses​

🟢 Succès (200-201)

La réponse consiste en un superpouvoir adjust_suggestion.

Lors de l'utilisation du WebSocket, plusieurs autres superpouvoirs et différentes mises à jour d'état seront également reçus.

{
  action: "superpower",
  actionType: "adjust_suggestion",
  state: "completed",
  message: {
    results: [
      {
        response: [
          {
            content: 'Réponse plus amicale'
          }
        ]
      }
    ]
  }
}

🔴 Erreur

Les messages d'erreur sont similaires en format aux messages de succès, mais contiennent un état d'erreur et un objet JSON "response" :

{
  action: "superpower",
  actionType: "<superpower-name>",
  state: "error",
  message: {
    results: [
      {
        response: [
          {
            content: 'Erreur lors de la récupération des résultats'
          }
        ]
      }
    ]
  }
}

curl
  --request POST
  --url https://{{tenant}}.oco.optave.{{tld}}/message/adjust \
  --header "Authorization: Bearer your-access-token-here" \
  --header "Content-Type: application/json" \
  -d '{
    "session": {
      "sessionId": "a1b2c3d4-e5f6-7890-abcd-123456789012",
      "channel": { "language": "en-US" },
      "interface": { "type": "chat" }
    },
    "request": {
      "requestId": "a1b2c3d4-e5f6-7890-1234-56789ab2345",
      "attributes": {
        "content": "Hello! How can I assist you today?",
        "instruction": "Make the answer shorter and friendlier",
        "variant": "A"
      },
      "connections": {
        "parentId": "9e8d7c6b-5a4f-3e2d-1c0b-0987654321ab",
        "threadId": "9e8d7c6b-5a49-3827-1605-948372615abc"
      },
      "context": {
        "organizationId": "f7e8d9c0-b1a2-3456-7890-123456789abc"
      },
      "scope": {
        "conversations": [
          {
            "conversationId": "conv-789",
            "participants": [
              {
                "participantId": "2c4f8a9b-1d3e-5f70-8293-456789012def",
                "displayName": "John Doe",
                "role": "user"
              }
            ],
            "messages": [
              {
                "content": "Hi, can you help me?",
                "participantId": "2c4f8a9b-1d3e-5f70-8293-456789012def",
                "timestamp": "2024-01-15T10:30:00.000Z"
              }
            ]
          }
        ]
      }
    }
  }'
{
  action: "superpower",
  actionType: "adjust_suggestion",
  state: "completed",
  message: {
    results: [
      {
        response: [
          {
            content: "Réponse plus amicale"
          }
        ]
      }
    ]
  }
}