Dokumentation - Server Grundfunktionen (public)

new platform\openAi\response() - Object

`$string $array input = null`	enthält alle Eingaben, Texte, Bilder oder Dateien
`$string model = 'gpt-4o-2024-11-20'`	enthält das Model, siehe platform\openAi::MODEL_GPT, MODEL_REASONING, MODEL_SEARCH, MODEL_COMPUTERUSE, MODEL_IMAGE
`$bool background = null`	führt die Anfrage im Hintergrund aus
`$array include = array()`	gibt zusätzliche Ausgabedaten an, die in die Modellantwort aufgenommen werden sollen; 'file_search_call.results', 'message.input_image.image_url', 'computer_call_output.output.image_url' oder 'reasoning.encrypted_content'
`$string instructions = null`	system / developer Messages
`$integer max_output_tokens = null`	maximale Ausgabe Tokens
`$array metadata = null`	speichert zusätzliche Daten (KEY => VALUE)
`$bool parallel_tool_calls = true`	gibt an, ob Tools parallel ausgeführt werden dürfen
`$string previous_response_id = null`	vorherige Response ID, um den Kontext zu behalten
`$object reasoning = null`	enthält Konfiguration über Reasoning Model
`$string service_tier = null`	gibt die Latenzstufe an, die für die Verarbeitung der Anfrage verwendet werden soll, dieser Parameter ist für Kunden relevant, die den Scale-Tier-Dienst abonniert haben; 'auto', 'default' oder 'flex'
`$bool store = null`	bei true wird die Antwort gespeichert
`$bool stream = null`	bei true wird die Antwort gestreamt
`$float temperature = null`	Abtasttemperatur die verwendet werden soll, zwischen 0 und 2. Höhere Werte wie 0,8 machen die Ausgabe zufälliger, während niedrigere Werte wie 0,2 sie fokussierter und deterministischer machen. Entweder diesen Wert oder top_p ändern, aber nicht beide
`$object text = null`	Konfigurationsoptionen für eine Textantwort aus dem Modell, kann einfacher Text oder strukturierte JSON-Daten sein
`$string $object tool_choice = null`	gibt an, welches Tool (oder welche Tools) bei der Generierung einer Antwort verwendet werden soll, siehe Parameter "tools"
`$array tools = array()`	Tools, die das Modell beim Generieren einer Antwort aufrufen kann
`$float top_p = null`	eine Alternative zur Stichprobenentnahme mit Temperatur, die als Kern-Stichprobenentnahme bezeichnet wird, bei der das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse top_p berücksichtigt; 0,1 bedeutet also, dass nur die Token berücksichtigt werden, die die obersten 10 % der Wahrscheinlichkeitsmasse ausmachen; zwischen 0 und 1
`$string truncation = null`	verwendende Trunkierungsstrategie; 'auto' oder 'disabled'; auto: Wenn der Kontext dieser Antwort und der vorherigen Antworten die Größe des Kontextfensters des Modells überschreitet, kürzt das Modell die Antwort, um sie an das Kontextfenster anzupassen, indem es Eingabeelemente in der Mitte der Konversation weglässt; Deaktiviert (Standard): Wenn eine Modellantwort die Größe des Kontextfensters für ein Modell überschreitet, schlägt die Anfrage mit einem 400-Fehler fehl.
`$string user = null`	kann eine ID eines Users enthalten
`$array lastResponse = array()`	gibt den letzten Response an, der abgerufen wurde

__construct ([$string $array $text = null])

$text optional; kann ein Text als User Role angegeben werden

https://platform.openai.com/docs/api-reference/responses

erstellt ein neues Response Objekt


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response();


      print_r($response);

__get ($string $name)

$name Name der Variable

gibt die Eigenschaften des Response Objekts zurück


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      echo $response->model;

__set ($string $name, $mixed $val)

`$name`	gibt die Objekteigenschaft an
`$val`	gibt den zu speichernden Wert an

speichert neue Werte im Objekt


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->model = 'o3-mini';

__debugInfo ()

gibt alle Eigenschaften des Response Objekts zurück


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      print_r ($response);

__invoke ()

https://platform.openai.com/docs/api-reference/responses/create

führt die Anfrage bei OpenAi durch und gibt ein array zurück; ansonsten null


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response();

Input

addText ($string $array $text = null[, $string $role = null[, $string $status = null]])

`$text`	gibt ein Text als string oder array an
`$role`	optional; gibt die Rolle als string an; 'developer', 'system', 'assistant' oder 'user'; default ist 'user'
`$status`	optional; gibt den Status für Ouputs als string an

