Skip to content

Prompt

10 types. Import any of them from opencode.types.

PromptAgentAttachment

name instance-attribute

name: str

mention class-attribute instance-attribute

mention: PromptMention | None = Field(
    default=None, exclude_if=is_none
)

PromptBase64 module-attribute

PromptBase64: TypeAlias = str

PromptFileAttachment

data instance-attribute

mime instance-attribute

mime: str

source instance-attribute

name class-attribute instance-attribute

name: str | None = Field(default=None, exclude_if=is_none)

description class-attribute instance-attribute

description: str | None = Field(
    default=None, exclude_if=is_none
)

mention class-attribute instance-attribute

mention: PromptMention | None = Field(
    default=None, exclude_if=is_none
)

PromptFileSource module-attribute

PromptFileSource: TypeAlias = Annotated[
    Annotated[PromptFileSourceInline, Tag("inline")]
    | Annotated[PromptFileSourceUri, Tag("uri")]
    | Annotated[
        UnknownPromptFileSource, Tag("__unknown__")
    ],
    Discriminator(
        discriminator("type", "type", ["inline", "uri"])
    ),
]

PromptFileSourceInline

type class-attribute instance-attribute

type: Literal['inline'] = 'inline'

PromptFileSourceUri

type class-attribute instance-attribute

type: Literal['uri'] = 'uri'

uri instance-attribute

uri: str

PromptInputFileAttachment

uri instance-attribute

uri: str

name class-attribute instance-attribute

name: str | None = Field(default=None, exclude_if=is_none)

description class-attribute instance-attribute

description: str | None = Field(
    default=None, exclude_if=is_none
)

mention class-attribute instance-attribute

mention: PromptMention | None = Field(
    default=None, exclude_if=is_none
)

PromptInputSkillAttachment

id instance-attribute

id: SkillID

mention class-attribute instance-attribute

mention: PromptMention | None = Field(
    default=None, exclude_if=is_none
)

PromptMention

start instance-attribute

start: float

end instance-attribute

end: float

text instance-attribute

text: str

PromptSkillAttachment

id instance-attribute

id: SkillID

name instance-attribute

name: SkillName

text class-attribute instance-attribute

text: str | None = Field(default=None, exclude_if=is_none)

mention class-attribute instance-attribute

mention: PromptMention | None = Field(
    default=None, exclude_if=is_none
)