Objeck Documentation

All Bundles

Bundle Support for OpenAI responses APIs (-lib openai)

Response

Model response for a given text and files

Inherits: EndPoint

Operations

GetCreatedAt
GetId
GetModel
GetObject
GetOutputs
GetText
Respond
ToString

GetCreatedAt #

Unix timestamp (in seconds) of when the object instance was created

method : public : GetCreatedAt() ~ Int

Return

Type	Description
Int	time with the object instance was created

GetId #

Get object instance API ID

method : public : GetId() ~ String

Return

Type	Description
String	instance ID

GetModel #

ID of the model to use

method : public : GetModel() ~ String

Return

Type	Description
String	ID of the model to use

GetObject #

Get the object type

method : public : GetObject() ~ String

Return

Type	Description
String	object type

GetOutputs #

Get response outputs

method : public : GetOutputs() ~ Vector<Output>

Return

Type	Description
Vector<Output>	response outputs

GetText #

Get response text

method : public : GetText() ~ String

Return

Type	Description
String	response text

Example

token := "sk-...";
msg := Pair->New("user", "Describe the water cycle.")<String, String>;
resp := Response->Respond("gpt-4o-mini", msg, token);
resp->GetText()->PrintLine();

Respond # function

Model response for the given query

function : Respond(model:String, message:Pair<String,String>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,String>	completion message and image query.
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given query

function : Respond(model:String, message:Pair<String,String>, reasoning_effort:ReasoningEffort, verbosity:Verbosity, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,String>	completion message and image query.
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given query

function : Respond(model:String, message:Pair<String,String>, schema:ParameterType, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,String>	completion message and image query.
schema	ParameterType	output schema
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given query

function : Respond(model:String, message:Pair<String,String>, schema:ParameterType, reasoning_effort:ReasoningEffort, verbosity:Verbosity, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,String>	completion message and image query.
schema	ParameterType	output schema
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given query

function : Respond(model:String, message:Pair<String,String>, max_tokens:Int, temperature:Float, top_p:Float, reasoning_effort:ReasoningEffort, verbosity:Verbosity, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,String>	completion message and image query
max_tokens	Int	maximum number of completion tokens returned by the API
temperature	Float	amount of randomness in the response, valued between 0 inclusive and 2 exclusive
top_p	Float	nucleus sampling threshold, valued between 0 and 1 inclusive
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given query

function : Respond(model:String, message:Pair<String,String>, max_tokens:Int, temperature:Float, top_p:Float, reasoning_effort:ReasoningEffort, verbosity:Verbosity, schema:ParameterType, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,String>	completion message and image query
max_tokens	Int	maximum number of completion tokens returned by the API
temperature	Float	amount of randomness in the response, valued between 0 inclusive and 2 exclusive
top_p	Float	nucleus sampling threshold, valued between 0 and 1 inclusive
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
schema	ParameterType	output schema
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given query

function : Respond(model:String, messages:Vector<Pair<String,String>>) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
messages	Vector<Pair<String,String>>	list of messages comprising the conversation

Return

Type	Description
Response	completion response

Respond # function

Model response for the given query

function : Respond(model:String, messages:Vector<Pair<String,String>>) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
messages	Vector<Pair<String,String>>	list of messages comprising the conversation

Return

Type	Description
Response	completion response

Respond # function

Model response for the given file and query

function : Respond(model:String, message:API.OpenAI.FileQuery, schema:ParameterType, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	FileQuery	completion message and file query.
schema	ParameterType	output schema
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given file and query

function : Respond(model:String, message:API.OpenAI.FileQuery, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	FileQuery	completion message and file query.
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given file and query

function : Respond(model:String, message:API.OpenAI.FileQuery, max_tokens:Int, temperature:Float, top_p:Float, reasoning_effort:ReasoningEffort, verbosity:Verbosity, schema:ParameterType, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	FileQuery	completion message and file query
max_tokens	Int	maximum number of completion tokens returned by the API
temperature	Float	amount of randomness in the response, valued between 0 inclusive and 2 exclusive
top_p	Float	nucleus sampling threshold, valued between 0 and 1 inclusive
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
schema	ParameterType	output schema
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given file and query

function : Respond(model:String, message:API.OpenAI.FileQuery, max_tokens:Int, temperature:Float, top_p:Float, reasoning_effort:ReasoningEffort, verbosity:Verbosity, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	FileQuery	completion message and file query
max_tokens	Int	maximum number of completion tokens returned by the API
temperature	Float	amount of randomness in the response, valued between 0 inclusive and 2 exclusive
top_p	Float	nucleus sampling threshold, valued between 0 and 1 inclusive
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given file and query

function : Respond(model:String, messages:Vector<FileQuery>, schema:ParameterType, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
messages	Vector<FileQuery>	list of messages comprising the conversation
schema	ParameterType	output schema
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given file and query

function : Respond(model:String, messages:Vector<FileQuery>, max_tokens:Int, temperature:Float, top_p:Float, reasoning_effort:ReasoningEffort, verbosity:Verbosity, schema:ParameterType, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
messages	Vector<FileQuery>	list of messages comprising the conversation
max_tokens	Int	maximum number of completion tokens returned by the API
temperature	Float	amount of randomness in the response, valued between 0 inclusive and 2 exclusive
top_p	Float	nucleus sampling threshold, valued between 0 and 1 inclusive
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
schema	ParameterType	output schema
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given image and query

function : Respond(model:String, message:Pair<String,API.OpenAI.ImageQuery>, schema:ParameterType, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,APIOpenAIImageQuery>	completion message and image query.
schema	ParameterType	output schema
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given image and query

function : Respond(model:String, message:Pair<String,API.OpenAI.ImageQuery>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,APIOpenAIImageQuery>	completion message and image query.
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given image and query

function : Respond(model:String, message:Pair<String,API.OpenAI.ImageQuery>, max_tokens:Int, temperature:Float, top_p:Float, reasoning_effort:ReasoningEffort, verbosity:Verbosity, schema:ParameterType, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,APIOpenAIImageQuery>	completion message and image query
max_tokens	Int	maximum number of completion tokens returned by the API
temperature	Float	amount of randomness in the response, valued between 0 inclusive and 2 exclusive
top_p	Float	nucleus sampling threshold, valued between 0 and 1 inclusive
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
schema	ParameterType	output schema
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given image and query

function : Respond(model:String, message:Pair<String,API.OpenAI.ImageQuery>, max_tokens:Int, temperature:Float, top_p:Float, reasoning_effort:ReasoningEffort, verbosity:Verbosity, tools:Vector<Tool>, token:String) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
message	Pair<String,APIOpenAIImageQuery>	completion message and image query
max_tokens	Int	maximum number of completion tokens returned by the API
temperature	Float	amount of randomness in the response, valued between 0 inclusive and 2 exclusive
top_p	Float	nucleus sampling threshold, valued between 0 and 1 inclusive
reasoning_effort	ReasoningEffort	model's reasoning reasoning_effort
verbosity	Verbosity	verbosity of response
tools	Vector<Tool>	list of tools
token	String	API token

Return

Type	Description
Response	completion response

Respond # function

Model response for the given image and query

function : Respond(model:String, messages:Vector<Pair<String,API.OpenAI.ImageQuery>>) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
messages	Vector<Pair<String,APIOpenAIImageQuery>>	list of messages comprising the conversation

Return

Type	Description
Response	completion response

Respond # function

Model response for the given image and query

function : Respond(model:String, messages:Vector<Pair<String,API.OpenAI.ImageQuery>>) ~ Response

Parameters

Name	Type	Description
model	String	ID of the model to use
messages	Vector<Pair<String,APIOpenAIImageQuery>>	list of messages comprising the conversation

Return

Type	Description
Response	completion response

ToString #

String representation of the object

method : public : ToString() ~ String

Return

Type	Description
String	string representation