https://platform.openai.com/docs/api-reference/responses/create#responses-create-input

gibt true zurück, wenn der Text gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addText ('Und kannst du mir etwas zu C++ erzählen');

addContent ($object $content = null[, $string $role = null[, $string $status = null]])

`$content`	gibt den Content als new platform\openAi\lib\content() Objekt an
`$role`	optional; gibt die Rolle als string an; 'developer', 'system', 'assistant' oder 'user'; default ist 'user'
`$status`	optional; gibt den Status für Ouputs als string an

https://platform.openai.com/docs/api-reference/responses/create#responses-create-input

gibt true zurück, wenn der Content gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ();


      $content = new platform\openAi\lib\content ();

      $content->addText('was ist auf diesem Bild zu sehen?');

      $content->addImage('media/img/testbild.png');


      $response->addContent ();

addReference ($string $id = null)

$id gibt die Reference ID als string an

https://platform.openai.com/docs/api-reference/responses/create#responses-create-input

gibt true zurück, wenn die Reference gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addReference (REF_ID);

Tools

addFunction ($string $name = null, $array $parameters = null[, $bool $strict = null[, $string $description = null]])

`$name`	gibt den Namen der Funktion als string an
`$parameters`	gibt die Parameter der Funktion als array an
`$strict`	optional; gibt mit true an ob sich strict an das Ausgabeformat gehalten werden soll
`$description`	optional; gibt eine Beschreibung der Funktion als string an

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

gibt true zurück, wenn die Funktion hinzugefügt wurde; ansonsten false


      $response = new platform\openAi\response ('berechne ein paar Mathematikaufgaben');


      $parameters = [

          'type' => 'object',

          'properties' => [

            'a' => [

              'type' => 'number',

              'description' => 'Die erste Zahl.'

            ],

            'b' => [

              'type' => 'number',

              'description' => 'Die zweite Zahl.'

            ],

            'unit' => [

              'type' => 'string',

              'enum' => ['mm', 'cm'],

              'description' => 'Maßeinheit, falls angegeben'

            ]

          ],

          'required' => ['a', 'b']

      ];


      $response->addFunction ('add_numbers', $parameters, true, 'Addiert zwei Zahlen und gibt die Summe zurück.');

addFileSearch ($string $array $vectorStoreIds = null[, $array $filters = null[, $integer $maxNumResults = null[, $string $ranker = null[, $float $scoreThreshold = null]]]])

`$vectorStoreIds`	gibt die VektorStore ID als string oder array an
`$filters`	optional; gibt ein Filter als array an `[ 'type' => 'eq' // 'eq': equals, 'ne': not equal, 'gt': greater than, 'gte': greater than or equal, 'lt': less than, 'lte': less than or equal 'key' => 'test' // gibt ein Key als String an 'value' => 1 // gibt den Wert an, als bool, numeric oder string ]` `[ 'filters' => #FILTERS // als array; ['type' => 'eq', 'key' => 'test', 'value' => 1] 'type' => 'and' // gibt den Filtertyp an; 'and' oder 'or' ]`
`$maxNumResults`	optional; maximale Ergebnisse
`$ranker`	optional; für die Dateisuche zu verwendende Ranker
`$scoreThreshold`	optional; Schwellenwert für die Dateisuche, eine Zahl zwischen 0 und 1; Zahlen näher an 1 versuchen, nur die relevantesten Ergebnisse zurückzugeben, liefern jedoch möglicherweise weniger Ergebnisse

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

gibt true zurück, wenn FileSearch hinzugefügt wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addFileSearch ('vs_6wet23f345zserg45424');

addWebSearch ([$string $searchContextSize = null[, $string $city = null[, $string $country = null[, $string $region = null[, $string $timezone = null]]]]])

`$searchContextSize`	optional; allgemeine Richtlinie für die Größe des Kontextfensters, das für die Suche verwendet werden soll; als string, ('low', 'medium' oder 'high')
`$city`	optional; gibt die Stadt des Benutzers als string an ('San Francisco')
`$country`	optional; gibt das Land des Benutzers als string an, ISO Country Code ('US')
`$region`	optional; gibt die Region des Benutzers als string an ('California')
`$timezone`	optional; gibt die Zeitzone des Benutzers als string an ('America/Los_Angeles')

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

es wird eine Websuche durchgeführt; gibt true zurück, wenn der WebSearch gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addWebSearch ();

addComputerUse ($integer $height = null, $integer $width = null, $string $environment = null)

`$height`	Höhe der Computerauflösung als integer
`$width`	Weite der Computerauflösung als integer
`$environment`	Umgebung die ausgeführt werden soll, z.B. 'browser', 'mac', 'windows', 'ubuntu'

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

