Create an OpenAI Plugin for dotCMS

[john-thomas-dotcms]

This description is copied (with minor formatting changes) from the signed SOW.

Purpose

Act as a proxy for all communications with the ChatGPT API

Requirements

• Create an OSGI Plugin for dotCMS
• Implement an API in the plugin to:
  • Receive API requests from clients in JSON format which contains:
    • Context for the prompt
    • The actual prompt string
  • Send prompt to the ChatGPT API
    • Transform the information from the plugin API request into the appropriate format for the ChatGPT API
    • Context will be supplied to ChatGPT in straight text format, as part of the prompt
      • Context will include both the Role Prompt (from the App, and context (if any) provided in the API call
      • No vector database or embeddings will be used at this time
    • For this first phase, no context will be maintained between subsequent API calls
  • Receive response from the ChatGPT API
  • Send a response to the API client
    • Transform the data from the ChatGPT API into JSON format
    • Send the JSON response to the client
  • Confirm the planned API methods and parameters with dotCMS before implementation
  • The format of the API request and response should be generic
    • It should not be dependent on any features specific to ChatGPT, or to the ChatGPT API
    • If any ChatGPT-specific configuration or parameters are required, they should be configured through the App, not the API call (see 1a, below).

Logging

• All API requests and responses should be logged with DEBUG level. This includes:
  • Each client API request
  • Each ChatGPT API request
  • Each ChatGPT API response
  • Each client API response
• The log message for each event should include all appropriate data from the following:
  • IP address of the request
  • Endpoint URL, including any URL parameters
  • HTTP status code
  • Error message returned (if any)
  • All data (can be the raw form of the data portion sent)
• If an authentication request to the ChatGPT API is required, it should be logged with INFO level, to include:
  • Endpoint URL
  • HTTP status code
  • Error messages returned (if any)

Tech

• Java
  • Java code for multiple different sample plugins can be found in this repo: https://github.com/dotCMS/plugin-seeds
• The following plugins in the plugin-seeds repo will likely provide the best basis for this plugin:
  • https://github.com/dotCMS/plugin-seeds/tree/master/com.dotcms.app.example
  • https://github.com/dotCMS/plugin-seeds/tree/master/com.dotcms.rest

Testing

• Verify proper operation within the dotCMS Plugins tool
  • Load
  • Start
  • Stop
  • Undeploy
• Unit tests against the API
  • Use postman
• dotCMS will perform manual testing on the test environment before sign-off

Deliverables:

• Executables:
  • OSGI plugin
• Documentation:
  • Plugin:
    • Class dependencies
  • Client API:
    • Endpoints
    • Parameters
    • Parameter values
    • Operation/caveats
• Postman unit test files

[github-actions[bot]]

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 30 days.