IntelligenceX
Cmdlet

Start-IntelligenceXReview

Namespace IntelligenceX.PowerShell
Inputs
IntelligenceX.OpenAI.IntelligenceXClient
Outputs
IntelligenceX.Json.JsonValue IntelligenceX.OpenAI.AppServer.Models.ReviewStartResult

Starts a review flow for a thread.

Examples

Example 1


Start-IntelligenceXReview -ThreadId $thread.id -Delivery immediate -TargetType uncommittedChanges
        

Review uncommitted changes

Example 2


Start-IntelligenceXReview -ThreadId $thread.id -Delivery immediate -TargetType commit -TargetValue 3f2a9c1
        

Review a specific commit

Example 3


Start-IntelligenceXReview -ThreadId $thread.id -Delivery immediate -TargetType baseBranch -TargetValue "main"
        

Review a base branch

Example 4


Start-IntelligenceXReview -ThreadId $thread.id -Delivery immediate -TargetType commit -TargetValue 3f2a9c1 -Raw
        

Return raw JSON output

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

Start-IntelligenceXReview -Delivery <string> -TargetType <string> -ThreadId <string> [-Client <IntelligenceXClient>] [-Raw] [-TargetValue <string>] [<CommonParameters>]
#

Parameters

Delivery string requiredposition: namedpipeline: false
Delivery mode (for example immediate).
TargetType string requiredposition: namedpipeline: false
Target type: uncommittedChanges, baseBranch, commit, custom.
ThreadId string requiredposition: namedpipeline: false
Thread identifier.
Client IntelligenceXClient optionalposition: namedpipeline: true (ByValue)
Client instance to use. Defaults to the active client.
Raw SwitchParameter optionalposition: namedpipeline: false
Return raw JSON response.
TargetValue string optionalposition: namedpipeline: false
Target value (branch name, commit SHA, or custom text).

Outputs

IntelligenceX.Json.JsonValue, IntelligenceX.OpenAI.AppServer.Models.ReviewStartResult