En esta página

Cliente de la API RESTful de ChatGPT

Ejemplo de cómo utilizar el generador OpenAPI para crear un cliente de API RESTful que se comunique con los modelos de OpenAI.

Menú desplegable de selección de modelos y cuatro fichas de modo denominadas «Asistente», «Científico», «Modo normal» y «A tu elección»

Este ejemplo utiliza la última especificación OpenAPI de la API de OpenAI para crear código de cliente de API RESTful. Dado que se trata únicamente de un ejemplo, no implementa el conjunto completo de modelos y operaciones descritos en la especificación oficial de OpenAI. En concreto, el ejemplo se limita a dos operaciones descritas en el archivo « response_api.yaml »:

  • listModels: recibe la lista de modelos disponibles.
  • createResponse: envía una solicitud de usuario al modelo elegido y recibe un mensaje de respuesta.

Ejecución del ejemplo

Puedes ejecutar el ejemplo desde:

Nota: El ejemplo requiere una clave privada de OpenAI para interactuar con los modelos. Utiliza la variable de entorno CHAT_OPENAI_KEY para especificar la clave. Si ejecutas el ejemplo desde Qt Creator, puede hacerse con Projects -> Run Settings -> Environment.

Funcionalidad de la aplicación

El ejemplo te permite elegir un modelo de OpenAI de la lista de modelos disponibles y, a continuación, chatear con él. La comunicación se ofrece en cuatro modos de configuración:

  • Asistente: la configuración funciona como un asistente y prefiere hablar de temas relacionados con la magia.
  • Científico: la configuración se comporta como Albert Einstein y le gusta hablar de física.
  • Modo normal: configuración estándar de ChatGPT sin funciones adicionales.
  • Tu elección: puedes crear una descripción personalizada del comportamiento de ChatGPT.

Una vez seleccionado un modo, aparece la página de chat.

Conversación de chat con un campo de introducción de texto y los botones «Atrás» y «Enviar»

Generación de código de cliente a partir de una especificación OpenAPI

El generador de OpenAPI de Qt 6 se invoca desde el archivo ` CMakeLists.txt ` para generar código de cliente a partir de la especificación ` response_api.yaml `, llamando a la función ` qt_add_openapi_client() `.

qt_add_library(openAIResponseApi)
qt_add_openapi_client(openAIResponseApi
    SPEC_FILE
        ${CMAKE_CURRENT_SOURCE_DIR}/response_api.yaml
)

Las clases de API generadas ResponsesApi y ModelsApi se encargan de todos los detalles HTTP de bajo nivel:

  • Configuración del servidor
  • Creación de solicitudes HTTP para todos los métodos HTTP estándar
  • Serialización de los parámetros de entrada según la especificación
  • Deserialización de las respuestas del servidor en objetos tipados
  • Notificación de éxitos y errores mediante señales de Qt

Ahora, lo único que tienes que hacer es enviar una solicitud al modelo llamando a la operación ` createResponse() ` de la clase ` ResponsesApi ` y analizar su respuesta, tal y como se muestra a continuación:

m_responseApi->createResponse(response, this, [&](const QRestReply&reply,
                                                  const Response &summary) {
    if (!reply.isSuccess()) {
        qWarning() << "createResponse:" << reply.errorString() << reply.error();
    } else {
        // Para guardar el contexto de la conversación con el modelo de OpenAI,
        // tenemos que hacer un seguimiento del ResponseId devuelto por el último mensaje del modelo.
       // El contexto deja de ser relevante tras cambiar al otro modelo. Si el modelo
        // no conoce el identificador de contexto, responderá como si el ResponseId estuviera vacío.
       m_responseId = summary.getId();
        const QList<OutputMessage> outputMessage = summary.getOutput();
        for (qsizetype msgIndex = 0; msgIndex < outputMessage.size(); msgIndex++) {
            const QList<OutputTextContent> mensajes
                = outputMessage.at(msgIndex).getContent();
            for (qsizetype contentIndex = 0; contentIndex < mensajes.size(); contentIndex++)
                emit responseReady(mensajes.at(contentIndex).getText());
        }
    }
});

Exposición de las API generadas a QML

La clase auxiliar OpenAIChatManager expone las clases de API generadas ResponsesApi y ModelsApi a QML. Se define en openaichatmanager.h.

La clase auxiliar utiliza las macros QML_ELEMENT y QML_SINGLETON y registra la instancia subyacente de C++ como un singleton, lo que permite a QML acceder al mismo objeto mientras la propiedad sigue recayendo en C++:

class OpenAIChatManager : public QObject
{
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON

    Q_PROPERTY(QString modelName READ modelName WRITE setModelName NOTIFY modelNameChanged FINAL)
    Q_PROPERTY(QString userRequest READ userRequest
               WRITE setUserRequest NOTIFY userRequestChanged FINAL)
    Q_PROPERTY(QStringList modelList READ modelList
               WRITE setModelList NOTIFY modelListChanged FINAL)
    Q_PROPERTY(CharacterMode characterId READ characterId
               WRITE setCharacterId NOTIFY characterIdChanged FINAL)
    Q_PROPERTY(QString customUserCharacter READ customUserCharacter
               WRITE setCustomUserCharacter NOTIFY customUserCharacterChanged FINAL)

La operación createResponse() se expone a través de la función invocable del singleton OpenAIChatManager:

    Q_INVOKABLE void sendUserRequest();

Para obtener más detalles, consulta la documentación de Qt Qml sobre cómo registrar una clase para proporcionar singletons.

Uso de las API desde QML

Una vez registrado, el singleton está disponible de forma global en QML. Esto permite a los componentes de QML acceder a ResponsesApi y ModelsApi utilizando los métodos del singleton, tal y como se muestra a continuación:

function editingFinished() {
    var messageObject = {"name": "Me", "message": messageField.text };
    conversationModel.append(messageObject);
    OpenAIChatManager.userRequest = messageField.text;
    OpenAIChatManager.sendUserRequest();
    messageField.text = "";
}

Archivos fuente

Proyecto de ejemplo en code.qt.io

Véase también Todos los ejemplos de Qt y el cliente de la API RESTful de ColorPalette.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.