551 doc updates minor fix (#1648)

* 551 documentation updated. * added StructuredJsonConverter doc * added some new parameters doc * 551 documentation fix --------- Co-authored-by: Mehmet Butgul <[email protected]>
JohnSnowLabs · Dec 3, 2024 · a270f1b · a270f1b
1 parent 5154129
commit a270f1b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/docs/en/licensed_annotator_entries/ContextualEntityFilterer.md b/docs/en/licensed_annotator_entries/ContextualEntityFilterer.md
@@ -186,7 +186,7 @@ val result = nlpPipeline.fit(df).transform(df)
 {%- endcapture -%}
 
 {%- capture model_python_api_link -%}
-[ContextualEntityFilterer](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/ContextualEntityFilterer/index.html)
+[ContextualEntityFilterer](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/contextual_entity_filterer/index.html)
 {%- endcapture -%}
 
 {%- capture model_notebook_link -%}

diff --git a/docs/en/licensed_annotator_entries/ContextualEntityRuler.md b/docs/en/licensed_annotator_entries/ContextualEntityRuler.md
@@ -239,7 +239,10 @@ val result = nlpPipeline.fit(df).transform(df)
 {%- endcapture -%}
 
 {%- capture model_python_api_link -%}
-[ContextualEntityRuler](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/ContextualEntityRuler/index.html)
+
+[ContextualEntityRuler](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/contextual_entity_ruler/index.html)
+
+
 {%- endcapture -%}
 
 {%- capture model_notebook_link -%}

diff --git a/docs/en/licensed_annotator_entries/PretrainedZeroShotNER.md b/docs/en/licensed_annotator_entries/PretrainedZeroShotNER.md
@@ -187,7 +187,9 @@ val result = pipelineModel.transform(data)
 {%- endcapture -%}
 
 {%- capture model_python_api_link -%}
-[PretrainedZeroShotNER](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/ner/PretrainedZeroShotNER/index.html)
+
+[PretrainedZeroShotNER](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/ner/pretrained_zero_shot_ner/index.html)
+
 {%- endcapture -%}
 
 {%- capture model_notebook_link -%}

diff --git a/docs/en/licensed_annotator_entries/StructuredJsonConverter.md b/docs/en/licensed_annotator_entries/StructuredJsonConverter.md
@@ -18,7 +18,10 @@ Parameters:
 - `cleanAnnotations`: Whether to remove annotation columns, by default False.
 - `returnRelationEntities`: Whether to return the entities in the relations or not, by default False.
 - `outputAsStr`:  Whether to output the result as a string or as a structured json, by default True.
-```plaintext
+
+
+```
+
 When set to `True`, the output column will be a string:
 
 |-- column_name: string (nullable = true)
@@ -55,7 +58,11 @@ When set to False, the output column will be a struct with the following schema:
       |    |-- element: map (containsNull = true)
       |        |-- key: string
       |        |-- value: string (valueContainsNull = true)
+
+
 ```
+
+
 - `converterSchema` and `converterSchemaAsStr`: The schema for converting the output of the pipeline into a structured JSON format. Fields in the schema:
   - `document_identifier`: The identifier of the document. This column must be of type `StringType`.
   - `document_text`: The text of the document, typically created by the `DocumentAssembler` annotator.