pulse-python-sdk 0.0.52__py3-none-any.whl

pulse/types/extract_async_response.py

@@ -0,0 +1,43 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .extract_async_submission_response_status import ExtractAsyncSubmissionResponseStatus
+
+
+class ExtractAsyncResponse(UncheckedBaseModel):
+    """
+    Metadata describing the enqueued asynchronous extraction job.
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Identifier assigned to the asynchronous extraction job.
+    """
+
+    status: ExtractAsyncSubmissionResponseStatus = pydantic.Field()
+    """
+    Initial status reported by the extractor.
+    """
+
+    queued_at: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="queuedAt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Timestamp indicating when the job was accepted.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_async_submission_response_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractAsyncSubmissionResponseStatus = typing.Union[
+    typing.Literal["pending", "processing", "completed", "failed", "canceled"], typing.Any
+]

pulse/types/extract_input.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractInput = typing.Any

pulse/types/extract_json_input.py

@@ -0,0 +1,116 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .extract_json_input_experimental_schema import ExtractJsonInputExperimentalSchema
+from .extract_json_input_schema import ExtractJsonInputSchema
+from .extract_json_input_storage import ExtractJsonInputStorage
+from .extract_json_input_structured_output import ExtractJsonInputStructuredOutput
+
+
+class ExtractJsonInput(UncheckedBaseModel):
+    """
+    Input schema for JSON requests (fileUrl only).
+    """
+
+    file_url: typing_extensions.Annotated[str, FieldMetadata(alias="fileUrl")] = pydantic.Field()
+    """
+    Public or pre-signed URL that Pulse will download and extract.
+    """
+
+    structured_output: typing_extensions.Annotated[
+        typing.Optional[ExtractJsonInputStructuredOutput], FieldMetadata(alias="structuredOutput")
+    ] = pydantic.Field(default=None)
+    """
+    Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+    """
+
+    schema_: typing_extensions.Annotated[typing.Optional[ExtractJsonInputSchema], FieldMetadata(alias="schema")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
+    """
+
+    experimental_schema: typing_extensions.Annotated[
+        typing.Optional[ExtractJsonInputExperimentalSchema], FieldMetadata(alias="experimentalSchema")
+    ] = pydantic.Field(default=None)
+    """
+    (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation.
+    """
+
+    schema_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="schemaPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead.
+    """
+
+    custom_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) Custom instructions that augment the default extraction behaviour.
+    """
+
+    chunking: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`).
+    """
+
+    chunk_size: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="chunkSize")] = pydantic.Field(
+        default=None
+    )
+    """
+    Override for maximum characters per chunk when chunking is enabled.
+    """
+
+    pages: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`.
+    """
+
+    extract_figure: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="extractFigure")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Toggle to enable figure extraction in results.
+    """
+
+    figure_description: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="figureDescription")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Toggle to generate descriptive captions for extracted figures.
+    """
+
+    return_html: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="returnHtml")] = pydantic.Field(
+        default=None
+    )
+    """
+    Whether to include HTML representation alongside markdown in the response.
+    """
+
+    thinking: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    (Deprecated) Enables expanded rationale output for debugging.
+    """
+
+    storage: typing.Optional[ExtractJsonInputStorage] = pydantic.Field(default=None)
+    """
+    Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_json_input_experimental_schema.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractJsonInputExperimentalSchema = typing.Union[typing.Dict[str, typing.Any], str]

pulse/types/extract_json_input_schema.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractJsonInputSchema = typing.Union[typing.Dict[str, typing.Any], str]

pulse/types/extract_json_input_storage.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractJsonInputStorage(UncheckedBaseModel):
+    """
+    Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+    """
+
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record.
+    """
+
+    folder_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="folderName")] = pydantic.Field(
+        default=None
+    )
+    """
+    Target folder name to save the extraction to. Creates the folder if it doesn't exist.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_json_input_structured_output.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractJsonInputStructuredOutput(UncheckedBaseModel):
+    """
+    Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+    """
+
+    schema_: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Any]], FieldMetadata(alias="schema")
+    ] = pydantic.Field(default=None)
+    """
+    JSON schema describing the structured data to extract.
+    """
+
+    schema_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="schemaPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Natural language prompt with additional extraction instructions.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_multipart_input.py

@@ -0,0 +1,111 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .extract_multipart_input_experimental_schema import ExtractMultipartInputExperimentalSchema
+from .extract_multipart_input_schema import ExtractMultipartInputSchema
+from .extract_multipart_input_storage import ExtractMultipartInputStorage
+from .extract_multipart_input_structured_output import ExtractMultipartInputStructuredOutput
+
+
+class ExtractMultipartInput(UncheckedBaseModel):
+    """
+    Input schema for multipart/form-data requests (file upload or fileUrl).
+    """
+
+    structured_output: typing_extensions.Annotated[
+        typing.Optional[ExtractMultipartInputStructuredOutput], FieldMetadata(alias="structuredOutput")
+    ] = pydantic.Field(default=None)
+    """
+    Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+    """
+
+    schema_: typing_extensions.Annotated[
+        typing.Optional[ExtractMultipartInputSchema], FieldMetadata(alias="schema")
+    ] = pydantic.Field(default=None)
+    """
+    (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
+    """
+
+    experimental_schema: typing_extensions.Annotated[
+        typing.Optional[ExtractMultipartInputExperimentalSchema], FieldMetadata(alias="experimentalSchema")
+    ] = pydantic.Field(default=None)
+    """
+    (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation.
+    """
+
+    schema_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="schemaPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead.
+    """
+
+    custom_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) Custom instructions that augment the default extraction behaviour.
+    """
+
+    chunking: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`).
+    """
+
+    chunk_size: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="chunkSize")] = pydantic.Field(
+        default=None
+    )
+    """
+    Override for maximum characters per chunk when chunking is enabled.
+    """
+
+    pages: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`.
+    """
+
+    extract_figure: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="extractFigure")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Toggle to enable figure extraction in results.
+    """
+
+    figure_description: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="figureDescription")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Toggle to generate descriptive captions for extracted figures.
+    """
+
+    return_html: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="returnHtml")] = pydantic.Field(
+        default=None
+    )
+    """
+    Whether to include HTML representation alongside markdown in the response.
+    """
+
+    thinking: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    (Deprecated) Enables expanded rationale output for debugging.
+    """
+
+    storage: typing.Optional[ExtractMultipartInputStorage] = pydantic.Field(default=None)
+    """
+    Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_multipart_input_experimental_schema.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractMultipartInputExperimentalSchema = typing.Union[typing.Dict[str, typing.Any], str]

