Skip to content

Commit af966cc

Browse files
committed
Doc update
1 parent fcc99e0 commit af966cc

File tree

3 files changed

+35
-0
lines changed

3 files changed

+35
-0
lines changed

docs/source/api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,13 @@ Text2CypherRetriever
214214
:members: search
215215

216216

217+
ToolsRetriever
218+
==============
219+
220+
.. autoclass:: neo4j_graphrag.retrievers.ToolsRetriever
221+
:members: search
222+
223+
217224
*******************
218225
External Retrievers
219226
*******************

docs/source/types.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,30 @@ LLMMessage
3232
===========
3333

3434
.. autoclass:: neo4j_graphrag.types.LLMMessage
35+
:members:
36+
:undoc-members:
37+
38+
Tool
39+
====
40+
41+
.. autoclass:: neo4j_graphrag.tool.Tool
42+
43+
44+
ToolParameter
45+
=============
46+
47+
.. autoclass:: neo4j_graphrag.tool.ToolParameter
48+
49+
50+
ObjectParameter
51+
===============
52+
53+
.. autoclass:: neo4j_graphrag.tool.ObjectParameter
54+
55+
ParameterType
56+
=============
57+
58+
.. autoenum:: neo4j_graphrag.tool.ParameterType
3559

3660

3761
RagResultModel

docs/source/user_guide_rag.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,10 @@ Its interface is compatible with our `GraphRAG` interface, facilitating integrat
253253
254254
It is however not mandatory to use LangChain.
255255

256+
.. warning:: ToolsRetriever
257+
258+
LangChain models are not compatible with the :ref:`toolsretriever`.
259+
256260
Using a Custom Model
257261
--------------------
258262

0 commit comments

Comments
 (0)