Skip to content

sample-modes.md

Latest commit

 

History

History
81 lines (50 loc) · 3.35 KB

sample-modes.md

File metadata and controls

81 lines (50 loc) · 3.35 KB
Raw
title Sample Modes

Sample Modes

The runnable sample in samples/Incursa.OpenAI.Codex.Sample is a single console app with mode-based scenarios. It still expects Codex to be installed locally and authenticated on the machine running the sample.

Quickstart

The quickstart mode shows the shortest end-to-end prompt flow:

dotnet run --project samples/Incursa.OpenAI.Codex.Sample/Incursa.OpenAI.Codex.Sample.csproj -- --mode quickstart --prompt "Summarize this repository."

Use this when you want the smallest end-to-end path: create a CodexClient, start a CodexThread, run one prompt, and print the final response.

Streaming

Shows the event stream as it arrives:

dotnet run --project samples/Incursa.OpenAI.Codex.Sample/Incursa.OpenAI.Codex.Sample.csproj -- --mode streaming --prompt "List three files likely to contain option models."

Use this when you want to build a UI or log pipeline around incremental CodexThreadEvent data.

Structured Output

Shows the CodexTurnOptions.OutputSchema setting with a JSON schema:

dotnet run --project samples/Incursa.OpenAI.Codex.Sample/Incursa.OpenAI.Codex.Sample.csproj -- --mode structured-output --prompt "Return JSON with answer and confidence."

Use this when you need a predictable JSON-shaped result instead of free-form text.

Image Input

Shows local and remote image inputs:

dotnet run --project samples/Incursa.OpenAI.Codex.Sample/Incursa.OpenAI.Codex.Sample.csproj -- --mode image-input --image C:\path\to\image.png --prompt "Describe the image."

Use --image-url instead of --image to provide a remote image input such as CodexImageInput.

Error Handling

Shows capability gating and typed exceptions:

dotnet run --project samples/Incursa.OpenAI.Codex.Sample/Incursa.OpenAI.Codex.Sample.csproj -- --mode error-handling --backend exec --prompt "Explain capability differences."

Use this when you want to see how the SDK behaves when a backend cannot support a request.

Turn Controls

Shows explicit turn steering and interruption:

dotnet run --project samples/Incursa.OpenAI.Codex.Sample/Incursa.OpenAI.Codex.Sample.csproj -- --mode turn-controls --prompt "Draft a short release note." --interrupt

This mode is the clearest demonstration of why AppServer exists: it lets you steer or interrupt a turn after it has started.

DI Variant

Add --use-di to build the client through Incursa.OpenAI.Codex.Extensions:

dotnet run --project samples/Incursa.OpenAI.Codex.Sample/Incursa.OpenAI.Codex.Sample.csproj -- --mode quickstart --use-di

Backend Reminder

  • AppServer is the default in the current package and supports the full thread and turn-control surface
  • Exec is the CLI-backed path for simpler run and stream flows
  • Both modes still run against the local Codex executable; ApiKey and BaseUrl are forwarded to that subprocess, not used by the sample directly