gibt true zurück, wenn der ComputerUse gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addComputerUse (1024, 768, 'windows');

addMcpTool ()

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

muss noch ausgearbeitet werden


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addMcpTool ();

addCodeInterpreter ($array $string $containerFileIds = null)

$containerFileIds gibt die Dateien an, für den Code Interpreter, als string oder array

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

gibt true zurück, wenn der Code Interpreter gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addCodeInterpreter ('cntr_6vcan6uHqsNAoHm0FSYjZY7y');

addImageGeneration ([$string $background = null, [$array $inputImageMask = null, [$string $model = null, [$string $moderation = null, [$integer $outputCompression = null, [$string $outputFormat = null, [$integer $partialImages = null, [$string $quality = null, [$string $size = null]]]]]]]]])

`$background`	optional; gibt an was mit dem Hintergrund gemacht werden soll, ('transparent', 'opaque' oder 'auto')
`$inputImageMask`	optional; verwendet eine Maske, als array `[ 'file_id' => null // gibt die File ID als string an 'image_url' => null // gibt die Bild URL, Base64 als string an ]`
`$model`	optional; zu verwendenten Model an (nur 'gpt-image-1')
`$moderation`	optional; Moderationsstufe für das generierte Bild (default 'auto')
`$outputCompression`	optional; Bildkompression (default 100)
`$outputFormat`	optional; Ausgabeformat als string ('png', 'webp' oder 'jpeg')
`$partialImages`	optional; Anzahl der im Streaming-Modus zu generierenden Teilbilder, von 0 (Standardwert) bis 3
`$quality`	optional; Qualität des Bildes ('low', 'medium', 'high' oder 'auto')
`$size`	optional; Größe des Bildes ('1024x1024', '1024x1536', '1536x1024' oder 'auto')

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

gibt true zurück, wenn der Image Generator gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir ein Landschaftsbild erzeugen?');


      $response->addImageGeneration ();

addLocalShellTool ()

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tools

ein Tool, mit dem das Modell Shell-Befehle in einer lokalen Umgebung ausführen kann; gibt true zurück, wenn das Tool gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->addLocalShellTool ();

Sonstiges

reasoning ([$string $effort = null[, $string $summary = null]])

`$effort`	optional; begrenzt den Aufwand für die Argumentation bei Reasoning Modellen, eine Verringerung des Argumentationsaufwands kann zu schnelleren Antworten und einer geringeren Anzahl von Tokens führen, die für die Argumentation in einer Antwort verwendet werden ('low', 'medium' und 'high')
`$summary`	optional; eine Zusammenfassung der vom Modell durchgeführten Argumentation. Dies kann für die Fehlersuche und das Verständnis des Argumentationsprozesses des Modells nützlich sein ('auto', 'concise' und 'detailed')

https://platform.openai.com/docs/api-reference/responses/create#responses-create-reasoning

gibt true zurück, wenn die Einstellung gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->reasoning ('low');

text ($string $format = null[, $string $name = null[, $array $schema = null[, $string $description = null[, $bool $strict = null]]]])

`$format`	enthält das Format welches verwendet werden soll ('text', 'json_schema' und 'json_object')
`$name`	enthält den Namen vom JSON Schema als string
`$schema`	enthält das Schema vom JSON Schema als array
`$description`	enthält die Beschreibung des JSON Schemas als string
`$strict`	gibt mit true an, das sich genau an das JSON Schemas gehalten wird

https://platform.openai.com/docs/api-reference/responses/create#responses-create-text

gibt true zurück, wenn die Einstellung gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->text ('json_schema', #NAME, [#SCHEMA]);

tool_choice ($string $tool = null[, $string $name = null])

`$tool`	gibt die Funktion als string an ('none', 'auto', 'required', 'file_search', 'web_search_preview', 'computer_use_preview', 'code_interpreter', 'mcp', 'image_generation' und Funktionsnamen)
`$name`	optional; enthält den Funktionsnamen als string an

https://platform.openai.com/docs/api-reference/responses/create#responses-create-tool_choice

gibt true zurück, wenn die Einstellung gespeichert wurde; ansonsten false


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->tool_choice ('file_search');

Reset

reset ()

setzt alle gespeicherten Informationen zurück, außer die letzte Antwort ($lastResponse)


      $response = new platform\openAi\response ('Kannst du mir etwas über PHP erzählen?');


      $response->reset();

Response [extends \platform\openAi] - (platform\openAi\response.class.php)

new platform\openAi\response() - Object

Input

Tools

Sonstiges

Reset

Überprüfung

Response