vllm - 💡(How to fix) Fix [Feature]: Allow passing `images` to CompletionRequest [3 comments, 2 participants]

class _NDArrayPydanticAnnotation:
    @classmethod
    def __get_pydantic_core_schema__(
        cls,
        _source_type: Any,
        _handler: GetCoreSchemaHandler,
    ) -> core_schema.CoreSchema:
        from_serialized_schema = core_schema.no_info_plain_validator_function(
            _deserialize_ndarray
        )

        return core_schema.json_or_python_schema(
            json_schema=from_serialized_schema,
            python_schema=from_serialized_schema,
            serialization=core_schema.plain_serializer_function_ser_schema(
                _serialize_ndarray
            ),
        )

SerializableNDArray = Annotated[np.ndarray, _NDArrayPydanticAnnotation]

class CompletionRequest(OpenAIBaseModel):
    # Ordered by official OpenAI API documentation
    # https://platform.openai.com/docs/api-reference/completions/create
    model: str | None = None
    images: list[SerializableNDArray] = Field(default_factory=list)
    prompt: (
        list[Annotated[int, Field(ge=0)]]
        | list[list[Annotated[int, Field(ge=0)]]]
        | str
        | list[str]
        | None
    ) = None

    @root_validator
    def validate_images_and_prompt(cls, values):
        images, prompt = values.get("images"), values.get("prompt")
        if images and not isinstance(prompt, list) or not all(isinstance(x, int) for x in prompt):
            raise ValueError("When images are provided, prompt must be a list of integers")
        return values

request = CompletionRequest(
    model="Qwen3.5-9B-Base",
    images=[np.array([1, 2, 3])],
    prompt=[1, 2, 3]
)
try:
    request.validate()
    print("Request is valid")
except ValueError as e:
    print(f"Request is invalid: {e}")