Add documentation for configuring API Key and project for OpenAI

Created on 7 August 2024, 3 months ago
Updated 23 August 2024, 3 months ago

Problem/Motivation

OpenAI is moving toward using project API keys in lieu of personal API keys. The project API keys are 132 characters, so they get truncated and cause an incorrect key error. Personal API keys are only 95 characters and fit in the short text field.

Steps to reproduce

  1. In the Providers in translations settings, configure the OpenAI provider (/admin/tmgmt/translators/manage/openai)
  2. Paste a project API key into the API key field, note that it does not fit.

Proposed resolution

(This is a bit fuzzy for me... I 'm not sure what the best approach would be)
Change the field type to long text field to accommodate a longer API key, or maybe add a second field for a project API key to be used instead.
Alternatively, update documentation that a personal API key needs to be used and not a project API key.

Remaining tasks

Probably just update documentation.

User interface changes

Probably none, if documentation is just updated or if the field can be updated to hold more than 128 characters. Otherwise, possibly adding a field so there are two options for API keys? That seems cumbersome.

API changes

Would need to update API checking to check for either API key length.

Data model changes

I don't know.

✨ Feature request
Status

Active

Version

1.0

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States erindarri

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024