add embedding brick in TOC & fix sphinx warnings

Unstructured-IO · Oct 4, 2023 · 12eac85 · 12eac85
1 parent c39be92
commit 12eac85
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/docs/source/bricks.rst b/docs/source/bricks.rst
@@ -19,3 +19,4 @@ After reading this section, you should understand the following:
    bricks/extracting
    bricks/staging
    bricks/chunking
+   bricks/embedding
diff --git a/docs/source/bricks/embedding.rst b/docs/source/bricks/embedding.rst
@@ -1,21 +1,21 @@
-########
+#########
 Embedding
-########
+#########
 
 EmbeddingEncoder classes in ``unstructured`` use document elements detected
 with ``partition`` or document elements grouped with ``chunking`` to obtain
 embeddings for each element, for uses cases such as Retrieval Augmented Generation (RAG).
 
 
-``BaseEmbeddingEncoder``
-------------------
+BaseEmbeddingEncoder
+--------------------
 
 The ``BaseEmbeddingEncoder`` is an abstract base class that defines the methods to be implemented
 for each ``EmbeddingEncoder`` subclass.
 
 
-``OpenAIEmbeddingEncoder``
-------------------
+OpenAIEmbeddingEncoder
+----------------------
 
 The ``OpenAIEmbeddingEncoder`` class uses langchain OpenAI integration under the hood
 to connect to the OpenAI Text&Embedding API to obtain embeddings for pieces of text.

diff --git a/docs/source/destination_connectors/azure_cognitive_search.rst b/docs/source/destination_connectors/azure_cognitive_search.rst
@@ -1,5 +1,6 @@
 Azure Cognitive Search
-==========
+======================
+
 Batch process all your records using ``unstructured-ingest`` to store structured outputs locally on your filesystem and upload those local files to an Azure Cognitive Search index.
 
 First you'll need to install the azure cognitive search dependencies as shown here.
@@ -72,7 +73,8 @@ For a full list of the options the CLI accepts check ``unstructured-ingest <upst
 NOTE: Keep in mind that you will need to have all the appropriate extras and dependencies for the file types of the documents contained in your data storage platform if you're running this locally. You can find more information about this in the `installation guide <https://unstructured-io.github.io/unstructured/installing.html>`_.
 
 Sample Index Schema
------------
+-------------------
+
 To make sure the schema of the index matches the data being written to it, a sample schema json can be used:
 
 .. literalinclude:: azure_cognitive_sample_index_schema.json