pulse/types/extract_multipart_input_schema.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractMultipartInputSchema = typing.Union[typing.Dict[str, typing.Any], str]

pulse/types/extract_multipart_input_storage.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractMultipartInputStorage(UncheckedBaseModel):
+    """
+    Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+    """
+
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record.
+    """
+
+    folder_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="folderName")] = pydantic.Field(
+        default=None
+    )
+    """
+    Target folder name to save the extraction to. Creates the folder if it doesn't exist.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_multipart_input_structured_output.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractMultipartInputStructuredOutput(UncheckedBaseModel):
+    """
+    Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+    """
+
+    schema_: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Any]], FieldMetadata(alias="schema")
+    ] = pydantic.Field(default=None)
+    """
+    JSON schema describing the structured data to extract.
+    """
+
+    schema_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="schemaPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Natural language prompt with additional extraction instructions.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_options.py

@@ -0,0 +1,111 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .extract_options_experimental_schema import ExtractOptionsExperimentalSchema
+from .extract_options_schema import ExtractOptionsSchema
+from .extract_options_storage import ExtractOptionsStorage
+from .extract_options_structured_output import ExtractOptionsStructuredOutput
+
+
+class ExtractOptions(UncheckedBaseModel):
+    """
+    Common extraction options shared by synchronous and asynchronous endpoints.
+    """
+
+    structured_output: typing_extensions.Annotated[
+        typing.Optional[ExtractOptionsStructuredOutput], FieldMetadata(alias="structuredOutput")
+    ] = pydantic.Field(default=None)
+    """
+    Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+    """
+
+    schema_: typing_extensions.Annotated[typing.Optional[ExtractOptionsSchema], FieldMetadata(alias="schema")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) JSON schema describing structured data to extract. Use structuredOutput instead. Accepts either a JSON object or a stringified JSON representation.
+    """
+
+    experimental_schema: typing_extensions.Annotated[
+        typing.Optional[ExtractOptionsExperimentalSchema], FieldMetadata(alias="experimentalSchema")
+    ] = pydantic.Field(default=None)
+    """
+    (Deprecated) Experimental schema definition used for feature flagged behaviour. Accepts either a JSON object or a stringified JSON representation.
+    """
+
+    schema_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="schemaPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) Natural language prompt for schema-guided extraction. Use structuredOutput.schemaPrompt instead.
+    """
+
+    custom_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    (Deprecated) Custom instructions that augment the default extraction behaviour.
+    """
+
+    chunking: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Comma-separated list of chunking strategies to apply (for example `semantic,header,page,recursive`).
+    """
+
+    chunk_size: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="chunkSize")] = pydantic.Field(
+        default=None
+    )
+    """
+    Override for maximum characters per chunk when chunking is enabled.
+    """
+
+    pages: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Page range filter supporting segments such as `1-2` or mixed ranges like `1-2,5`.
+    """
+
+    extract_figure: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="extractFigure")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Toggle to enable figure extraction in results.
+    """
+
+    figure_description: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="figureDescription")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Toggle to generate descriptive captions for extracted figures.
+    """
+
+    return_html: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="returnHtml")] = pydantic.Field(
+        default=None
+    )
+    """
+    Whether to include HTML representation alongside markdown in the response.
+    """
+
+    thinking: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    (Deprecated) Enables expanded rationale output for debugging.
+    """
+
+    storage: typing.Optional[ExtractOptionsStorage] = pydantic.Field(default=None)
+    """
+    Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_options_experimental_schema.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractOptionsExperimentalSchema = typing.Union[typing.Dict[str, typing.Any], str]

pulse/types/extract_options_schema.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExtractOptionsSchema = typing.Union[typing.Dict[str, typing.Any], str]

pulse/types/extract_options_storage.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractOptionsStorage(UncheckedBaseModel):
+    """
+    Options for persisting extraction artifacts. When enabled (default), artifacts are saved to storage and a database record is created.
+    """
+
+    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether to persist extraction artifacts. Set to false for temporary extractions with no storage or database record.
+    """
+
+    folder_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="folderName")] = pydantic.Field(
+        default=None
+    )
+    """
+    Target folder name to save the extraction to. Creates the folder if it doesn't exist.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_options_structured_output.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractOptionsStructuredOutput(UncheckedBaseModel):
+    """
+    Recommended method for schema-guided extraction. Contains the schema and optional prompt in a single object.
+    """
+
+    schema_: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Any]], FieldMetadata(alias="schema")
+    ] = pydantic.Field(default=None)
+    """
+    JSON schema describing the structured data to extract.
+    """
+
+    schema_prompt: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="schemaPrompt")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Natural language prompt with additional extraction instructions.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow