orq-ai-sdk 4.2.0rc28__py3-none-any.whl → 4.2.6__py3-none-any.whl

orq_ai_sdk/models/getpromptversionop.py

@@ -1,6 +1,30 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .audiocontentpartschema import (
+    AudioContentPartSchema,
+    AudioContentPartSchemaTypedDict,
+)
+from .filecontentpartschema import FileContentPartSchema, FileContentPartSchemaTypedDict
+from .imagecontentpartschema import (
+    ImageContentPartSchema,
+    ImageContentPartSchemaTypedDict,
+)
+from .reasoningpartschema import ReasoningPartSchema, ReasoningPartSchemaTypedDict
+from .redactedreasoningpartschema import (
+    RedactedReasoningPartSchema,
+    RedactedReasoningPartSchemaTypedDict,
+)
+from .refusalpartschema import RefusalPartSchema, RefusalPartSchemaTypedDict
+from .textcontentpartschema import TextContentPartSchema, TextContentPartSchemaTypedDict
+from .thinkingconfigdisabledschema import (
+    ThinkingConfigDisabledSchema,
+    ThinkingConfigDisabledSchemaTypedDict,
+)
+from .thinkingconfigenabledschema import (
+    ThinkingConfigEnabledSchema,
+    ThinkingConfigEnabledSchemaTypedDict,
+)
 from dataclasses import dataclass, field
 import httpx
 from orq_ai_sdk.models import OrqError
@@ -15,7 +39,13 @@ from orq_ai_sdk.utils import FieldMetadata, PathParamMetadata, get_discriminator
 import pydantic
 from pydantic import Discriminator, Tag, model_serializer
 from typing import Any, Dict, List, Literal, Optional, Union
-from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+from typing_extensions import (
+    Annotated,
+    NotRequired,
+    TypeAliasType,
+    TypedDict,
+    deprecated,
+)
 
 
 class GetPromptVersionRequestTypedDict(TypedDict):
@@ -67,6 +97,7 @@ GetPromptVersionModelType = Literal[
     "tts",
     "stt",
     "rerank",
+    "ocr",
     "moderation",
     "vision",
 ]
@@ -107,39 +138,47 @@ GetPromptVersionResponseFormat4 = Literal[
 ]
 
 
-GetPromptVersionResponseFormatPromptsResponseType = Literal["text",]
+GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType = (
+    Literal["text",]
+)
 
 
 class GetPromptVersionResponseFormat3TypedDict(TypedDict):
-    type: GetPromptVersionResponseFormatPromptsResponseType
+    type: (
+        GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType
+    )
 
 
 class GetPromptVersionResponseFormat3(BaseModel):
-    type: GetPromptVersionResponseFormatPromptsResponseType
+    type: (
+        GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType
+    )
 
 
-GetPromptVersionResponseFormatPromptsType = Literal["json_object",]
+GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType = Literal[
+    "json_object",
+]
 
 
 class GetPromptVersionResponseFormat2TypedDict(TypedDict):
-    type: GetPromptVersionResponseFormatPromptsType
+    type: GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType
 
 
 class GetPromptVersionResponseFormat2(BaseModel):
-    type: GetPromptVersionResponseFormatPromptsType
+    type: GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType
 
 
-GetPromptVersionResponseFormatType = Literal["json_schema",]
+GetPromptVersionResponseFormatPromptsResponse200Type = Literal["json_schema",]
 
 
-class GetPromptVersionResponseFormatJSONSchemaTypedDict(TypedDict):
+class GetPromptVersionResponseFormatPromptsResponseJSONSchemaTypedDict(TypedDict):
     name: str
     schema_: Dict[str, Any]
     description: NotRequired[str]
     strict: NotRequired[bool]
 
 
-class GetPromptVersionResponseFormatJSONSchema(BaseModel):
+class GetPromptVersionResponseFormatPromptsResponseJSONSchema(BaseModel):
     name: str
 
     schema_: Annotated[Dict[str, Any], pydantic.Field(alias="schema")]
@@ -148,23 +187,55 @@ class GetPromptVersionResponseFormatJSONSchema(BaseModel):
 
     strict: Optional[bool] = None
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["description", "strict"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 class GetPromptVersionResponseFormat1TypedDict(TypedDict):
-    type: GetPromptVersionResponseFormatType
-    json_schema: GetPromptVersionResponseFormatJSONSchemaTypedDict
+    type: GetPromptVersionResponseFormatPromptsResponse200Type
+    json_schema: GetPromptVersionResponseFormatPromptsResponseJSONSchemaTypedDict
     display_name: NotRequired[str]
 
 
 class GetPromptVersionResponseFormat1(BaseModel):
-    type: GetPromptVersionResponseFormatType
+    type: GetPromptVersionResponseFormatPromptsResponse200Type
 
-    json_schema: GetPromptVersionResponseFormatJSONSchema
+    json_schema: GetPromptVersionResponseFormatPromptsResponseJSONSchema
 
     display_name: Optional[str] = None
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["display_name"])
+        serialized = handler(self)
+        m = {}
 
