Merge pull request #37 from phospho-app/nico/update-autodoc

Updates doc and URL
phospho-app · Jan 8, 2024 · 5a93536 · 5a93536
2 parents eae4bad + f765fe0
commit 5a93536
Show file tree

Hide file tree

Showing 13 changed files with 613 additions and 203 deletions.
diff --git a/docs/source/apidocs/phospho/phospho.client.md b/docs/source/apidocs/phospho/phospho.client.md
@@ -93,7 +93,7 @@
 
 ````
 
-````{py:method} compare(context_input: str, old_output: str, new_output: str) -> phospho.evals.Comparison
+````{py:method} compare(context_input: str, old_output: str, new_output: str, test_id: typing.Optional[str] = None) -> phospho.models.Comparison
 :canonical: phospho.client.Client.compare
 
 ```{autodoc2-docstring} phospho.client.Client.compare
@@ -109,4 +109,20 @@
 
 ````
 
+````{py:method} create_test(summary: typing.Optional[dict] = None) -> phospho.models.Test
+:canonical: phospho.client.Client.create_test
+
+```{autodoc2-docstring} phospho.client.Client.create_test
+```
+
+````
+
+````{py:method} update_test(test_id: str, status: typing.Literal[completed, canceled]) -> phospho.models.Test
+:canonical: phospho.client.Client.update_test
+
+```{autodoc2-docstring} phospho.client.Client.update_test
+```
+
+````
+
 `````
diff --git a/docs/source/apidocs/phospho/phospho.evals.md b/docs/source/apidocs/phospho/phospho.evals.md
diff --git a/docs/source/apidocs/phospho/phospho.extractor.md b/docs/source/apidocs/phospho/phospho.extractor.md
@@ -92,7 +92,7 @@
 ```
 ````
 
-````{py:function} get_input_output(input: typing.Union[phospho.extractor.RawDataType, str], output: typing.Optional[typing.Union[phospho.extractor.RawDataType, str]] = None, raw_input: typing.Optional[phospho.extractor.RawDataType] = None, raw_output: typing.Optional[phospho.extractor.RawDataType] = None, input_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None, output_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None) -> typing.Tuple[str, typing.Optional[str], typing.Optional[typing.Union[typing.Dict[str, object], str]], typing.Optional[typing.Union[typing.Dict[str, object], str]], typing.Optional[str], typing.Optional[bool]]
+````{py:function} get_input_output(input: typing.Union[phospho.extractor.RawDataType, str], output: typing.Optional[typing.Union[phospho.extractor.RawDataType, str]] = None, raw_input: typing.Optional[phospho.extractor.RawDataType] = None, raw_output: typing.Optional[phospho.extractor.RawDataType] = None, input_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None, output_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None) -> typing.Tuple[str, typing.Optional[str], typing.Optional[typing.Union[typing.Dict[str, object], str]], typing.Optional[typing.Union[typing.Dict[str, object], str]]]
 :canonical: phospho.extractor.get_input_output
 
 ```{autodoc2-docstring} phospho.extractor.get_input_output

diff --git a/docs/source/apidocs/phospho/phospho.integrations.md b/docs/source/apidocs/phospho/phospho.integrations.md
@@ -0,0 +1,8 @@
+# {py:mod}`phospho.integrations`
+
+```{py:module} phospho.integrations
+```
+
+```{autodoc2-docstring} phospho.integrations
+:allowtitles:
+```
diff --git a/docs/source/apidocs/phospho/phospho.md b/docs/source/apidocs/phospho/phospho.md
@@ -18,10 +18,11 @@ phospho.tasks
 phospho.config
 phospho.models
 phospho.client
-phospho.evals
 phospho.extractor
 phospho.utils
 phospho.collection
+phospho.testing
+phospho.integrations
 ```
 
 ## Package Contents
@@ -107,7 +108,7 @@ phospho.collection
 ````{py:data} __all__
 :canonical: phospho.__all__
 :value: >
-   ['Client', 'Consumer', 'LogQueue', 'Event', 'generate_timestamp', 'generate_uuid', 'convert_to_jsona...
+   ['Client', 'Consumer', 'LogQueue', 'Event', 'generate_timestamp', 'generate_uuid', 'filter_nonjsonab...
 
 ```{autodoc2-docstring} phospho.__all__
 ```
@@ -199,7 +200,7 @@ phospho.collection
 ```
 ````
 
-````{py:function} log(input: typing.Union[phospho.extractor.RawDataType, str], output: typing.Optional[typing.Union[phospho.extractor.RawDataType, str, typing.Iterable[phospho.extractor.RawDataType]]] = None, session_id: typing.Optional[str] = None, task_id: typing.Optional[str] = None, raw_input: typing.Optional[phospho.extractor.RawDataType] = None, raw_output: typing.Optional[phospho.extractor.RawDataType] = None, input_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None, output_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None, output_to_task_id_and_to_log_function: typing.Optional[typing.Callable[[typing.Any], typing.Tuple[typing.Optional[str], bool]]] = None, concatenate_raw_outputs_if_task_id_exists: bool = True, stream: bool = False, **kwargs: typing.Dict[str, typing.Any]) -> typing.Dict[str, object]
+````{py:function} log(input: typing.Union[phospho.extractor.RawDataType, str], output: typing.Optional[typing.Union[phospho.extractor.RawDataType, str, typing.Iterable[phospho.extractor.RawDataType]]] = None, session_id: typing.Optional[str] = None, task_id: typing.Optional[str] = None, raw_input: typing.Optional[phospho.extractor.RawDataType] = None, raw_output: typing.Optional[phospho.extractor.RawDataType] = None, input_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None, output_to_str_function: typing.Optional[typing.Callable[[typing.Any], str]] = None, concatenate_raw_outputs_if_task_id_exists: bool = True, stream: bool = False, **kwargs: typing.Dict[str, typing.Any]) -> typing.Optional[typing.Dict[str, object]]
 :canonical: phospho.log
 
 ```{autodoc2-docstring} phospho.log