API Reference
TreatmentRequest
Describes an AI treatment job over supplied artifacts.
Inheritance
- Object
- TreatmentRequest
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Method ITreatmentProvider.RunAsync
- Method OpenAIChatTreatmentProvider.RunAsync
- Method TreatmentEngine.RunAsync
- Method TreatmentPromptBuilder.Build
- Method TreatmentPromptBuilder.Build
- Method TreatmentPromptBuilder.Validate
Constructors
public TreatmentRequest() #Inherited Methods
Properties
public String Id { get; set; } #Optional caller supplied request id.
public String Name { get; set; } #Optional human readable treatment name.
public String Instructions { get; set; } #System or persona instructions for the treatment run.
public String Prompt { get; set; } #User-facing brief or task prompt.
public Nullable<ReasoningEffort> ReasoningEffort { get; set; } #Optional reasoning effort hint.
public Nullable<TextVerbosity> TextVerbosity { get; set; } #Optional text verbosity hint.
public Nullable<Double> Temperature { get; set; } #Optional sampling temperature.
public String WorkingDirectory { get; set; } #Working directory for provider-side file operations.
public String Workspace { get; set; } #Workspace path for provider-side file access.
public Boolean AllowNetwork { get; set; } #Whether the treatment provider may use network access.
public Boolean NewThread { get; set; } #Whether to force a fresh provider conversation for this treatment run.
public IReadOnlyList<TreatmentInputArtifact> Inputs { get; set; } #Input artifacts available to the model.
public IReadOnlyList<TreatmentOutputSpec> Outputs { get; set; } #Expected outputs for the model to produce.
public TreatmentOutputSchema OutputSchema { get; set; } #Optional structured output contract.
public TreatmentImageOptions ImageGeneration { get; set; } #Optional image generation settings.
public IReadOnlyDictionary<String, String> Metadata { get; set; } #Caller metadata that should travel with the run.
public Boolean InlineLocalInputFiles { get; set; } #Whether local text-like input files should be inlined into provider prompts.
public Nullable<Int32> MaxInlineFileCharacters { get; set; } #Maximum characters to inline per local input file.