API Reference
TreatmentRequest
Describes an AI treatment job over supplied artifacts.
Inheritance
- Object
- TreatmentRequest
Usage
Explore 5 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters 5
- Method ITreatmentProvider.RunAsync
- Method OpenAIChatTreatmentProvider.RunAsync
- Method TreatmentEngine.RunAsync
- Method TreatmentPromptBuilder.Build
- Method TreatmentPromptBuilder.Validate
Constructors
public TreatmentRequest() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String? Instructions { get; set; } #System or persona instructions for the treatment run.
public ReasoningEffort? ReasoningEffort { get; set; } #Optional reasoning effort hint.
public TextVerbosity? TextVerbosity { get; set; } #Optional text verbosity hint.
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 Boolean EnforceOutputSchema { get; set; } #Requests transport-level schema enforcement. False retains the existing prompted-contract behavior.
public Int32 MaxInlineImageBytes { get; set; } #Maximum aggregate inline image bytes; local paths retain their own caller policy.
public Int64? MaxResponseBytes { get; set; } #Optional maximum provider response wire bytes, including streaming protocol overhead.
public Boolean Ephemeral { get; set; } #Executes without retaining local conversation state after the provider request settles.
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 Int32? MaxInlineFileCharacters { get; set; } #Maximum characters to inline per local input file.