:py:mod:`gmuse._docs.template_extractor`
========================================

.. py:module:: gmuse._docs.template_extractor

.. autodoc2-docstring:: gmuse._docs.template_extractor
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ExtractedTemplate <gmuse._docs.template_extractor.ExtractedTemplate>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.ExtractedTemplate
          :summary:
   * - :py:obj:`ContextInputInfo <gmuse._docs.template_extractor.ContextInputInfo>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.ContextInputInfo
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`get_prompt_version <gmuse._docs.template_extractor.get_prompt_version>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.get_prompt_version
          :summary:
   * - :py:obj:`_extract_template <gmuse._docs.template_extractor._extract_template>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor._extract_template
          :summary:
   * - :py:obj:`extract_system_prompt <gmuse._docs.template_extractor.extract_system_prompt>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.extract_system_prompt
          :summary:
   * - :py:obj:`extract_format_task <gmuse._docs.template_extractor.extract_format_task>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.extract_format_task
          :summary:
   * - :py:obj:`extract_all_templates <gmuse._docs.template_extractor.extract_all_templates>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.extract_all_templates
          :summary:
   * - :py:obj:`get_context_inputs <gmuse._docs.template_extractor.get_context_inputs>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.get_context_inputs
          :summary:
   * - :py:obj:`validate_templates <gmuse._docs.template_extractor.validate_templates>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.validate_templates
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`TemplateGetter <gmuse._docs.template_extractor.TemplateGetter>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.TemplateGetter
          :summary:
   * - :py:obj:`TemplateSpec <gmuse._docs.template_extractor.TemplateSpec>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor.TemplateSpec
          :summary:
   * - :py:obj:`_TEMPLATE_SPECS <gmuse._docs.template_extractor._TEMPLATE_SPECS>`
     - .. autodoc2-docstring:: gmuse._docs.template_extractor._TEMPLATE_SPECS
          :summary:

API
~~~

.. py:class:: ExtractedTemplate
   :canonical: gmuse._docs.template_extractor.ExtractedTemplate

   .. autodoc2-docstring:: gmuse._docs.template_extractor.ExtractedTemplate

   .. py:attribute:: name
      :canonical: gmuse._docs.template_extractor.ExtractedTemplate.name
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse._docs.template_extractor.ExtractedTemplate.name

   .. py:attribute:: content
      :canonical: gmuse._docs.template_extractor.ExtractedTemplate.content
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse._docs.template_extractor.ExtractedTemplate.content

   .. py:attribute:: description
      :canonical: gmuse._docs.template_extractor.ExtractedTemplate.description
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse._docs.template_extractor.ExtractedTemplate.description

.. py:class:: ContextInputInfo
   :canonical: gmuse._docs.template_extractor.ContextInputInfo

   .. autodoc2-docstring:: gmuse._docs.template_extractor.ContextInputInfo

   .. py:attribute:: name
      :canonical: gmuse._docs.template_extractor.ContextInputInfo.name
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse._docs.template_extractor.ContextInputInfo.name

   .. py:attribute:: description
      :canonical: gmuse._docs.template_extractor.ContextInputInfo.description
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse._docs.template_extractor.ContextInputInfo.description

   .. py:attribute:: condition
      :canonical: gmuse._docs.template_extractor.ContextInputInfo.condition
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse._docs.template_extractor.ContextInputInfo.condition

   .. py:attribute:: is_optional
      :canonical: gmuse._docs.template_extractor.ContextInputInfo.is_optional
      :type: bool
      :value: None

      .. autodoc2-docstring:: gmuse._docs.template_extractor.ContextInputInfo.is_optional

.. py:data:: TemplateGetter
   :canonical: gmuse._docs.template_extractor.TemplateGetter
   :value: None

   .. autodoc2-docstring:: gmuse._docs.template_extractor.TemplateGetter

.. py:data:: TemplateSpec
   :canonical: gmuse._docs.template_extractor.TemplateSpec
   :value: None

   .. autodoc2-docstring:: gmuse._docs.template_extractor.TemplateSpec

.. py:data:: _TEMPLATE_SPECS
   :canonical: gmuse._docs.template_extractor._TEMPLATE_SPECS
   :type: dict[str, gmuse._docs.template_extractor.TemplateSpec]
   :value: None

   .. autodoc2-docstring:: gmuse._docs.template_extractor._TEMPLATE_SPECS

.. py:function:: get_prompt_version() -> str
   :canonical: gmuse._docs.template_extractor.get_prompt_version

   .. autodoc2-docstring:: gmuse._docs.template_extractor.get_prompt_version

.. py:function:: _extract_template(name: str) -> gmuse._docs.template_extractor.ExtractedTemplate
   :canonical: gmuse._docs.template_extractor._extract_template

   .. autodoc2-docstring:: gmuse._docs.template_extractor._extract_template

.. py:function:: extract_system_prompt() -> gmuse._docs.template_extractor.ExtractedTemplate
   :canonical: gmuse._docs.template_extractor.extract_system_prompt

   .. autodoc2-docstring:: gmuse._docs.template_extractor.extract_system_prompt

.. py:function:: extract_format_task(format_name: str) -> gmuse._docs.template_extractor.ExtractedTemplate
   :canonical: gmuse._docs.template_extractor.extract_format_task

   .. autodoc2-docstring:: gmuse._docs.template_extractor.extract_format_task

.. py:function:: extract_all_templates() -> dict[str, gmuse._docs.template_extractor.ExtractedTemplate]
   :canonical: gmuse._docs.template_extractor.extract_all_templates

   .. autodoc2-docstring:: gmuse._docs.template_extractor.extract_all_templates

.. py:function:: get_context_inputs() -> list[gmuse._docs.template_extractor.ContextInputInfo]
   :canonical: gmuse._docs.template_extractor.get_context_inputs

   .. autodoc2-docstring:: gmuse._docs.template_extractor.get_context_inputs

.. py:function:: validate_templates() -> None
   :canonical: gmuse._docs.template_extractor.validate_templates

   .. autodoc2-docstring:: gmuse._docs.template_extractor.validate_templates