langchain/libs/community/langchain_community
Lucas Tucker e25a5966b5
docs: Standardize DocumentLoader docstrings (#22932)
**Standardizing DocumentLoader docstrings (of which there are many)**

This PR addresses issue #22866 and adds docstrings according to the
issue's specified format (in the appendix) for files csv_loader.py and
json_loader.py in langchain_community.document_loaders. In particular,
the following sections have been added to both CSVLoader and JSONLoader:
Setup, Instantiate, Load, Async load, and Lazy load. It may be worth
adding a 'Metadata' section to the JSONLoader docstring to clarify how
we want to extract the JSON metadata (using the `metadata_func`
argument). The files I used to walkthrough the various sections were
`example_2.json` from
[HERE](https://support.oneskyapp.com/hc/en-us/articles/208047697-JSON-sample-files)
and `hw_200.csv` from
[HERE](https://people.sc.fsu.edu/~jburkardt/data/csv/csv.html).

---------

Co-authored-by: lucast2021 <lucast2021@headroyce.org>
Co-authored-by: isaac hershenson <ihershenson@hmc.edu>
2024-06-18 03:26:36 +00:00
..
adapters community[patch]: upgrade to recent version of mypy (#21616) 2024-05-13 14:55:07 -04:00
agent_toolkits community[patch]: Update root_validators embeddings: llamacpp, jina, dashscope, mosaicml, huggingface_hub, Toolkits: Connery, ChatModels: PAI_EAS, (#22828) 2024-06-12 13:59:05 -04:00
agents community: update how OpenAIAssistantV2Runnable creates threads with tool_resources (#22549) 2024-06-05 14:19:41 -04:00
callbacks community[patch]: Add missing type annotations (#22758) 2024-06-10 16:59:28 -04:00
chains community[patch]: Add missing type annotations (#22758) 2024-06-10 16:59:28 -04:00
chat_loaders infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
chat_message_histories community[minor]: Add native async support to SQLChatMessageHistory (#22065) 2024-06-05 15:10:38 +00:00
chat_models community[minor]: add tool calling for DeepInfraChat (#22745) 2024-06-17 15:21:49 -04:00
cross_encoders [Community]: HuggingFaceCrossEncoder score accounting for <not-relevant score,relevant score> pairs. (#22578) 2024-06-14 08:28:24 -07:00
docstore community[patch]: Fix remaining __inits__ in community (#22037) 2024-05-22 17:42:17 +00:00
document_compressors community[minor]: add Volcengine Rerank (#22700) 2024-06-10 13:41:05 -07:00
document_loaders docs: Standardize DocumentLoader docstrings (#22932) 2024-06-18 03:26:36 +00:00
document_transformers community[minor]: Fix long_context_reorder.py async (#22839) 2024-06-14 13:55:18 -04:00
embeddings community: OCI GenAI embedding batch size (#22986) 2024-06-17 22:06:45 +00:00
example_selectors docs: added community modules descriptions (#17827) 2024-02-21 16:18:36 -08:00
graphs infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
indexes community[patch]: upgrade to recent version of mypy (#21616) 2024-05-13 14:55:07 -04:00
llms Update ollama.py with optional raw setting. (#21486) 2024-06-14 17:19:26 -07:00
memory community[minor]: Add Zep Cloud components + docs + examples (#21671) 2024-05-27 12:50:13 -07:00
output_parsers infra: rm unused # noqa violations (#22049) 2024-05-22 15:21:08 -07:00
query_constructors multiple: langchain 0.2 in master (#21191) 2024-05-08 16:46:52 -04:00
retrievers ci: Add script to check for pickle usage in community (#22863) 2024-06-13 16:13:15 -04:00
storage community[minor]: fix redis store docstring and streamline initialization code (#22730) 2024-06-11 14:08:05 +00:00
tools [Community]: Fixed DDG DuckDuckGoSearchResults Docstring (#22968) 2024-06-18 03:16:24 +00:00
utilities community: Fix #22975 (Add SSL Verification Option to Requests Class in langchain_community) (#22977) 2024-06-18 03:12:40 +00:00
utils community[patch]: Use Custom Logger Instead of Root Logger in get_user_agent Function (#22691) 2024-06-08 02:33:07 +00:00
vectorstores [Community]: FIxed the DocumentDBVectorSearch _similarity_search_without_score (#22970) 2024-06-17 20:08:42 -07:00
__init__.py community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00
cache.py community: init signature revision for Cassandra LLM cache classes + small maintenance (#17765) 2024-05-16 17:22:24 +00:00
py.typed community[major], core[patch], langchain[patch], experimental[patch]: Create langchain-community (#14463) 2023-12-11 13:53:30 -08:00