Expand description
Provider-neutral domain contract for Imagegen Bridge.
Structs§
- Aspect
Ratio - Aspect ratio represented as
WIDTH:HEIGHTwith non-zero integer terms. - Batch
Capabilities - Effective and native multi-output behavior for a provider/model pair.
- Bridge
Error - Public, redaction-safe error returned by the bridge.
- Generated
Image - Metadata and payload for one generated image.
- Generation
Parameters - Image-generation parameters shared across providers.
- Image
Failure - Failure for one output in a best-effort multi-image request.
- Image
Input - One image input plus optional metadata.
- Image
Job - Complete durable job record returned by detail lookup.
- Image
JobPage - Cursor-paginated job/history result.
- Image
JobProgress - Bounded latest progress snapshot for a durable job.
- Image
JobSummary - List-safe durable job state without request image bodies.
- Image
JobUpdate - Mutable gallery fields for one retained durable job.
- Image
Preset - Persisted named preset.
- Image
Preset Create - Create payload for a named preset.
- Image
Preset Page - Cursor-paginated preset collection.
- Image
Preset Template - Complete reusable request configuration, excluding image inputs and idempotency keys.
- Image
Preset Write - Full replacement payload for a preset.
- Image
Request - A complete provider-neutral image request.
- Image
Response - Complete normalized response.
- Image
Size - Image size represented as
autoorWIDTHxHEIGHT. - Input
Capabilities - Input-image constraints.
- Negotiated
Request - Request after provider capability negotiation.
- Normalization
- One explicit normalization or fallback applied to a request.
- Output
Options - Output delivery controls.
- Provider
Attempt - Redaction-safe execution trace for one provider route.
- Provider
Capabilities - Complete capability declaration for one provider/model pair.
- Provider
Context - Runtime metadata and cancellation propagated into a provider call.
- Provider
Descriptor - Provider identity shown in discovery endpoints.
- Provider
Route - One explicit provider/model fallback route.
- Request
Limits - Configurable limits applied before provider negotiation.
- Request
Policies - Explicit fallback and visibility controls.
- Routing
Options - Provider selection controls.
- Session
Metadata - Session information returned after a request.
- Session
Options - Conversation/session controls.
- Size
Capabilities - Explicit-size constraints for a provider or model.
- Timings
- Stage timings in milliseconds.
- Transparency
Options - Transparent-background implementation and matte controls.
- U8Range
- Inclusive range for a small integer parameter.
- Usage
- Optional provider usage accounting.
- Validation
Issue - One intrinsic validation issue.
Enums§
- Artifact
Collision Policy - Atomic behavior when an explicit artifact filename already exists.
- Artifact
Metadata Policy - Optional portable generation-metadata persistence policy.
- Background
- Requested background behavior.
- Batch
Execution - Preferred execution shape for bridge-emulated multi-image fan-out.
- Batch
Mode - How a provider fulfills a request for more than one output image.
- Compatibility
Mode - Compatibility policy used during provider negotiation.
- Contract
Message - All top-level native messages represented as one versioned JSON Schema.
- Error
Code - Stable machine-readable error classification.
- Fallback
Policy - Conditions under which an ordered provider fallback may run.
- Image
Action - Image-generation tool action for conversational transports.
- Image
JobStatus - Durable lifecycle state for one asynchronous image operation.
- Image
Operation - Operation-specific image inputs.
- Image
Payload - Generated output payload.
- Image
Source - Supported image input locations.
- Input
Fidelity - Fidelity used when processing image inputs.
- Moderation
- Provider moderation strictness where configurable.
- Multi
Image Failure Policy - Behavior when one output in a multi-image request fails.
- Negative
Prompt Mode - Handling policy for a negative prompt.
- Output
Format - Encoded output image format.
- Preset
Operation - Operation selected by a preset without retaining source image bytes.
- Provider
Attempt Outcome - Outcome of one ordered provider route attempt.
- Provider
Event - Incremental provider progress.
- Quality
- Requested generation quality.
- Resolution
- Coarse output resolution hint.
- Response
Format - Desired output payload representation.
- Revised
Prompt Policy - Visibility and requirement policy for an upstream revised prompt.
- Session
Mode - Codex conversation behavior for a request.
- Support
Level - Degree to which a provider supports a semantic feature.
- Transparency
Mode - How a transparent-background result is produced.
Constants§
- CONTRACT_
VERSION - Current native wire-contract version.
Traits§
- Image
Provider - Provider-neutral image backend.
Functions§
- contract_
schema - Generates the current native contract schema.
- negotiate_
request - Negotiates one intrinsically valid request against provider capabilities.
- validate_
preset_ name - Validates a preset resource name.
- validate_
preset_ write - Validates bounded preset metadata independent of provider capabilities.
- validate_
request - Validates a request before any provider or I/O work occurs.
- validation_
issues - Returns all intrinsic issues in deterministic field order.
Type Aliases§
- Provider
Event Stream - Stream returned by providers that expose incremental progress.