Skip to content

La interfaz de conversación es compatible con la interfaz del modelo OpenAI. Para obtener más detalles, consulte:OpenAI API

preguntar
  • Ejemplo:
curl
curl --location --request POST 'https://workaibot.com/api/v1/chat/completions' \
--header 'Authorization: Bearer workgpt-xxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "asdfadsfasfd2323",
    "stream": false,
    "detail": false,
    "variables": {
        "uid": "asdfadsfasfd2323",
        "name": "joshua"
    },
    "messages": [
        {
            "content": "Who are you?",
            "role": "user"
        }
    ]
}'
  • Descripción de parámetros:
nombre del parámetrotipoRequeridodescribir
chatIdstringyesCuando es indefinido (no pasado), la función de contexto no se usa y el contexto se construye completamente a partir de los mensajes pasados. Sus registros no se almacenarán en la base de datos y no podrá verlos en el resumen de registros. Cuando es cadena no vacía, significa usar chatId para la conversación, obtener automáticamente registros del historial de la base de datos y usar el último contenido de la matriz messages como pregunta del usuario. Asegúrese de que chatId sea único y tenga menos de 250 caracteres. Generalmente puede ser el ID del diálogo de su propio sistema.
streambooleannoYa sea para transmitir devoluciones, el valor predeterminado es false. Cuando sea false, se devolverá un objeto json que contiene messages.
detailbooleannoYa sea para devolver información detallada, el valor predeterminado es false. En stream mode, event se usará para distinguir y el resultado del non-stream mode se guarda en responseData
variablesobjectnoLa variable del módulo, un objeto, reemplazará el contenido del cuadro de entrada en el módulo.{{key}}
messagesarrayyesMatriz de mensajes, cada elemento es un objeto, incluidos content y role. content es el contenido, role es el rol y la estructura es consistente con el modo de chat OpenAI API.
respuesta
  • Ejemplo:
json
{
    "id": "asdfadsfasfd2323",
    "model": "",
    "usage": {
        "prompt_tokens": 1,
        "completion_tokens": 23,
        "total_tokens": 121
    },
    "choices": [
        {
            "message": {
                "role": "assistant",
                "content": "Hello! My name is WorkAiBot, it is an AIGC application system based on a private knowledge base"
            },
            "finish_reason": "stop",
            "index": 0
        }
    ]
}