Dokumentation - Server Grundfunktionen (public)

Container

static platform\openAi\container::createContainer ($string $name = null, $string $array $file_ids = null[, $integer $expires_after = null])

`$name`	Name des Containers
`$file_ids`	enthält die File IDs als string oder array
`$expires_after`	optional; gibt die Ablaufzeit in Minuten an

https://platform.openai.com/docs/api-reference/containers/createContainers

erzeugt ein neuen Container; im Fehlerfall null


    platform\openAi\container::createContainer('Testdaten', ['file-aia75zFVocj5R4TaKxy3xLfN', 'file-aia7TaKxy3xLfN5zFVocj5R4']);

static platform\openAi\container::isContainerId ($string $containerId = null)

$containerId enthält die Container ID

prüft ob der string eine Container ID ist und gibt true zurück; ansonsten false


    platform\openAi\container::isContainerId('cntr_6vcan6uHqsNAoHm0FSYjZY7y');

static platform\openAi\container::containerIdExists ($string $containerId = null)

$containerId enthält die Container ID

prüft ob die Container ID existiert und gibt true zurück; ansonsten false


    platform\openAi\container::containerIdExists('cntr_6vcan6uHqsNAoHm0FSYjZY7y');

static platform\openAi\container::getContainerList ([$array $options = null])

$options optional; Query:
[ 'limit' => null, // integer, maximale Dateien die aufgelistet werden sollen 'after' => null, // string, ID der Datei 'order' => null, // 'created_at', 'asc' oder 'desc', zum sortieren ]

https://platform.openai.com/docs/api-reference/containers/listContainers

listet alle Containeres auf; im Fehlerfall null


    platform\openAi\container::getContainerList();

static platform\openAi\container::getContainer ($string $containerId = null)

$containerId enthält die ID des Containers

https://platform.openai.com/docs/api-reference/containers/retrieveContainer

listet Informationen über den Container auf; im Fehlerfall null


    platform\openAi\container::getContainer('cntr_6vcan6uHqsNAoHm0FSYjZY7y');

static platform\openAi\container::deleteContainer ($string $containerId = null)

$containerId enthält die ID des Containers

https://platform.openai.com/docs/api-reference/containers/deleteContainer

löscht den Container; im Fehlerfall null


    platform\openAi\container::deleteContainer('cntr_6vcan6uHqsNAoHm0FSYjZY7y');

Container Files

static platform\openAi\container::createContainerFile ($string $containerId = null, $string $object $file = null)

`$containerId`	enthält die ID des Containers
`$file`	enthält die Datei, Pfad oder File ID als string oder new file() Object

https://platform.openai.com/docs/api-reference/container-files/createContainerFile

fügt eine Datei einem bestehenden Container hinzu und gibt ein array zurück; im Fehlerfall null


    platform\openAi\container::createContainerFile('cntr_6vcan6uHqsNAoHm0FSYjZY7y', 'media/img/testfile.png');

static platform\openAi\container::getContainerFileList ($string $containerId = null[, $array $options = null])

`$containerId`	enthält die ID des Containers
`$options`	optional; Query: `[ 'limit' => null, // integer, maximale Dateien die aufgelistet werden sollen 'after' => null, // string, ID der Datei 'order' => null, // 'created_at', 'asc' oder 'desc', zum sortieren ]`

https://platform.openai.com/docs/api-reference/container-files/listContainerFiles

listet alle Dateien im Containere auf; im Fehlerfall null


    platform\openAi\container::getContainerFileList();

static platform\openAi\container::getContainerFile ($string $containerId = null, $string $fileId = null)

`$containerId`	enthält die ID des Containers
`$fileId`	enthält die ID der Datei

https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFile

listet Informationen über eine Datei im Container auf; im Fehlerfall null


    platform\openAi\container::getContainerFile('cntr_6vcan6uHqsNAoHm0FSYjZY7y', 'file-aia75zFVocj5R4TaKxy3xLfN');

static platform\openAi\container::getContainerFileContent ($string $containerId = null, $string $fileId = null)

`$containerId`	enthält die ID des Containers
`$fileId`	enthält die ID der Datei

https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFileContent

gibt den Inhalt einer Datei im Container zurück; im Fehlerfall null


    platform\openAi\container::getContainerFileContent('cntr_6vcan6uHqsNAoHm0FSYjZY7y', 'file-aia75zFVocj5R4TaKxy3xLfN');

static platform\openAi\container::deleteContainerFile ($string $containerId = null, $string $fileId = null)

`$containerId`	enthält die ID des Containers
`$fileId`	enthält die ID der Datei

https://platform.openai.com/docs/api-reference/container-files/deleteContainerFile

löscht eine Datei im Container; im Fehlerfall null


    platform\openAi\container::deleteContainerFile('cntr_6vcan6uHqsNAoHm0FSYjZY7y', 'file-aia75zFVocj5R4TaKxy3xLfN');