Cmdlet

Stop-IntelligenceXTurn

Namespace IntelligenceX.PowerShell

Inputs

IntelligenceX.OpenAI.IntelligenceXClient

Interrupts a running turn for a thread.

Examples

Example 1


Stop-IntelligenceXTurn -ThreadId $thread.Id -TurnId $turn.Id

Stop a running turn

Example 2


$turn = Send-IntelligenceXMessage -ThreadId $thread.Id -Text "Generate a long report"; Stop-IntelligenceXTurn -ThreadId $thread.Id -TurnId $turn.Id

Stop the turn returned by Send-IntelligenceXMessage

Example 3


Stop-IntelligenceXTurn -Client $client -ThreadId $thread.Id -TurnId $turn.Id

Interrupt with an explicit client

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Stop-IntelligenceXTurn -ThreadId <string> -TurnId <string> [-Client <IntelligenceXClient>] [<CommonParameters>]

Parameters

ThreadId string requiredposition: namedpipeline: false: Identifier of the thread that owns the running turn.
TurnId string requiredposition: namedpipeline: false: Identifier of the turn to interrupt.
Client IntelligenceXClient optionalposition: namedpipeline: true (ByValue): Client instance to use. Defaults to the active client.