| external help file | Module Name | online version | schema |
|---|---|---|---|
PSOpenAI-help.xml |
PSOpenAI |
2.0.0 |
Create a thread.
New-Thread
[-FileIdsForCodeInterpreter <Object[]>]
[-VectorStoresForFileSearch <Object[]>]
[-FileIdsForFileSearch <Object[]>]
[-MetaData <IDictionary>]
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Create a thread.
PS C:\> $Thread = New-ThreadCreate a new thread.
A list of file IDs made available to the code_interpreter tool. There can be a maximum of 20 files associated with the tool.
Type: Object[]
Required: False
Position: NamedThe vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.
Type: Object[]
Required: False
Position: NamedA list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.
Type: Object[]
Required: False
Position: NamedSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format.
Type: IDictionary
Required: False
Position: NamedSpecifies how long the request can be pending before it times out.
The default value is 0 (infinite).
Type: Int32
Required: False
Position: Named
Default value: 0Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.
Type: Int32
Required: False
Position: Named
Default value: 0Specifies an API endpoint URL such like: https://your-api-endpoint.test/v1
If not specified, it will use https://api.openai.com/v1
Type: System.Uri
Required: False
Position: Named
Default value: https://api.openai.com/v1Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY
Type: Object
Required: False
Position: NamedSpecifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION
Type: string
Aliases: OrgId
Required: False
Position: Namedhttps://platform.openai.com/docs/api-reference/threads/createThread