| 1 | """Schemas and utilities for tokenization inputs.""" |
| 2 | |
| 3 | # SPDX-License-Identifier: Apache-2.0 |
| 4 | # SPDX-FileCopyrightText: Copyright contributors to the vLLM project |
| 5 | from typing import TypeAlias, TypedDict |
| 6 | |
| 7 | from vllm.inputs import EmbedsPrompt, TokensPrompt |
| 8 | |
| 9 | DecoderOnlyTokPrompt: TypeAlias = TokensPrompt | EmbedsPrompt |
| 10 | """ |
| 11 | A [`DecoderOnlyDictPrompt`][vllm.renderers.inputs.preprocess.DecoderOnlyDictPrompt] |
| 12 | that has been tokenized. |
| 13 | """ |
| 14 | |
| 15 | |
| 16 | EncoderTokPrompt: TypeAlias = TokensPrompt |
| 17 | """ |
| 18 | A [`EncoderDictPrompt`][vllm.renderers.inputs.preprocess.EncoderDictPrompt] |
| 19 | that has been tokenized. |
| 20 | """ |
| 21 | |
| 22 | |
| 23 | DecoderTokPrompt: TypeAlias = TokensPrompt |
| 24 | """ |
| 25 | A [`DecoderDictPrompt`][vllm.renderers.inputs.preprocess.DecoderDictPrompt] |
| 26 | that has been tokenized. |
| 27 | """ |
| 28 | |
| 29 | |
| 30 | class EncoderDecoderTokPrompt(TypedDict): |
| 31 | """A |
| 32 | [`EncoderDecoderDictPrompt`][vllm.renderers.inputs.preprocess.EncoderDecoderDictPrompt] |
| 33 | that has been tokenized. |
| 34 | """ |
| 35 | |
| 36 | encoder_prompt: EncoderTokPrompt |
| 37 | |
| 38 | decoder_prompt: DecoderTokPrompt | None |
| 39 | |
| 40 | |
| 41 | SingletonTokPrompt: TypeAlias = ( |
| 42 | DecoderOnlyTokPrompt | EncoderTokPrompt | DecoderTokPrompt |
| 43 | ) |
| 44 | """ |
| 45 | A [`SingletonDictPrompt`][vllm.renderers.inputs.preprocess.SingletonDictPrompt] |
| 46 | that has been tokenized. |
| 47 | """ |
| 48 | |
| 49 | |
| 50 | TokPrompt: TypeAlias = DecoderOnlyTokPrompt | EncoderDecoderTokPrompt |
| 51 | """ |
| 52 | A [`DictPrompt`][vllm.renderers.inputs.preprocess.DictPrompt] |
| 53 | that has been tokenized. |
| 54 | """ |