Skip to content

Commit

Permalink
Small fixes to doc (neo4j#199)
Browse files Browse the repository at this point in the history
  • Loading branch information
stellasia authored Oct 23, 2024
1 parent fd276af commit c12ed70
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ SinglePropertyExactMatchResolver

.. _pipeline-section:

********
Pipeline
********
*********
Pipelines
*********

Pipeline
========

.. autoclass:: neo4j_graphrag.experimental.pipeline.Pipeline
:members: run, add_component, connect, get_pygraphviz_graph
:members: run, add_component, connect, draw

SimpleKGPipeline
================
Expand Down
2 changes: 1 addition & 1 deletion docs/source/types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ SchemaEntity
SchemaRelation
==============

.. autoclass:: neo4j_graphrag.experimental.components.schema.SchemaEntity
.. autoclass:: neo4j_graphrag.experimental.components.schema.SchemaRelation

SchemaConfig
============
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user_guide_rag.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ It is possible to use Azure OpenAI switching to the `AzureOpenAILLM` class:
)
llm.invoke("say something")
Check the OpenAI Python client [documentation](https://github.com/openai/openai-python?tab=readme-ov-file#microsoft-azure-openai)
Check the OpenAI Python client `documentation <https://github.com/openai/openai-python?tab=readme-ov-file#microsoft-azure-openai>`_.
to learn more about the configuration.

.. note::
Expand Down Expand Up @@ -766,7 +766,7 @@ be provided when instantiating the retriever:
See :ref:`hybridretriever`.

Also note that there is an helper function to create a full-text index (see `the API documentation <create-fulltext-index>`_).
Also note that there is an helper function to create a full-text index (see :ref:`the API documentation<create-fulltext-index>`).

.. _hybrid-cypher-retriever-user-guide:

Expand Down
4 changes: 2 additions & 2 deletions src/neo4j_graphrag/retrievers/external/qdrant/qdrant.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class QdrantNeo4jRetriever(ExternalRetriever):
Example:
.. code-block:: python
.. code-block:: python
from neo4j import GraphDatabase
from neo4j_graphrag.retrievers import QdrantNeo4jRetriever
Expand Down Expand Up @@ -152,7 +152,7 @@ def get_search_results(
Example:
.. code-block:: python
.. code-block:: python
from neo4j import GraphDatabase
from neo4j_graphrag.retrievers import QdrantNeo4jRetriever
Expand Down

0 comments on commit c12ed70

Please sign in to comment.