mirror of
https://github.com/hwchase17/langchain
synced 2024-11-08 07:10:35 +00:00
6c1ba9731d
This PR modifies the API Reference in the following way: 1. Relist standard methods: invoke, ainvoke, batch, abatch, batch_as_completed, abatch_as_completed, stream, astream, astream_events. These are the main entry points for a lot of runnables, so we'll keep them for each runnable. 2. Relist methods from Runnable Serializable: to_json, configurable_fields, configurable_alternatives. 3. Expand the note in the API reference documentation to explain that additional methods are available.
41 lines
1.3 KiB
ReStructuredText
41 lines
1.3 KiB
ReStructuredText
:mod:`{{module}}`.{{objname}}
|
|
{{ underline }}==============
|
|
|
|
.. NOTE:: {{objname}} implements the standard :py:class:`Runnable Interface <langchain_core.runnables.base.Runnable>`. 🏃
|
|
|
|
The :py:class:`Runnable Interface <langchain_core.runnables.base.Runnable>` has additional methods that are available on runnables, such as :py:meth:`with_types <langchain_core.runnables.base.Runnable.with_types>`, :py:meth:`with_retry <langchain_core.runnables.base.Runnable.with_retry>`, :py:meth:`assign <langchain_core.runnables.base.Runnable.assign>`, :py:meth:`bind <langchain_core.runnables.base.Runnable.bind>`, :py:meth:`get_graph <langchain_core.runnables.base.Runnable.get_graph>`, and more.
|
|
|
|
.. currentmodule:: {{ module }}
|
|
|
|
.. autoclass:: {{ objname }}
|
|
|
|
{% block attributes %}
|
|
{% if attributes %}
|
|
.. rubric:: {{ _('Attributes') }}
|
|
|
|
.. autosummary::
|
|
{% for item in attributes %}
|
|
~{{ name }}.{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
{% block methods %}
|
|
{% if methods %}
|
|
.. rubric:: {{ _('Methods') }}
|
|
|
|
.. autosummary::
|
|
{% for item in methods %}
|
|
~{{ name }}.{{ item }}
|
|
{%- endfor %}
|
|
|
|
{% for item in methods %}
|
|
.. automethod:: {{ name }}.{{ item }}
|
|
{%- endfor %}
|
|
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
|
|
.. example_links:: {{ objname }}
|