typechat 0.0.4__tar.gz → 0.1.0__tar.gz

{typechat-0.0.4 → typechat-0.1.0}/.gitignore

@@ -1,162 +1,162 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
-node_modules
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+node_modules

{typechat-0.0.4 → typechat-0.1.0}/LICENSE

@@ -1,21 +1,21 @@
-    MIT License
-
-    Copyright (c) Microsoft Corporation.
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

typechat-0.1.0/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.5
+Name: typechat
+Version: 0.1.0
+Summary: TypeChat is a library that makes it easy to build natural language interfaces using types.
+Project-URL: Documentation, https://github.com/microsoft/TypeChat#readme
+Project-URL: Issues, https://github.com/microsoft/TypeChat/issues
+Project-URL: Source, https://github.com/microsoft/TypeChat
+Author: Microsoft Corporation
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic-core>=2.16.3
+Requires-Dist: pydantic>=2.5.2
+Requires-Dist: typing-extensions>=4.10.0
+Provides-Extra: dev
+Requires-Dist: coverage[toml]>=6.5; extra == 'dev'
+Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
+Requires-Dist: pytest<9,>=8.0.2; extra == 'dev'
+Requires-Dist: syrupy>=5.0.0; extra == 'dev'
+Provides-Extra: examples
+Requires-Dist: python-dotenv>=1.0.0; extra == 'examples'
+Requires-Dist: spotipy; extra == 'examples'
+Description-Content-Type: text/markdown
+
+# TypeChat
+
+TypeChat is a library that makes it easy to build natural language interfaces using types.
+
+Building natural language interfaces has traditionally been difficult.
+These apps often relied on complex decision trees to determine intent and collect the required inputs to take action.
+Large language models (LLMs) have made this easier by enabling us to take natural language input from a user and match to intent.
+This has introduced its own challenges, including the need to constrain the model's reply for safety,
+structure responses from the model for further processing, and ensuring that the reply from the model is valid.
+Prompt engineering aims to solve these problems, but comes with a steep learning curve and increased fragility as the prompt increases in size.
+
+TypeChat replaces _prompt engineering_ with _schema engineering_.
+
+Simply define types that represent the intents supported in your natural language application.
+That could be as simple as an interface for categorizing sentiment or more complex examples like types for a shopping cart or music application.
+For example, to add additional intents to a schema, a developer can add additional types into a discriminated union.
+To make schemas hierarchical, a developer can use a "meta-schema" to choose one or more sub-schemas based on user input.
+
+After defining your types, TypeChat takes care of the rest by:
+
+1. Constructing a prompt to the LLM using types.
+2. Validating the LLM response conforms to the schema. If the validation fails, repair the non-conforming output through further language model interaction.
+3. Summarizing succinctly (without use of a LLM) the instance and confirm that it aligns with user intent.
+
+Types are all you need!
+
+## Getting Started
+
+Install TypeChat:
+
+```sh
+pip install typechat
+```
+
+To use TypeChat in an existing backend without an interactive chat loop, follow the
+[non-interactive Python quickstart](../site/src/docs/python/non-interactive.md).
+It includes a [standalone sentiment example](./examples/sentiment/non_interactive.py) and an async function you can call from application code.
+
+You can also develop TypeChat from source, which needs [Python >=3.11](https://www.python.org/downloads/),
+[hatch](https://hatch.pypa.io/1.6/install/), and [Node.js >=24.22.1](https://nodejs.org/en/download):
+
+```sh
+git clone https://github.com/microsoft/TypeChat
+cd TypeChat/python
+hatch shell
+npm ci
+```
+
+To see TypeChat in action, we recommend exploring the
+[TypeChat example projects](https://github.com/microsoft/TypeChat/tree/main/python/examples).
+You can try them on your local machine or in a GitHub Codespace.
+
+To learn more about TypeChat, visit the
+[documentation](https://microsoft.github.io/TypeChat/docs/python/basic-usage/)
+which includes more information on TypeChat and how to get started.
+
+## Reusing model authentication
+
+For keyless Azure OpenAI requests, pass a synchronous or asynchronous bearer-token
+provider to `create_azure_openai_language_model` with `api_key=None`. If your app
+already has a configured asynchronous OpenAI or Azure OpenAI client, use
+`create_openai_language_model_from_client` instead.
+
+Both paths reuse authentication supplied by your application without adding SDK
+dependencies to TypeChat or requiring TypeChat-specific environment-variable names.
+Existing API-key and environment-based calls are unchanged. See the
+[token-provider example](../site/src/docs/python/basic-usage.md#using-a-bearer-token-provider)
+and [configured-client example](../site/src/docs/python/basic-usage.md#reusing-an-already-configured-client)
+for ownership, retry, and error behavior.
+
+All four model factories accept a keyword-only `temperature` option. It defaults
+to `0.0`, preserving existing behavior. Pass `temperature=None` to omit the
+parameter entirely and use the configured client's or service's default, for
+example with reasoning models that reject explicit sampling parameters. This
+does not disable reasoning, change authentication, or select a different API.
+
+## Text and image prompts
+
+Both built-in Chat Completions models and the configured-client adapter accept
+typed text/image parts in `PromptSection.content`. Existing whole-string prompts
+remain supported without migration.
+
+The following example demonstrates both `model.complete` and translator context;
+applications can use either call independently. Supply your own hosted image URL
+and already-base64-encoded image data:
+
+```python
+from typing_extensions import TypedDict
+
+from typechat import (
+    PromptSection,
+    Result,
+    TypeChatJsonTranslator,
+    TypeChatLanguageModel,
+    TypeChatValidator,
+)
+
+
+class ImageDescription(TypedDict):
+    description: str
+
+
+async def inspect_images(
+    model: TypeChatLanguageModel, image_base64: str
+) -> tuple[Result[str], Result[ImageDescription]]:
+    context: list[PromptSection] = [
+        {"role": "user", "content": [
+            {"type": "text", "text": "Use these images as context."},
+            {"type": "image_url", "image_url": {"url": "https://example.com/photo.png"}},
+            {"type": "image_url", "image_url": {
+                "url": f"data:image/png;base64,{image_base64}",
+                "detail": "low",
+            }},
+        ]},
+    ]
+    text = await model.complete(context)
+    translator = TypeChatJsonTranslator(model, TypeChatValidator(ImageDescription), ImageDescription)
+    data = await translator.translate("Describe the images.", prompt_preamble=context)
+    return text, data
+```
+
+The public dictionary types are `TextPromptContent` (`{"type": "text", "text": str}`),
+`ImagePromptContent` (`{"type": "image_url", "image_url": ImageUrl}`), and `ImageUrl`
+with a required nonempty `url: str` and optional `detail: "auto" | "low" | "high"`.
+`PromptContent` is a string or an ordered list of these tagged parts, not a list of
+bare strings. Text works in system, user, and assistant messages; images are
+supported only in user messages. Malformed input produces a content-free `Failure`
+locating the section or part before authentication or dispatch.
+
+`translate` still takes a string request. Its preamble stays before the generated
+schema/request message, and image context is preserved during validation and repair.
+Successful model completions remain text-only. Authentication, HTTP controls, and
+configured-client ownership remain unchanged.
+
+TypeChat only forwards image references: it does not fetch, decode, resize, or
+validate image contents. Supported formats (such as PNG, JPEG, or WebP), URL
+accessibility, image counts, detail support, and size/resolution limits depend on
+your provider and model. No image-processing or provider SDK dependency is added.
+See [text and image usage](../site/src/docs/python/basic-usage.md#text-and-image-prompts)
+for the complete prompt type definitions and limitations.
+
+## Documenting schema fields
+
+Trailing Python comments on directly declared `TypedDict` and dataclass fields become
+documentation in the generated TypeScript schema:
+
+```python
+from typing import Annotated
+from typing_extensions import Doc, TypedDict
+
+class Point(TypedDict):
+    x: int  # X-coordinate
+    y: Annotated[int, Doc("Y-coordinate")]  # Explicit documentation takes precedence.
+```
+
+Explicit `Annotated` documentation, supplied through `Doc` or a string, takes precedence
+over an inline comment, including when that explicit documentation is empty.
+Comments are recognized using Python's tokenizer, so `#` inside a string literal is not
+treated as documentation. For multiline field declarations, put the comment on the final line.
+`# type: ignore` directives, including those with bracketed error codes, are not treated
+as field documentation.
+
+Source inspection is read-only and supports nested class definitions with multiline strings.
+If source is unavailable, such as for dynamically created types or deployments without source files,
+conversion continues using the type annotations
+and explicit documentation without inline comments. If available source cannot be parsed,
+the problem is reported in `TypeScriptSchemaConversionResult.errors` rather than silently
+discarding the comments.
+
+## Accessing failed output
+
+`Failure` retains its existing `message` and can also carry an unvalidated `value: object` and
+`response_text: str | None`. Validators return the rejected input in `value`; translators also retain
+the original model text, including when it is not valid JSON:
+
+```python
+from typechat import Failure
+
+result = await translator.translate(request)
+if isinstance(result, Failure):
+    if result.has_value:
+        rejected = result.value
+        # Validate or repair this value before treating it as the target type.
+    original_response = result.response_text
+```
+
+Check `has_value` before using `value`. It distinguishes unavailable data from a rejected `None`,
+`False`, `0`, or empty string. An unavailable value is represented by an internal missing-value marker,
+not `None`. Custom validators can supply their own payloads using
+`Failure(message, value=rejected, response_text=text)`, and the translator preserves those payloads.
+`Failure(message)` remains valid, and payload fields are omitted from its representation.
+Use `isinstance` with `Success` or `Failure` to distinguish outcomes, not the presence of `value`.
+
+On final failure, automatic repair retains the latest rejected candidate and available response text,
+not a full attempt history. If a repair response cannot be parsed, `value` can come from an earlier
+attempt than `response_text`. An initial network failure has no candidate value. Successful results,
+error messages, and repair limits are unchanged, including Python's existing repair of malformed JSON.
+
+Rejected values and response text may contain sensitive output. Do not log or serialize them blindly.
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
+trademarks or logos is subject to and must follow 
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos are subject to those third-party's policies.