Viewing file:  Files.php (2.89 KB) -rw-rw-r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
declare(strict_types=1);
namespace OpenAI\Resources;
use OpenAI\Responses\Files\CreateResponse;
use OpenAI\Responses\Files\DeleteResponse;
use OpenAI\Responses\Files\ListResponse;
use OpenAI\Responses\Files\RetrieveResponse;
use OpenAI\ValueObjects\Transporter\Payload;
final class Files
{
use Concerns\Transportable;
/**
* Returns a list of files that belong to the user's organization.
*
* @see https://beta.openai.com/docs/api-reference/files/list
*/
public function list(): ListResponse
{
$payload = Payload::list('files');
/** @var array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|string|null}>} $result */
$result = $this->transporter->requestObject($payload);
return ListResponse::from($result);
}
/**
* Returns information about a specific file.
*
* @see https://beta.openai.com/docs/api-reference/files/retrieve
*/
public function retrieve(string $file): RetrieveResponse
{
$payload = Payload::retrieve('files', $file);
/** @var array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|string|null} $result */
$result = $this->transporter->requestObject($payload);
return RetrieveResponse::from($result);
}
/**
* Returns the contents of the specified file.
*
* @see https://beta.openai.com/docs/api-reference/files/retrieve-content
*/
public function download(string $file): string
{
$payload = Payload::retrieveContent('files', $file);
return $this->transporter->requestContent($payload);
}
/**
* Upload a file that contains document(s) to be used across various endpoints/features.
*
* @see https://beta.openai.com/docs/api-reference/files/upload
*
* @param array<string, mixed> $parameters
*/
public function upload(array $parameters): CreateResponse
{
$payload = Payload::upload('files', $parameters);
/** @var array{id: string, object: string, created_at: int, bytes: int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|string|null} $result */
$result = $this->transporter->requestObject($payload);
return CreateResponse::from($result);
}
/**
* Delete a file.
*
* @see https://beta.openai.com/docs/api-reference/files/delete
*/
public function delete(string $file): DeleteResponse
{
$payload = Payload::delete('files', $file);
/** @var array{id: string, object: string, deleted: bool} $result */
$result = $this->transporter->requestObject($payload);
return DeleteResponse::from($result);
}
}
|