Support uploading files

[thekid]

This can be used for file uploads or to transcribe audio, for example:

use com\openai\rest\OpenAIEndpoint;
use io\File;
use util\cmd\Console;
use util\MimeType;

$ai= new OpenAIEndpoint('https://'.getenv('OPENAI_API_KEY').'@api.openai.com/v1');
$file= new File($argv[1]);

$response= $ai->api('/audio/transcriptions')
  ->open(['model' => 'whisper-1'])
  ->transfer('file', $file->in(), $file->filename, MimeType::getByFileName($file->filename))
  ->finish()
;
Console::writeLine($response->value());

See also

• https://platform.openai.com/docs/api-reference/files
• https://platform.openai.com/docs/guides/speech-to-text/overview
• https://community.openai.com/t/how-can-i-send-an-audio-file-via-whisper-api/409672/4
• Add Api::transmit() to invoke API and return response #6

[thekid]

Should we abstract this into a higher-level API along the lines of the following?

$value= $ai->api('/audio/transcriptions')->upload($file, ['model' => 'whisper-1']);

[thekid]

Should we abstract this into a higher-level API

Maybe (like with transmit vs. invoke) we have both, but start with the higher-level abstraction, calling it transfer. We do need an easy way to stream the data though, like an OutputStream that can be written to.

Unsure how to implement at the moment...

[thekid]

Unsure how to implement at the moment...

How about this:

// Using transfer
$response $ai->api('/audio/transcriptions')
  ->open(['model' => 'whisper-1']);
  ->transfer('file', $file->in(), $file->filename)
  ->finish()
;

// Using streaming
$uploads= $ai->api('/audio/transcriptions')->open(['model' => 'whisper-1']);
$stream= $uploads->stream('file', $file->filename);
while ($in->available()) {
  $stream->write($in->read());
}
$response= $uploads->finish();

This mimicks the (underlying) webservices.rest.RestUpload but abstracts it into something slightly simpler.

[thekid]

Integration tests for transcription:

• OpenAI
• AzureAI

[thekid]

Released in https://github.com/xp-forge/openai/releases/tag/v0.6.0