TsgcHTTP_API_OpenAIMethods › CreateThread

CreateThread Method

Creates a new Thread optionally seeded with initial messages and tool resources

Syntax

function CreateThread(const aRequest: TsgcOpenAIClass_Request_Thread) : TsgcOpenAIClass_Thread;

Parameters

NameTypeDescription
aRequestconst TsgcOpenAIClass_Request_ThreadOptional initial messages, tool resources and metadata for the new Thread. May be nil to create an empty Thread.

Return Value

The newly created Thread object including its generated id (TsgcOpenAIClass_Thread)

Remarks

Calls POST /v1/threads to create a conversation Thread that an Assistant can be run against. A Thread may be created empty and have messages appended later, or seeded with an initial list of messages and tool resources such as a vector store for file search. The returned id (e.g. thread_abc123) is required by every Messages and Runs call.

Example

var oThread: TsgcOpenAIClass_Thread;
begin
  oThread := oAPI.CreateThread(nil);
  ShowMessage('Thread id: ' + oThread.Id);
end;

Back to Methods