-GetPromptVersionResponseFormatTypedDict = TypeAliasType(
-    "GetPromptVersionResponseFormatTypedDict",
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionPromptsResponseFormatTypedDict = TypeAliasType(
+    "GetPromptVersionPromptsResponseFormatTypedDict",
     Union[
         GetPromptVersionResponseFormat2TypedDict,
         GetPromptVersionResponseFormat3TypedDict,
@@ -184,8 +255,8 @@ Important: when using JSON mode, you must also instruct the model to produce JSO
 """
 
 
-GetPromptVersionResponseFormat = TypeAliasType(
-    "GetPromptVersionResponseFormat",
+GetPromptVersionPromptsResponseFormat = TypeAliasType(
+    "GetPromptVersionPromptsResponseFormat",
     Union[
         GetPromptVersionResponseFormat2,
         GetPromptVersionResponseFormat3,
@@ -219,7 +290,7 @@ GetPromptVersionEncodingFormat = Literal[
 r"""The format to return the embeddings"""
 
 
-GetPromptVersionReasoningEffort = Literal[
+GetPromptVersionPromptsReasoningEffort = Literal[
     "none",
     "disable",
     "minimal",
@@ -272,7 +343,9 @@ class GetPromptVersionModelParametersTypedDict(TypedDict):
     r"""Only supported on `image` models."""
     style: NotRequired[str]
     r"""Only supported on `image` models."""
-    response_format: NotRequired[Nullable[GetPromptVersionResponseFormatTypedDict]]
+    response_format: NotRequired[
+        Nullable[GetPromptVersionPromptsResponseFormatTypedDict]
+    ]
     r"""An object specifying the format that the model must output.
 
     Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema
@@ -285,7 +358,7 @@ class GetPromptVersionModelParametersTypedDict(TypedDict):
     r"""The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider"""
     encoding_format: NotRequired[GetPromptVersionEncodingFormat]
     r"""The format to return the embeddings"""
-    reasoning_effort: NotRequired[GetPromptVersionReasoningEffort]
+    reasoning_effort: NotRequired[GetPromptVersionPromptsReasoningEffort]
     r"""Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response."""
     budget_tokens: NotRequired[float]
     r"""Gives the model enhanced reasoning capabilities for complex tasks. A value of 0 disables thinking. The minimum budget tokens for thinking are 1024. The Budget Tokens should never exceed the Max Tokens parameter. Only supported by `Anthropic`"""
@@ -341,7 +414,7 @@ class GetPromptVersionModelParameters(BaseModel):
     r"""Only supported on `image` models."""
 
     response_format: Annotated[
-        OptionalNullable[GetPromptVersionResponseFormat],
+        OptionalNullable[GetPromptVersionPromptsResponseFormat],
         pydantic.Field(alias="responseFormat"),
     ] = UNSET
     r"""An object specifying the format that the model must output.
@@ -363,7 +436,7 @@ class GetPromptVersionModelParameters(BaseModel):
     r"""The format to return the embeddings"""
 
     reasoning_effort: Annotated[
-        Optional[GetPromptVersionReasoningEffort],
+        Optional[GetPromptVersionPromptsReasoningEffort],
         pydantic.Field(alias="reasoningEffort"),
     ] = None
     r"""Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response."""
@@ -383,51 +456,48 @@ class GetPromptVersionModelParameters(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = [
-            "temperature",
-            "maxTokens",
-            "topK",
-            "topP",
-            "frequencyPenalty",
-            "presencePenalty",
-            "numImages",
-            "seed",
-            "format",
-            "dimensions",
-            "quality",
-            "style",
-            "responseFormat",
-            "photoRealVersion",
-            "encoding_format",
-            "reasoningEffort",
-            "budgetTokens",
-            "verbosity",
-            "thinkingLevel",
-        ]
-        nullable_fields = ["responseFormat"]
-        null_default_fields = []
-
+        optional_fields = set(
+            [
+                "temperature",
+                "maxTokens",
+                "topK",
+                "topP",
+                "frequencyPenalty",
+                "presencePenalty",
+                "numImages",
+                "seed",
+                "format",
+                "dimensions",
+                "quality",
+                "style",
+                "responseFormat",
+                "photoRealVersion",
+                "encoding_format",
+                "reasoningEffort",
+                "budgetTokens",
+                "verbosity",
+                "thinkingLevel",
+            ]
+        )
+        nullable_fields = set(["responseFormat"])
         serialized = handler(self)
-
         m = {}
 
         for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
-            serialized.pop(k, None)
-
-            optional_nullable = k in optional_fields and k in nullable_fields
-            is_set = (
-                self.__pydantic_fields_set__.intersection({n})
-                or k in null_default_fields
-            )  # pylint: disable=no-member
-
-            if val is not None and val != UNSET_SENTINEL:
-                m[k] = val
-            elif val != UNSET_SENTINEL and (
-                not k in optional_fields or (optional_nullable and is_set)
-            ):
-                m[k] = val
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m
 
@@ -503,6 +573,22 @@ class GetPromptVersion2File(BaseModel):
     filename: Optional[str] = None
     r"""The name of the file, used when passing the file to the model as a string."""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["file_data", "uri", "mimeType", "filename"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 class GetPromptVersion23TypedDict(TypedDict):
     type: GetPromptVersion2PromptsResponseType
@@ -539,6 +625,22 @@ class GetPromptVersion2ImageURL(BaseModel):
     detail: Optional[str] = None
     r"""Specifies the detail level of the image. Currently only supported with OpenAI models"""
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["id", "detail"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 class GetPromptVersion22TypedDict(TypedDict):
     r"""The image part of the prompt message. Only supported with vision models."""
@@ -606,7 +708,7 @@ GetPromptVersionContent = TypeAliasType(
 r"""The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Can be null for tool messages in certain scenarios."""
 
 
-GetPromptVersionType = Literal["function",]
+GetPromptVersionPromptsType = Literal["function",]
 
 
 class GetPromptVersionFunctionTypedDict(TypedDict):
@@ -623,14 +725,14 @@ class GetPromptVersionFunction(BaseModel):
 
 
 class GetPromptVersionToolCallsTypedDict(TypedDict):
-    type: GetPromptVersionType
+    type: GetPromptVersionPromptsType
     function: GetPromptVersionFunctionTypedDict
     id: NotRequired[str]
     index: NotRequired[float]
 
 
 class GetPromptVersionToolCalls(BaseModel):
-    type: GetPromptVersionType
+    type: GetPromptVersionPromptsType
 
     function: GetPromptVersionFunction
 
@@ -638,6 +740,22 @@ class GetPromptVersionToolCalls(BaseModel):
 
     index: Optional[float] = None
 
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["id", "index"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
 
 class GetPromptVersionMessagesTypedDict(TypedDict):
     role: GetPromptVersionRole
@@ -661,61 +779,62 @@ class GetPromptVersionMessages(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["tool_calls", "tool_call_id"]
-        nullable_fields = ["content", "tool_call_id"]
-        null_default_fields = []
-
+        optional_fields = set(["tool_calls", "tool_call_id"])
+        nullable_fields = set(["content", "tool_call_id"])
         serialized = handler(self)
-
         m = {}
 
         for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
-            serialized.pop(k, None)
-
-            optional_nullable = k in optional_fields and k in nullable_fields
-            is_set = (
-                self.__pydantic_fields_set__.intersection({n})
-                or k in null_default_fields
-            )  # pylint: disable=no-member
-
-            if val is not None and val != UNSET_SENTINEL:
-                m[k] = val
-            elif val != UNSET_SENTINEL and (
-                not k in optional_fields or (optional_nullable and is_set)
-            ):
-                m[k] = val
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m
 
 
+@deprecated(
+    "warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+)
 class GetPromptVersionPromptConfigTypedDict(TypedDict):
-    r"""A list of messages compatible with the openAI schema"""
+    r"""[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema."""
 
     messages: List[GetPromptVersionMessagesTypedDict]
     stream: NotRequired[bool]
-    model: NotRequired[str]
+    model: NotRequired[Nullable[str]]
     model_db_id: NotRequired[Nullable[str]]
     r"""The id of the resource"""
     model_type: NotRequired[Nullable[GetPromptVersionModelType]]
     r"""The modality of the model"""
     model_parameters: NotRequired[GetPromptVersionModelParametersTypedDict]
     r"""Model Parameters: Not all parameters apply to every model"""
-    provider: NotRequired[GetPromptVersionProvider]
+    provider: NotRequired[Nullable[GetPromptVersionProvider]]
     integration_id: NotRequired[Nullable[str]]
     r"""The ID of the integration to use"""
     version: NotRequired[str]
 
 
+@deprecated(
+    "warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+)
 class GetPromptVersionPromptConfig(BaseModel):
-    r"""A list of messages compatible with the openAI schema"""
+    r"""[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema."""
 
     messages: List[GetPromptVersionMessages]
 
     stream: Optional[bool] = None
 
-    model: Optional[str] = None
+    model: OptionalNullable[str] = UNSET
 
     model_db_id: OptionalNullable[str] = UNSET
     r"""The id of the resource"""
@@ -726,7 +845,7 @@ class GetPromptVersionPromptConfig(BaseModel):
     model_parameters: Optional[GetPromptVersionModelParameters] = None
     r"""Model Parameters: Not all parameters apply to every model"""
 
-    provider: Optional[GetPromptVersionProvider] = None
+    provider: OptionalNullable[GetPromptVersionProvider] = UNSET
 
     integration_id: OptionalNullable[str] = UNSET
     r"""The ID of the integration to use"""
@@ -735,184 +854,1519 @@ class GetPromptVersionPromptConfig(BaseModel):
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = [
-            "stream",
-            "model",
-            "model_db_id",
-            "model_type",
-            "model_parameters",
-            "provider",
-            "integration_id",
-            "version",
-        ]
-        nullable_fields = ["model_db_id", "model_type", "integration_id"]
-        null_default_fields = []
-
+        optional_fields = set(
+            [
+                "stream",
+                "model",
+                "model_db_id",
+                "model_type",
+                "model_parameters",
+                "provider",
+                "integration_id",
+                "version",
+            ]
+        )
+        nullable_fields = set(
+            ["model", "model_db_id", "model_type", "provider", "integration_id"]
+        )
         serialized = handler(self)
-
         m = {}
 
         for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
-            serialized.pop(k, None)
-
-            optional_nullable = k in optional_fields and k in nullable_fields
-            is_set = (
-                self.__pydantic_fields_set__.intersection({n})
-                or k in null_default_fields
-            )  # pylint: disable=no-member
-
-            if val is not None and val != UNSET_SENTINEL:
-                m[k] = val
-            elif val != UNSET_SENTINEL and (
-                not k in optional_fields or (optional_nullable and is_set)
-            ):
-                m[k] = val
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m
 
 
-GetPromptVersionUseCases = Literal[
-    "Agents simulations",
-    "Agents",
-    "API interaction",
-    "Autonomous Agents",
-    "Chatbots",
-    "Classification",
-    "Code understanding",
-    "Code writing",
-    "Conversation",
-    "Documents QA",
-    "Evaluation",
-    "Extraction",
-    "Multi-modal",
-    "Self-checking",
-    "Sentiment analysis",
-    "SQL",
-    "Summarization",
-    "Tagging",
-    "Translation (document)",
-    "Translation (sentences)",
+GetPromptVersionVoice = Literal[
+    "alloy",
+    "echo",
+    "fable",
+    "onyx",
+    "nova",
+    "shimmer",
 ]
+r"""The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer."""
 
 
-GetPromptVersionLanguage = Literal[
-    "Chinese",
-    "Dutch",
-    "English",
-    "French",
-    "German",
-    "Russian",
-    "Spanish",
+GetPromptVersionPromptsFormat = Literal[
+    "wav",
+    "mp3",
+    "flac",
+    "opus",
+    "pcm16",
 ]
-r"""The language that the prompt is written in. Use this field to categorize the prompt for your own purpose"""
+r"""Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16."""
 
 
-class GetPromptVersionMetadataTypedDict(TypedDict):
-    use_cases: NotRequired[List[GetPromptVersionUseCases]]
-    r"""A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose"""
-    language: NotRequired[Nullable[GetPromptVersionLanguage]]
-    r"""The language that the prompt is written in. Use this field to categorize the prompt for your own purpose"""
+class GetPromptVersionAudioTypedDict(TypedDict):
+    r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
 
+    voice: GetPromptVersionVoice
+    r"""The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer."""
+    format_: GetPromptVersionPromptsFormat
+    r"""Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16."""
 
-class GetPromptVersionMetadata(BaseModel):
-    use_cases: Optional[List[GetPromptVersionUseCases]] = None
-    r"""A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose"""
 
-    language: OptionalNullable[GetPromptVersionLanguage] = UNSET
-    r"""The language that the prompt is written in. Use this field to categorize the prompt for your own purpose"""
+class GetPromptVersionAudio(BaseModel):
+    r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
+
+    voice: GetPromptVersionVoice
+    r"""The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer."""
+
+    format_: Annotated[GetPromptVersionPromptsFormat, pydantic.Field(alias="format")]
+    r"""Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16."""
+
+
+GetPromptVersionResponseFormatPromptsResponseType = Literal["json_schema",]
+
+
+class GetPromptVersionResponseFormatJSONSchemaTypedDict(TypedDict):
+    name: str
+    r"""The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."""
+    description: NotRequired[str]
+    r"""A description of what the response format is for, used by the model to determine how to respond in the format."""
+    schema_: NotRequired[Any]
+    r"""The schema for the response format, described as a JSON Schema object."""
+    strict: NotRequired[bool]
+    r"""Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true."""
+
+
+class GetPromptVersionResponseFormatJSONSchema(BaseModel):
+    name: str
+    r"""The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."""
+
+    description: Optional[str] = None
+    r"""A description of what the response format is for, used by the model to determine how to respond in the format."""
+
+    schema_: Annotated[Optional[Any], pydantic.Field(alias="schema")] = None
+    r"""The schema for the response format, described as a JSON Schema object."""
+
+    strict: Optional[bool] = False
+    r"""Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["use_cases", "language"]
-        nullable_fields = ["language"]
-        null_default_fields = []
-
+        optional_fields = set(["description", "schema", "strict"])
         serialized = handler(self)
-
         m = {}
 
         for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
-            serialized.pop(k, None)
-
-            optional_nullable = k in optional_fields and k in nullable_fields
-            is_set = (
-                self.__pydantic_fields_set__.intersection({n})
-                or k in null_default_fields
-            )  # pylint: disable=no-member
 
-            if val is not None and val != UNSET_SENTINEL:
-                m[k] = val
-            elif val != UNSET_SENTINEL and (
-                not k in optional_fields or (optional_nullable and is_set)
-            ):
-                m[k] = val
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
 
         return m
 
 
-class GetPromptVersionResponseBodyTypedDict(TypedDict):
-    r"""Prompt version retrieved successfully."""
+class GetPromptVersionResponseFormatPromptsJSONSchemaTypedDict(TypedDict):
+    r"""
 
-    id: str
-    prompt_config: GetPromptVersionPromptConfigTypedDict
-    r"""A list of messages compatible with the openAI schema"""
-    timestamp: str
-    created_by_id: NotRequired[Nullable[str]]
-    updated_by_id: NotRequired[Nullable[str]]
-    description: NotRequired[Nullable[str]]
-    r"""The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose"""
-    metadata: NotRequired[GetPromptVersionMetadataTypedDict]
+    JSON Schema response format. Used to generate structured JSON responses
+    """
 
+    type: GetPromptVersionResponseFormatPromptsResponseType
+    json_schema: GetPromptVersionResponseFormatJSONSchemaTypedDict
 
-class GetPromptVersionResponseBody(BaseModel):
-    r"""Prompt version retrieved successfully."""
 
-    id: Annotated[str, pydantic.Field(alias="_id")]
+class GetPromptVersionResponseFormatPromptsJSONSchema(BaseModel):
+    r"""
 
-    prompt_config: GetPromptVersionPromptConfig
-    r"""A list of messages compatible with the openAI schema"""
+    JSON Schema response format. Used to generate structured JSON responses
+    """
 
-    timestamp: str
+    type: GetPromptVersionResponseFormatPromptsResponseType
 
-    created_by_id: OptionalNullable[str] = UNSET
+    json_schema: GetPromptVersionResponseFormatJSONSchema
 
-    updated_by_id: OptionalNullable[str] = UNSET
 
-    description: OptionalNullable[str] = UNSET
-    r"""The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose"""
+GetPromptVersionResponseFormatPromptsType = Literal["json_object",]
 
-    metadata: Optional[GetPromptVersionMetadata] = None
+
+class GetPromptVersionResponseFormatJSONObjectTypedDict(TypedDict):
+    r"""
+
+    JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.
+    """
+
+    type: GetPromptVersionResponseFormatPromptsType
+
+
+class GetPromptVersionResponseFormatJSONObject(BaseModel):
+    r"""
+
+    JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.
+    """
+
+    type: GetPromptVersionResponseFormatPromptsType
+
+
+GetPromptVersionResponseFormatType = Literal["text",]
+
+
+class GetPromptVersionResponseFormatTextTypedDict(TypedDict):
+    r"""
+
+    Default response format. Used to generate text responses
+    """
+
+    type: GetPromptVersionResponseFormatType
+
+
+class GetPromptVersionResponseFormatText(BaseModel):
+    r"""
+
+    Default response format. Used to generate text responses
+    """
+
+    type: GetPromptVersionResponseFormatType
+
+
+GetPromptVersionResponseFormatTypedDict = TypeAliasType(
+    "GetPromptVersionResponseFormatTypedDict",
+    Union[
+        GetPromptVersionResponseFormatTextTypedDict,
+        GetPromptVersionResponseFormatJSONObjectTypedDict,
+        GetPromptVersionResponseFormatPromptsJSONSchemaTypedDict,
+    ],
+)
+r"""An object specifying the format that the model must output"""
+
+
+GetPromptVersionResponseFormat = Annotated[
+    Union[
+        Annotated[GetPromptVersionResponseFormatText, Tag("text")],
+        Annotated[GetPromptVersionResponseFormatJSONObject, Tag("json_object")],
+        Annotated[GetPromptVersionResponseFormatPromptsJSONSchema, Tag("json_schema")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "type", "type")),
+]
+r"""An object specifying the format that the model must output"""
+
+
+GetPromptVersionReasoningEffort = Literal[
+    "none",
+    "minimal",
+    "low",
+    "medium",
+    "high",
+    "xhigh",
+]
+r"""Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+
+- `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
+- All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
+- The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
+- `xhigh` is currently only supported for `gpt-5.1-codex-max`.
+
+Any of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\".
+"""
+
+
+GetPromptVersionStopTypedDict = TypeAliasType(
+    "GetPromptVersionStopTypedDict", Union[str, List[str]]
+)
+r"""Up to 4 sequences where the API will stop generating further tokens."""
+
+
+GetPromptVersionStop = TypeAliasType("GetPromptVersionStop", Union[str, List[str]])
+r"""Up to 4 sequences where the API will stop generating further tokens."""
+
+
+class GetPromptVersionStreamOptionsTypedDict(TypedDict):
+    r"""Options for streaming response. Only set this when you set stream: true."""
+
+    include_usage: NotRequired[bool]
+    r"""If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value."""
+
+
+class GetPromptVersionStreamOptions(BaseModel):
+    r"""Options for streaming response. Only set this when you set stream: true."""
+
+    include_usage: Optional[bool] = None
+    r"""If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["created_by_id", "updated_by_id", "description", "metadata"]
-        nullable_fields = ["created_by_id", "updated_by_id", "description"]
-        null_default_fields = []
-
+        optional_fields = set(["include_usage"])
         serialized = handler(self)
+        m = {}
 
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionThinkingTypedDict = TypeAliasType(
+    "GetPromptVersionThinkingTypedDict",
+    Union[ThinkingConfigDisabledSchemaTypedDict, ThinkingConfigEnabledSchemaTypedDict],
+)
+
+
+GetPromptVersionThinking = Annotated[
+    Union[
+        Annotated[ThinkingConfigDisabledSchema, Tag("disabled")],
+        Annotated[ThinkingConfigEnabledSchema, Tag("enabled")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "type", "type")),
+]
+
+
+GetPromptVersionToolChoiceType = Literal["function",]
+r"""The type of the tool. Currently, only function is supported."""
+
+
+class GetPromptVersionToolChoiceFunctionTypedDict(TypedDict):
+    name: str
+    r"""The name of the function to call."""
+
+
+class GetPromptVersionToolChoiceFunction(BaseModel):
+    name: str
+    r"""The name of the function to call."""
+
+
+class GetPromptVersionToolChoice2TypedDict(TypedDict):
+    function: GetPromptVersionToolChoiceFunctionTypedDict
+    type: NotRequired[GetPromptVersionToolChoiceType]
+    r"""The type of the tool. Currently, only function is supported."""
+
+
+class GetPromptVersionToolChoice2(BaseModel):
+    function: GetPromptVersionToolChoiceFunction
+
+    type: Optional[GetPromptVersionToolChoiceType] = None
+    r"""The type of the tool. Currently, only function is supported."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["type"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionToolChoice1 = Literal[
+    "none",
+    "auto",
+    "required",
+]
+
+
+GetPromptVersionToolChoiceTypedDict = TypeAliasType(
+    "GetPromptVersionToolChoiceTypedDict",
+    Union[GetPromptVersionToolChoice2TypedDict, GetPromptVersionToolChoice1],
+)
+r"""Controls which (if any) tool is called by the model."""
+
+
+GetPromptVersionToolChoice = TypeAliasType(
+    "GetPromptVersionToolChoice",
+    Union[GetPromptVersionToolChoice2, GetPromptVersionToolChoice1],
+)
+r"""Controls which (if any) tool is called by the model."""
+
+
+GetPromptVersionModalities = Literal[
+    "text",
+    "audio",
+]
+
+
+GetPromptVersionID1 = Literal[
+    "orq_pii_detection",
+    "orq_sexual_moderation",
+    "orq_harmful_moderation",
+]
+r"""The key of the guardrail."""
+
+
+GetPromptVersionIDTypedDict = TypeAliasType(
+    "GetPromptVersionIDTypedDict", Union[GetPromptVersionID1, str]
+)
+
+
+GetPromptVersionID = TypeAliasType(
+    "GetPromptVersionID", Union[GetPromptVersionID1, str]
+)
+
+
+GetPromptVersionExecuteOn = Literal[
+    "input",
+    "output",
+]
+r"""Determines whether the guardrail runs on the input (user message) or output (model response)."""
+
+
+class GetPromptVersionGuardrailsTypedDict(TypedDict):
+    id: GetPromptVersionIDTypedDict
+    execute_on: GetPromptVersionExecuteOn
+    r"""Determines whether the guardrail runs on the input (user message) or output (model response)."""
+
+
+class GetPromptVersionGuardrails(BaseModel):
+    id: GetPromptVersionID
+
+    execute_on: GetPromptVersionExecuteOn
+    r"""Determines whether the guardrail runs on the input (user message) or output (model response)."""
+
+
+class GetPromptVersionFallbacksTypedDict(TypedDict):
+    model: str
+    r"""Fallback model identifier"""
+
+
+class GetPromptVersionFallbacks(BaseModel):
+    model: str
+    r"""Fallback model identifier"""
+
+
+class GetPromptVersionRetryTypedDict(TypedDict):
+    r"""Retry configuration for the request"""
+
+    count: NotRequired[float]
+    r"""Number of retry attempts (1-5)"""
+    on_codes: NotRequired[List[float]]
+    r"""HTTP status codes that trigger retry logic"""
+
+
+class GetPromptVersionRetry(BaseModel):
+    r"""Retry configuration for the request"""
+
+    count: Optional[float] = 3
+    r"""Number of retry attempts (1-5)"""
+
+    on_codes: Optional[List[float]] = None
+    r"""HTTP status codes that trigger retry logic"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["count", "on_codes"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionType = Literal["exact_match",]
+
+
+class GetPromptVersionCacheTypedDict(TypedDict):
+    r"""Cache configuration for the request."""
+
+    type: GetPromptVersionType
+    ttl: NotRequired[float]
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+
+class GetPromptVersionCache(BaseModel):
+    r"""Cache configuration for the request."""
+
+    type: GetPromptVersionType
+
+    ttl: Optional[float] = 1800
+    r"""Time to live for cached responses in seconds. Maximum 259200 seconds (3 days)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ttl"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionLoadBalancerType = Literal["weight_based",]
+
+
+class GetPromptVersionLoadBalancerModelsTypedDict(TypedDict):
+    model: str
+    r"""Model identifier for load balancing"""
+    weight: NotRequired[float]
+    r"""Weight assigned to this model for load balancing"""
+
+
+class GetPromptVersionLoadBalancerModels(BaseModel):
+    model: str
+    r"""Model identifier for load balancing"""
+
+    weight: Optional[float] = 0.5
+    r"""Weight assigned to this model for load balancing"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["weight"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class GetPromptVersionLoadBalancer1TypedDict(TypedDict):
+    type: GetPromptVersionLoadBalancerType
+    models: List[GetPromptVersionLoadBalancerModelsTypedDict]
+
+
+class GetPromptVersionLoadBalancer1(BaseModel):
+    type: GetPromptVersionLoadBalancerType
+
+    models: List[GetPromptVersionLoadBalancerModels]
+
+
+GetPromptVersionLoadBalancerTypedDict = GetPromptVersionLoadBalancer1TypedDict
+r"""Load balancer configuration for the request."""
+
+
+GetPromptVersionLoadBalancer = GetPromptVersionLoadBalancer1
+r"""Load balancer configuration for the request."""
+
+
+class GetPromptVersionTimeoutTypedDict(TypedDict):
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
+class GetPromptVersionTimeout(BaseModel):
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
+
+    call_timeout: float
+    r"""Timeout value in milliseconds"""
+
+
+GetPromptVersionMessagesPromptsResponse200Role = Literal["tool",]
+r"""The role of the messages author, in this case tool."""
+
+
+GetPromptVersionContentPromptsResponse2002TypedDict = TextContentPartSchemaTypedDict
+
+
+GetPromptVersionContentPromptsResponse2002 = TextContentPartSchema
+
+
+GetPromptVersionMessagesPromptsResponse200ContentTypedDict = TypeAliasType(
+    "GetPromptVersionMessagesPromptsResponse200ContentTypedDict",
+    Union[str, List[GetPromptVersionContentPromptsResponse2002TypedDict]],
+)
+r"""The contents of the tool message."""
+
+
+GetPromptVersionMessagesPromptsResponse200Content = TypeAliasType(
+    "GetPromptVersionMessagesPromptsResponse200Content",
+    Union[str, List[GetPromptVersionContentPromptsResponse2002]],
+)
+r"""The contents of the tool message."""
+
+
+GetPromptVersionMessagesPromptsType = Literal["ephemeral",]
+r"""Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"."""
+
+
+GetPromptVersionMessagesTTL = Literal[
+    "5m",
+    "1h",
+]
+r"""The time-to-live for the cache control breakpoint. This may be one of the following values:
+
+- `5m`: 5 minutes
+- `1h`: 1 hour
+
+Defaults to `5m`. Only supported by `Anthropic` Claude models.
+"""
+
+
+class GetPromptVersionMessagesCacheControlTypedDict(TypedDict):
+    type: GetPromptVersionMessagesPromptsType
+    r"""Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"."""
+    ttl: NotRequired[GetPromptVersionMessagesTTL]
+    r"""The time-to-live for the cache control breakpoint. This may be one of the following values:
+
+    - `5m`: 5 minutes
+    - `1h`: 1 hour
+
+    Defaults to `5m`. Only supported by `Anthropic` Claude models.
+    """
+
+
+class GetPromptVersionMessagesCacheControl(BaseModel):
+    type: GetPromptVersionMessagesPromptsType
+    r"""Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"."""
+
+    ttl: Optional[GetPromptVersionMessagesTTL] = "5m"
+    r"""The time-to-live for the cache control breakpoint. This may be one of the following values:
+
+    - `5m`: 5 minutes
+    - `1h`: 1 hour
+
+    Defaults to `5m`. Only supported by `Anthropic` Claude models.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ttl"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class GetPromptVersionMessagesToolMessageTypedDict(TypedDict):
+    role: GetPromptVersionMessagesPromptsResponse200Role
+    r"""The role of the messages author, in this case tool."""
+    content: GetPromptVersionMessagesPromptsResponse200ContentTypedDict
+    r"""The contents of the tool message."""
+    tool_call_id: Nullable[str]
+    r"""Tool call that this message is responding to."""
+    cache_control: NotRequired[GetPromptVersionMessagesCacheControlTypedDict]
+
+
+class GetPromptVersionMessagesToolMessage(BaseModel):
+    role: GetPromptVersionMessagesPromptsResponse200Role
+    r"""The role of the messages author, in this case tool."""
+
+    content: GetPromptVersionMessagesPromptsResponse200Content
+    r"""The contents of the tool message."""
+
+    tool_call_id: Nullable[str]
+    r"""Tool call that this message is responding to."""
+
+    cache_control: Optional[GetPromptVersionMessagesCacheControl] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["cache_control"])
+        nullable_fields = set(["tool_call_id"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionContentPromptsResponse2TypedDict = TypeAliasType(
+    "GetPromptVersionContentPromptsResponse2TypedDict",
+    Union[
+        RefusalPartSchemaTypedDict,
+        RedactedReasoningPartSchemaTypedDict,
+        TextContentPartSchemaTypedDict,
+        ReasoningPartSchemaTypedDict,
+    ],
+)
+
+
+GetPromptVersionContentPromptsResponse2 = Annotated[
+    Union[
+        Annotated[TextContentPartSchema, Tag("text")],
+        Annotated[RefusalPartSchema, Tag("refusal")],
+        Annotated[ReasoningPartSchema, Tag("reasoning")],
+        Annotated[RedactedReasoningPartSchema, Tag("redacted_reasoning")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "type", "type")),
+]
+
+
+GetPromptVersionMessagesPromptsResponseContentTypedDict = TypeAliasType(
+    "GetPromptVersionMessagesPromptsResponseContentTypedDict",
+    Union[str, List[GetPromptVersionContentPromptsResponse2TypedDict]],
+)
+r"""The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified."""
+
+
+GetPromptVersionMessagesPromptsResponseContent = TypeAliasType(
+    "GetPromptVersionMessagesPromptsResponseContent",
+    Union[str, List[GetPromptVersionContentPromptsResponse2]],
+)
+r"""The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified."""
+
+
+GetPromptVersionMessagesPromptsResponseRole = Literal["assistant",]
+r"""The role of the messages author, in this case `assistant`."""
+
+
+class GetPromptVersionMessagesAudioTypedDict(TypedDict):
+    r"""Data about a previous audio response from the model."""
+
+    id: str
+    r"""Unique identifier for a previous audio response from the model."""
+
+
+class GetPromptVersionMessagesAudio(BaseModel):
+    r"""Data about a previous audio response from the model."""
+
+    id: str
+    r"""Unique identifier for a previous audio response from the model."""
+
+
+GetPromptVersionMessagesType = Literal["function",]
+r"""The type of the tool. Currently, only `function` is supported."""
+
+
+class GetPromptVersionMessagesFunctionTypedDict(TypedDict):
+    name: NotRequired[str]
+    r"""The name of the function to call."""
+    arguments: NotRequired[str]
+    r"""The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."""
+
+
+class GetPromptVersionMessagesFunction(BaseModel):
+    name: Optional[str] = None
+    r"""The name of the function to call."""
+
+    arguments: Optional[str] = None
+    r"""The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["name", "arguments"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class GetPromptVersionMessagesToolCallsTypedDict(TypedDict):
+    id: str
+    r"""The ID of the tool call."""
+    type: GetPromptVersionMessagesType
+    r"""The type of the tool. Currently, only `function` is supported."""
+    function: GetPromptVersionMessagesFunctionTypedDict
+    thought_signature: NotRequired[str]
+    r"""Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call."""
+
+
+class GetPromptVersionMessagesToolCalls(BaseModel):
+    id: str
+    r"""The ID of the tool call."""
+
+    type: GetPromptVersionMessagesType
+    r"""The type of the tool. Currently, only `function` is supported."""
+
+    function: GetPromptVersionMessagesFunction
+
+    thought_signature: Optional[str] = None
+    r"""Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["thought_signature"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class GetPromptVersionMessagesAssistantMessageTypedDict(TypedDict):
+    role: GetPromptVersionMessagesPromptsResponseRole
+    r"""The role of the messages author, in this case `assistant`."""
+    content: NotRequired[
+        Nullable[GetPromptVersionMessagesPromptsResponseContentTypedDict]
+    ]
+    r"""The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified."""
+    refusal: NotRequired[Nullable[str]]
+    r"""The refusal message by the assistant."""
+    name: NotRequired[str]
+    r"""An optional name for the participant. Provides the model information to differentiate between participants of the same role."""
+    audio: NotRequired[Nullable[GetPromptVersionMessagesAudioTypedDict]]
+    r"""Data about a previous audio response from the model."""
+    tool_calls: NotRequired[List[GetPromptVersionMessagesToolCallsTypedDict]]
+    r"""The tool calls generated by the model, such as function calls."""
+
+
+class GetPromptVersionMessagesAssistantMessage(BaseModel):
+    role: GetPromptVersionMessagesPromptsResponseRole
+    r"""The role of the messages author, in this case `assistant`."""
+
+    content: OptionalNullable[GetPromptVersionMessagesPromptsResponseContent] = UNSET
+    r"""The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified."""
+
+    refusal: OptionalNullable[str] = UNSET
+    r"""The refusal message by the assistant."""
+
+    name: Optional[str] = None
+    r"""An optional name for the participant. Provides the model information to differentiate between participants of the same role."""
+
+    audio: OptionalNullable[GetPromptVersionMessagesAudio] = UNSET
+    r"""Data about a previous audio response from the model."""
+
+    tool_calls: Optional[List[GetPromptVersionMessagesToolCalls]] = None
+    r"""The tool calls generated by the model, such as function calls."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["content", "refusal", "name", "audio", "tool_calls"])
+        nullable_fields = set(["content", "refusal", "audio"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionMessagesPromptsRole = Literal["user",]
+r"""The role of the messages author, in this case `user`."""
+
+
+GetPromptVersion2PromptsResponse200Type = Literal["file",]
+r"""The type of the content part. Always `file`."""
+
+
+GetPromptVersion2PromptsResponse200ApplicationJSONType = Literal["ephemeral",]
+r"""Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"."""
+
+
+GetPromptVersion2TTL = Literal[
+    "5m",
+    "1h",
+]
+r"""The time-to-live for the cache control breakpoint. This may be one of the following values:
+
+- `5m`: 5 minutes
+- `1h`: 1 hour
+
+Defaults to `5m`. Only supported by `Anthropic` Claude models.
+"""
+
+
+class GetPromptVersion2CacheControlTypedDict(TypedDict):
+    type: GetPromptVersion2PromptsResponse200ApplicationJSONType
+    r"""Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"."""
+    ttl: NotRequired[GetPromptVersion2TTL]
+    r"""The time-to-live for the cache control breakpoint. This may be one of the following values:
+
+    - `5m`: 5 minutes
+    - `1h`: 1 hour
+
+    Defaults to `5m`. Only supported by `Anthropic` Claude models.
+    """
+
+
+class GetPromptVersion2CacheControl(BaseModel):
+    type: GetPromptVersion2PromptsResponse200ApplicationJSONType
+    r"""Create a cache control breakpoint at this content block. Accepts only the value \"ephemeral\"."""
+
+    ttl: Optional[GetPromptVersion2TTL] = "5m"
+    r"""The time-to-live for the cache control breakpoint. This may be one of the following values:
+
+    - `5m`: 5 minutes
+    - `1h`: 1 hour
+
+    Defaults to `5m`. Only supported by `Anthropic` Claude models.
+    """
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["ttl"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class GetPromptVersion24TypedDict(TypedDict):
+    type: GetPromptVersion2PromptsResponse200Type
+    r"""The type of the content part. Always `file`."""
+    file: FileContentPartSchemaTypedDict
+    r"""File data for the content part. Must contain either file_data or uri, but not both."""
+    cache_control: NotRequired[GetPromptVersion2CacheControlTypedDict]
+
+
+class GetPromptVersion24(BaseModel):
+    type: GetPromptVersion2PromptsResponse200Type
+    r"""The type of the content part. Always `file`."""
+
+    file: FileContentPartSchema
+    r"""File data for the content part. Must contain either file_data or uri, but not both."""
+
+    cache_control: Optional[GetPromptVersion2CacheControl] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["cache_control"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionContentPrompts2TypedDict = TypeAliasType(
+    "GetPromptVersionContentPrompts2TypedDict",
+    Union[
+        AudioContentPartSchemaTypedDict,
+        TextContentPartSchemaTypedDict,
+        ImageContentPartSchemaTypedDict,
+        GetPromptVersion24TypedDict,
+    ],
+)
+
+
+GetPromptVersionContentPrompts2 = Annotated[
+    Union[
+        Annotated[TextContentPartSchema, Tag("text")],
+        Annotated[ImageContentPartSchema, Tag("image_url")],
+        Annotated[AudioContentPartSchema, Tag("input_audio")],
+        Annotated[GetPromptVersion24, Tag("file")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "type", "type")),
+]
+
+
+GetPromptVersionMessagesPromptsContentTypedDict = TypeAliasType(
+    "GetPromptVersionMessagesPromptsContentTypedDict",
+    Union[str, List[GetPromptVersionContentPrompts2TypedDict]],
+)
+r"""The contents of the user message."""
+
+
+GetPromptVersionMessagesPromptsContent = TypeAliasType(
+    "GetPromptVersionMessagesPromptsContent",
+    Union[str, List[GetPromptVersionContentPrompts2]],
+)
+r"""The contents of the user message."""
+
+
+class GetPromptVersionMessagesUserMessageTypedDict(TypedDict):
+    role: GetPromptVersionMessagesPromptsRole
+    r"""The role of the messages author, in this case `user`."""
+    content: GetPromptVersionMessagesPromptsContentTypedDict
+    r"""The contents of the user message."""
+    name: NotRequired[str]
+    r"""An optional name for the participant. Provides the model information to differentiate between participants of the same role."""
+
+
+class GetPromptVersionMessagesUserMessage(BaseModel):
+    role: GetPromptVersionMessagesPromptsRole
+    r"""The role of the messages author, in this case `user`."""
+
+    content: GetPromptVersionMessagesPromptsContent
+    r"""The contents of the user message."""
+
+    name: Optional[str] = None
+    r"""An optional name for the participant. Provides the model information to differentiate between participants of the same role."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["name"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionMessagesRole = Literal["system",]
+r"""The role of the messages author, in this case `system`."""
+
+
+GetPromptVersionMessagesContentTypedDict = TypeAliasType(
+    "GetPromptVersionMessagesContentTypedDict",
+    Union[str, List[TextContentPartSchemaTypedDict]],
+)
+r"""The contents of the system message."""
+
+
+GetPromptVersionMessagesContent = TypeAliasType(
+    "GetPromptVersionMessagesContent", Union[str, List[TextContentPartSchema]]
+)
+r"""The contents of the system message."""
+
+
+class GetPromptVersionMessagesSystemMessageTypedDict(TypedDict):
+    r"""Developer-provided instructions that the model should follow, regardless of messages sent by the user."""
+
+    role: GetPromptVersionMessagesRole
+    r"""The role of the messages author, in this case `system`."""
+    content: GetPromptVersionMessagesContentTypedDict
+    r"""The contents of the system message."""
+    name: NotRequired[str]
+    r"""An optional name for the participant. Provides the model information to differentiate between participants of the same role."""
+
+
+class GetPromptVersionMessagesSystemMessage(BaseModel):
+    r"""Developer-provided instructions that the model should follow, regardless of messages sent by the user."""
+
+    role: GetPromptVersionMessagesRole
+    r"""The role of the messages author, in this case `system`."""
+
+    content: GetPromptVersionMessagesContent
+    r"""The contents of the system message."""
+
+    name: Optional[str] = None
+    r"""An optional name for the participant. Provides the model information to differentiate between participants of the same role."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["name"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionPromptsMessagesTypedDict = TypeAliasType(
+    "GetPromptVersionPromptsMessagesTypedDict",
+    Union[
+        GetPromptVersionMessagesSystemMessageTypedDict,
+        GetPromptVersionMessagesUserMessageTypedDict,
+        GetPromptVersionMessagesToolMessageTypedDict,
+        GetPromptVersionMessagesAssistantMessageTypedDict,
+    ],
+)
+
+
+GetPromptVersionPromptsMessages = Annotated[
+    Union[
+        Annotated[GetPromptVersionMessagesSystemMessage, Tag("system")],
+        Annotated[GetPromptVersionMessagesUserMessage, Tag("user")],
+        Annotated[GetPromptVersionMessagesAssistantMessage, Tag("assistant")],
+        Annotated[GetPromptVersionMessagesToolMessage, Tag("tool")],
+    ],
+    Discriminator(lambda m: get_discriminator(m, "role", "role")),
+]
+
+
+class GetPromptVersionPromptFieldTypedDict(TypedDict):
+    r"""Prompt configuration with model and messages. Use this instead of prompt_config."""
+
+    audio: NotRequired[Nullable[GetPromptVersionAudioTypedDict]]
+    r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
+    frequency_penalty: NotRequired[Nullable[float]]
+    r"""Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."""
+    max_tokens: NotRequired[Nullable[int]]
+    r"""`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.
+
+    This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
+    """
+    max_completion_tokens: NotRequired[Nullable[int]]
+    r"""An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens"""
+    logprobs: NotRequired[Nullable[bool]]
+    r"""Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message."""
+    top_logprobs: NotRequired[Nullable[int]]
+    r"""An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used."""
+    n: NotRequired[Nullable[int]]
+    r"""How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs."""
+    presence_penalty: NotRequired[Nullable[float]]
+    r"""Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics."""
+    response_format: NotRequired[GetPromptVersionResponseFormatTypedDict]
+    r"""An object specifying the format that the model must output"""
+    reasoning_effort: NotRequired[GetPromptVersionReasoningEffort]
+    r"""Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+
+    - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
+    - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
+    - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
+    - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
+
+    Any of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\".
+    """
+    verbosity: NotRequired[str]
+    r"""Adjusts response verbosity. Lower levels yield shorter answers."""
+    seed: NotRequired[Nullable[float]]
+    r"""If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result."""
+    stop: NotRequired[Nullable[GetPromptVersionStopTypedDict]]
+    r"""Up to 4 sequences where the API will stop generating further tokens."""
+    stream_options: NotRequired[Nullable[GetPromptVersionStreamOptionsTypedDict]]
+    r"""Options for streaming response. Only set this when you set stream: true."""
+    thinking: NotRequired[GetPromptVersionThinkingTypedDict]
+    temperature: NotRequired[Nullable[float]]
+    r"""What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."""
+    top_p: NotRequired[Nullable[float]]
+    r"""An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass."""
+    top_k: NotRequired[Nullable[float]]
+    r"""Limits the model to consider only the top k most likely tokens at each step."""
+    tool_choice: NotRequired[GetPromptVersionToolChoiceTypedDict]
+    r"""Controls which (if any) tool is called by the model."""
+    parallel_tool_calls: NotRequired[bool]
+    r"""Whether to enable parallel function calling during tool use."""
+    modalities: NotRequired[Nullable[List[GetPromptVersionModalities]]]
+    r"""Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]."""
+    guardrails: NotRequired[List[GetPromptVersionGuardrailsTypedDict]]
+    r"""A list of guardrails to apply to the request."""
+    fallbacks: NotRequired[List[GetPromptVersionFallbacksTypedDict]]
+    r"""Array of fallback models to use if primary model fails"""
+    retry: NotRequired[GetPromptVersionRetryTypedDict]
+    r"""Retry configuration for the request"""
+    cache: NotRequired[GetPromptVersionCacheTypedDict]
+    r"""Cache configuration for the request."""
+    load_balancer: NotRequired[GetPromptVersionLoadBalancerTypedDict]
+    r"""Load balancer configuration for the request."""
+    timeout: NotRequired[GetPromptVersionTimeoutTypedDict]
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
+    messages: NotRequired[List[GetPromptVersionPromptsMessagesTypedDict]]
+    r"""Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content."""
+    model: NotRequired[Nullable[str]]
+    r"""Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`."""
+    version: NotRequired[str]
+
+
+class GetPromptVersionPromptField(BaseModel):
+    r"""Prompt configuration with model and messages. Use this instead of prompt_config."""
+
+    audio: OptionalNullable[GetPromptVersionAudio] = UNSET
+    r"""Parameters for audio output. Required when audio output is requested with modalities: [\"audio\"]. Learn more."""
+
+    frequency_penalty: OptionalNullable[float] = UNSET
+    r"""Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."""
+
+    max_tokens: OptionalNullable[int] = UNSET
+    r"""`[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.
+
+    This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
+    """
+
+    max_completion_tokens: OptionalNullable[int] = UNSET
+    r"""An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens"""
+
+    logprobs: OptionalNullable[bool] = UNSET
+    r"""Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message."""
+
+    top_logprobs: OptionalNullable[int] = UNSET
+    r"""An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used."""
+
+    n: OptionalNullable[int] = UNSET
+    r"""How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs."""
+
+    presence_penalty: OptionalNullable[float] = UNSET
+    r"""Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics."""
+
+    response_format: Optional[GetPromptVersionResponseFormat] = None
+    r"""An object specifying the format that the model must output"""
+
+    reasoning_effort: Optional[GetPromptVersionReasoningEffort] = None
+    r"""Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
+
+    - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
+    - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
+    - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
+    - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
+
+    Any of \"none\", \"minimal\", \"low\", \"medium\", \"high\", \"xhigh\".
+    """
+
+    verbosity: Optional[str] = None
+    r"""Adjusts response verbosity. Lower levels yield shorter answers."""
+
+    seed: OptionalNullable[float] = UNSET
+    r"""If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result."""
+
+    stop: OptionalNullable[GetPromptVersionStop] = UNSET
+    r"""Up to 4 sequences where the API will stop generating further tokens."""
+
+    stream_options: OptionalNullable[GetPromptVersionStreamOptions] = UNSET
+    r"""Options for streaming response. Only set this when you set stream: true."""
+
+    thinking: Optional[GetPromptVersionThinking] = None
+
+    temperature: OptionalNullable[float] = UNSET
+    r"""What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."""
+
+    top_p: OptionalNullable[float] = UNSET
+    r"""An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass."""
+
+    top_k: OptionalNullable[float] = UNSET
+    r"""Limits the model to consider only the top k most likely tokens at each step."""
+
+    tool_choice: Optional[GetPromptVersionToolChoice] = None
+    r"""Controls which (if any) tool is called by the model."""
+
+    parallel_tool_calls: Optional[bool] = None
+    r"""Whether to enable parallel function calling during tool use."""
+
+    modalities: OptionalNullable[List[GetPromptVersionModalities]] = UNSET
+    r"""Output types that you would like the model to generate. Most models are capable of generating text, which is the default: [\"text\"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: [\"text\", \"audio\"]."""
+
+    guardrails: Optional[List[GetPromptVersionGuardrails]] = None
+    r"""A list of guardrails to apply to the request."""
+
+    fallbacks: Optional[List[GetPromptVersionFallbacks]] = None
+    r"""Array of fallback models to use if primary model fails"""
+
+    retry: Optional[GetPromptVersionRetry] = None
+    r"""Retry configuration for the request"""
+
+    cache: Optional[GetPromptVersionCache] = None
+    r"""Cache configuration for the request."""
+
+    load_balancer: Optional[GetPromptVersionLoadBalancer] = None
+    r"""Load balancer configuration for the request."""
+
+    timeout: Optional[GetPromptVersionTimeout] = None
+    r"""Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured."""
+
+    messages: Optional[List[GetPromptVersionPromptsMessages]] = None
+    r"""Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content."""
+
+    model: OptionalNullable[str] = UNSET
+    r"""Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`."""
+
+    version: Optional[str] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "audio",
+                "frequency_penalty",
+                "max_tokens",
+                "max_completion_tokens",
+                "logprobs",
+                "top_logprobs",
+                "n",
+                "presence_penalty",
+                "response_format",
+                "reasoning_effort",
+                "verbosity",
+                "seed",
+                "stop",
+                "stream_options",
+                "thinking",
+                "temperature",
+                "top_p",
+                "top_k",
+                "tool_choice",
+                "parallel_tool_calls",
+                "modalities",
+                "guardrails",
+                "fallbacks",
+                "retry",
+                "cache",
+                "load_balancer",
+                "timeout",
+                "messages",
+                "model",
+                "version",
+            ]
+        )
+        nullable_fields = set(
+            [
+                "audio",
+                "frequency_penalty",
+                "max_tokens",
+                "max_completion_tokens",
+                "logprobs",
+                "top_logprobs",
+                "n",
+                "presence_penalty",
+                "seed",
+                "stop",
+                "stream_options",
+                "temperature",
+                "top_p",
+                "top_k",
+                "modalities",
+                "model",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+GetPromptVersionUseCases = Literal[
+    "Agents simulations",
+    "Agents",
+    "API interaction",
+    "Autonomous Agents",
+    "Chatbots",
+    "Classification",
+    "Code understanding",
+    "Code writing",
+    "Conversation",
+    "Documents QA",
+    "Evaluation",
+    "Extraction",
+    "Multi-modal",
+    "Self-checking",
+    "Sentiment analysis",
+    "SQL",
+    "Summarization",
+    "Tagging",
+    "Translation (document)",
+    "Translation (sentences)",
+]
+
+
+GetPromptVersionLanguage = Literal[
+    "Chinese",
+    "Dutch",
+    "English",
+    "French",
+    "German",
+    "Russian",
+    "Spanish",
+]
+r"""The language that the prompt is written in. Use this field to categorize the prompt for your own purpose"""
+
+
+class GetPromptVersionMetadataTypedDict(TypedDict):
+    use_cases: NotRequired[List[GetPromptVersionUseCases]]
+    r"""A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose"""
+    language: NotRequired[Nullable[GetPromptVersionLanguage]]
+    r"""The language that the prompt is written in. Use this field to categorize the prompt for your own purpose"""
+
+
+class GetPromptVersionMetadata(BaseModel):
+    use_cases: Optional[List[GetPromptVersionUseCases]] = None
+    r"""A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose"""
+
+    language: OptionalNullable[GetPromptVersionLanguage] = UNSET
+    r"""The language that the prompt is written in. Use this field to categorize the prompt for your own purpose"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["use_cases", "language"])
+        nullable_fields = set(["language"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m
+
+
+class GetPromptVersionResponseBodyTypedDict(TypedDict):
+    r"""Prompt version retrieved successfully."""
+
+    id: str
+    prompt: GetPromptVersionPromptFieldTypedDict
+    r"""Prompt configuration with model and messages. Use this instead of prompt_config."""
+    timestamp: str
+    created_by_id: NotRequired[Nullable[str]]
+    updated_by_id: NotRequired[Nullable[str]]
+    description: NotRequired[Nullable[str]]
+    r"""The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose"""
+    prompt_config: NotRequired[GetPromptVersionPromptConfigTypedDict]
+    r"""[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema."""
+    metadata: NotRequired[GetPromptVersionMetadataTypedDict]
+
+
+class GetPromptVersionResponseBody(BaseModel):
+    r"""Prompt version retrieved successfully."""
+
+    id: Annotated[str, pydantic.Field(alias="_id")]
+
+    prompt: GetPromptVersionPromptField
+    r"""Prompt configuration with model and messages. Use this instead of prompt_config."""
+
+    timestamp: str
+
+    created_by_id: OptionalNullable[str] = UNSET
+
+    updated_by_id: OptionalNullable[str] = UNSET
+
+    description: OptionalNullable[str] = UNSET
+    r"""The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose"""
+
+    prompt_config: Annotated[
+        Optional[GetPromptVersionPromptConfig],
+        pydantic.Field(
+            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
+        ),
+    ] = None
+    r"""[DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema."""
+
+    metadata: Optional[GetPromptVersionMetadata] = None
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "created_by_id",
+                "updated_by_id",
+                "description",
+                "prompt_config",
+                "metadata",
+            ]
+        )
+        nullable_fields = set(["created_by_id", "updated_by_id", "description"])
+        serialized = handler(self)
         m = {}
 
         for n, f in type(self).model_fields.items():
             k = f.alias or n
             val = serialized.get(k)
-            serialized.pop(k, None)
-
-            optional_nullable = k in optional_fields and k in nullable_fields
-            is_set = (
-                self.__pydantic_fields_set__.intersection({n})
-                or k in null_default_fields
-            )  # pylint: disable=no-member
-
-            if val is not None and val != UNSET_SENTINEL:
-                m[k] = val
-            elif val != UNSET_SENTINEL and (
-                not k in optional_fields or (optional_nullable and is_set)
-            ):
-                m[k] = val
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
 
         return m