Skip to main content

Python module

max.pipelines.modeling.types.pipeline_variants

Text generation

`BatchType`	Type of batch.
`MessageContent`	Represent a PEP 604 union type
`SpecDecodingState`	Per-request state for speculative decoding.
`TextContentPart`	A plain-text content part of a message.
`TextGenerationContext`	Protocol defining the interface for text generation contexts in token generation.
`TextGenerationContextType`	Type variable.
`TextGenerationInputs`	Input parameters for text generation pipeline operations.
`TextGenerationOutput`	Represents the output of a text generation operation.
`TextGenerationRequest`	An immutable request for text token generation from a pipeline.
`TextGenerationRequestFunction`	Represents a function definition for a text generation request.
`TextGenerationRequestMessage`	A single message in a text generation request conversation.
`TextGenerationRequestTool`	Represents a tool definition for a text generation request.
`TextGenerationResponseFormat`	Represents the response format specification for a text generation request.
`VLMContextType`	Type variable.
`VLMTextGenerationContext`	Protocol defining the interface for VLM input contexts.

Image content

`ImageContentPart`	An image content part of a message.
`ImageMetadata`	Metadata about an image in the prompt.
`VideoContentPart`	A video content part of a message.

Embeddings

`EmbeddingsContext`	Protocol defining the interface for embeddings generation contexts.
`EmbeddingsGenerationContextType`	Type variable.
`EmbeddingsGenerationInputs`	Batched inputs for an embeddings generation pipeline step.
`EmbeddingsGenerationOutput`	Response structure for embedding generation.

Audio generation

`AudioGenerationContextType`	Type variable.
`AudioGenerationInputs`	Input data structure for audio generation pipelines.
`AudioGenerationMetadata`	Represents metadata associated with audio generation.
`AudioGenerationOutput`	Represents a response from the audio generation API.
`AudioGenerationRequest`	An immutable request for audio generation from a pipeline.

Image generation

`PixelGenerationContext`	Protocol defining the interface for pixel generation contexts.
`PixelGenerationContextType`	Type variable.
`PixelGenerationInputs`	Input data structure for pixel generation pipelines.

Text generation
Image content
Embeddings
Audio generation
Image generation