Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

For New Contributors: Update Integration Documentation #15664

Closed
hwchase17 opened this issue Jan 7, 2024 · 30 comments · Fixed by #17378
Closed

For New Contributors: Update Integration Documentation #15664

hwchase17 opened this issue Jan 7, 2024 · 30 comments · Fixed by #17378
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder good first issue Good for newcomers

Comments

@hwchase17
Copy link
Contributor

Issue you'd like to raise.

Hello LangChain community,

We're always happy to see more folks getting involved in contributing to the LangChain codebase.

This is a good first issue if you want to learn more about how to set up
for development in the LangChain codebase.

Goal

Your contribution will make it easier for users to use integrations with the newest LangChain syntax

Context

As you may have noticed, we’ve recently gone to LangChain 0.1. As part of this, we want to update integration pages to be consistent with new methods. These largely include: (a) new methods for invoking integrations and chains (invoke, stream), (b) new methods for creating chains (LCEL, create_xyz_..).

There are a lot of integrations, so we’d love community help! This is a great way to get started contributing to the library as it will make you familiar with best practices and various integrations.

Set up for development

There are lots of integration notebooks in https://github.com/langchain-ai/langchain/tree/master/docs/docs/integrations. After making changes there, you should run make format from the root LangChain directory to run our formatter.

Shall you accept

Shall you accept this challenge, please claim one (and only one) of the modules from the list
below as one that you will be working on, and respond to this issue.

Once you've made the required code changes, open a PR and link to this issue.

Acceptance Criteria

  • Uses new methods for calling chains (invoke, stream, etc)
  • Uses LCEL where appropriate
  • Follows the format outlined below

Examples

We've gotten started with some examples to show how we imagine these integration pages should look like. The exact format may look different for each type of integration, so make sure to look at the type you are working on:

Your contribution

Please sign up by responding to this issue and including the name of the module.

Suggestion:

No response
@hwchase17 hwchase17 added the good first issue Good for newcomers label Jan 7, 2024
@dosubot DosuBot
Copy link

dosubot bot commented Jan 7, 2024 •
edited

🤖

It's great to see your interest in contributing to LangChain! Updating the integration documentation is a valuable contribution that will benefit the entire community. Your efforts will make it easier for users to utilize integrations with the newest LangChain syntax. Thank you for taking on this challenge, and we look forward to seeing your PR. If you have any questions or need assistance, feel free to ask!

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

@dosubot dosubot bot added Ɑ: models Related to LLMs or chat model modules 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Jan 7, 2024
@sweetkane
Copy link
Contributor

sweetkane commented Jan 7, 2024 •
edited

Claiming aws_dynamodb.ipynb

@sweetkane sweetkane mentioned this issue Jan 7, 2024
Merged
hwchase17 pushed a commit that referenced this issue Jan 8, 2024
@sweetkane
docs: update aws_dynamodb integration doc (#15666)
167a0ac 
- **Description:** 
- Updated the docs for the memory integration module
`aws_dynamodb.ipynb`
  - **Issue:** 
    - #15664 
  - **Dependencies:** 
    - N/A
@DaveDeCaprio
Copy link
Contributor

Claiming memory/mongodb_chat_message_history.ipynb

@DaveDeCaprio
Copy link
Contributor

@hwchase17 memory/sqlite.ipynb uses the ConversationEntityMemory class, which only exists in the langchain package, not one of the new packages. Does that mean it's dropped in 0.1? What should happen with that notebook?

@DaveDeCaprio DaveDeCaprio mentioned this issue Jan 9, 2024
Merged
@marsmxm
Copy link
Contributor

marsmxm commented Jan 10, 2024 •
edited

Claiming memory/redis_chat_message_history.ipynb

@marsmxm marsmxm mentioned this issue Jan 10, 2024
Merged
@OmarAly23
Copy link
Contributor

Claiming memory/streamlit_chat_message_history.ipynb

@baskaryan baskaryan pinned this issue Jan 10, 2024
@baskaryan baskaryan removed the Ɑ: models Related to LLMs or chat model modules label Jan 10, 2024
@bhadreshpsavani
Copy link
Contributor

claiming llms/ai21.ipynb

@Bigtable123
Copy link
Contributor

Bigtable123 commented Jan 11, 2024 •
edited

claiming chat/baidu_qianfan_endpoint.ipynb

@bhadreshpsavani bhadreshpsavani mentioned this issue Jan 11, 2024
Merged
hwchase17 pushed a commit that referenced this issue Jan 12, 2024
@marsmxm
docs: redis_chat_message_history.ipynb integration doc (#15789)
560bb49 
- **Description:** Updated the docs for the memory integration module
redis_chat_message_history.ipynb
  - **Issue:** #15664
  - **Dependencies:** N/A

Co-authored-by: Mu Xianming <mu.xianming@lmwn.com>
@Bigtable123 Bigtable123 mentioned this issue Jan 12, 2024
Merged
@hwchase17
Copy link
Contributor Author

@hwchase17 memory/sqlite.ipynb uses the ConversationEntityMemory class, which only exists in the langchain package, not one of the new packages. Does that mean it's dropped in 0.1? What should happen with that notebook?

we should not use ConversationEntityMemory, and instead update to be more similar to the linked notebook about sql

@hwchase17 hwchase17 mentioned this issue Jan 13, 2024
Merged
@rshah98626
Copy link

Claiming memory/postgres_chat_message_history.ipynb

baskaryan pushed a commit that referenced this issue Jan 15, 2024
@bhadreshpsavani
docs: Integration Documentation updated run to invoke for llms/ai21.i…
6137c76 
…pynb (#15889)

- **Description:** Updated Integration Documentation for
[llms/ai21.ipynb](https://github.com/langchain-ai/langchain/blob/master/docs/docs/integrations/llms/ai21.ipynb)
  - **Issue:** #15664,
  - **Dependencies:** NA,
  - **Twitter handle:** @Bhadreshsavani
baskaryan pushed a commit that referenced this issue Jan 15, 2024
@Bigtable123
docs: update baidu_qianfan_endpoint.ipynb doc (#15940)
7306032 
- **Description:** Updated the docs for the chat integration module
baidu_qianfan_endpoint.ipynb
  - **Issue:**  #15664 
  - **Dependencies:**N/A
@mtmahe
Copy link
Contributor

mtmahe commented Jan 15, 2024

@hwchase17 are they all complete? I don't see the list the OP talks about.

@jzaldi
Copy link
Contributor

jzaldi commented Jan 16, 2024

Claiming llms/google_vertex_ai_palm.ipynb

@DaveDeCaprio
Copy link
Contributor

Claiming memory/sqlite..ipynb

@jzaldi jzaldi mentioned this issue Jan 16, 2024
Merged
@DaveDeCaprio DaveDeCaprio mentioned this issue Jan 16, 2024
Merged
@baskaryan
Copy link
Collaborator

@rshah98626 these are bugs in local docs deployment script, it's gone out of date since we've made a few structural changes to the docs. Opened issue to fix #16677, thank you for flagging!

@rocky1405
Copy link
Contributor

Claiming https://github.com/langchain-ai/langchain/blob/master/docs/docs/integrations/llms/aleph_alpha.ipynb

@rocky1405 rocky1405 mentioned this issue Jan 31, 2024
Merged
@scottnath
Copy link
Contributor

claiming https://python.langchain.com/docs/integrations/retrievers/you

@baskaryan
Copy link
Collaborator

Related issue #16911 for anyone looking to contribute!

baskaryan pushed a commit that referenced this issue Feb 2, 2024
@rocky1405
docs: Updated integration doc for aleph alpha (#16844)
3b0fa90 
Description: Updated doc for llm/aleph_alpha with new functions: invoke.
Changed structure of the document to match the required one.
Issue: #15664
Dependencies: None
Twitter handle: None

---------

Co-authored-by: Radhakrishnan Iyer <radhakrishnan.iyer@ibm.com>
@mtmahe
Copy link
Contributor

mtmahe commented Feb 4, 2024

claiming docs/docs/integrations/chat/mistralai.ipynb

@scottnath scottnath mentioned this issue Feb 4, 2024
Merged
@Mercurrent
Copy link
Contributor

Claiming docs/integrations/chat/bedrock

hoanq1811 pushed a commit to hoanq1811/langchain that referenced this issue Feb 6, 2024
@rocky1405
docs: Updated integration doc for aleph alpha (langchain-ai#16844)
f2b9c99 
Description: Updated doc for llm/aleph_alpha with new functions: invoke.
Changed structure of the document to match the required one.
Issue: langchain-ai#15664
Dependencies: None
Twitter handle: None

---------

Co-authored-by: Radhakrishnan Iyer <radhakrishnan.iyer@ibm.com>
@johneckberg
Copy link

claiming retrievers/pubmed.ipynb

@Naveenkhasyap
Copy link
Contributor

claiming /integration/chat/anthropic_functions

@Naveenkhasyap Naveenkhasyap mentioned this issue Feb 8, 2024
Merged
hwchase17 pushed a commit that referenced this issue Feb 8, 2024
@scottnath @baskaryan
community: Add you.com utility, update you retriever integration docs (…
a32798a 
…#17014)

<!-- Thank you for contributing to LangChain!

Please title your PR "<package>: <description>", where <package> is
whichever of langchain, community, core, experimental, etc. is being
modified.

Replace this entire comment with:
  - **Description:** a description of the change, 
  - **Issue:** the issue # it fixes if applicable,
  - **Dependencies:** any dependencies required for this change,
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!

Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` from the root
of the package you've modified to check this locally.

See contribution guidelines for more information on how to write/run
tests, lint, etc: https://python.langchain.com/docs/contributing/

If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.

If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
 -->

- **Description: changes to you.com files** 
    - general cleanup
- adds community/utilities/you.py, moving bulk of code from retriever ->
utility
    - removes `snippet` as endpoint
    - adds `news` as endpoint
    - adds more tests

<s>**Description: update community MAKE file** 
    - adds `integration_tests`
    - adds `coverage`</s>

- **Issue:** the issue # it fixes if applicable,
- [For New Contributors: Update Integration
Documentation](#15664 (comment))
- **Dependencies:** n/a
- **Twitter handle:** @scottnath
- **Mastodon handle:** scottnath@mastodon.social

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
@jiangzf93
Copy link
Contributor

jiangzf93 commented Feb 11, 2024 •
edited

Claiming docs/integrations/tools/filesystem.ipynb

@jiangzf93 jiangzf93 mentioned this issue Feb 11, 2024
Merged
@PennlaineChu
Copy link
Contributor

Claiming docs/integrations/tools/pubmed.ipynb

@PennlaineChu PennlaineChu mentioned this issue Feb 11, 2024
Merged
hwchase17 pushed a commit that referenced this issue Feb 12, 2024
@PennlaineChu
Updated doc for tools/pubmed with new functions: invoke. (#17378)
2384267 
Updated doc for integrations/chat/anthropic_functions #15664 

  - **Description:**
Adds `pip install` instructions
Update `run` with `invoke`

  - **Issue:** 
Fixes #15664
hwchase17 pushed a commit that referenced this issue Feb 12, 2024
@jiangzf93
docs: update documentation for file system tool integration (#17377)
d6a1c88 
- **Description:** Update the docs for the tool integration module `file
system`
- **Issue:** [For New Contributors: Update Integration Documentation
#15664](#15664 (comment))
  - **Dependencies:** N/A
baskaryan pushed a commit that referenced this issue Feb 13, 2024
@Naveenkhasyap
docs: Updated doc for integrations/chat/anthropic_functions #15664 (#…
841e5f5 
…17226)

Description: Updated doc for integrations/chat/anthropic_functions with
new functions: invoke. Changed structure of the document to match the
required one.
Issue: #15664
Dependencies: None
Twitter handle: None

---------

Co-authored-by: NaveenMaltesh <naveen@onmeta.in>
@baskaryan baskaryan unpinned this issue Feb 14, 2024
snsten pushed a commit to snsten/langchain that referenced this issue Feb 15, 2024
@scottnath @baskaryan
community: Add you.com utility, update you retriever integration docs (…
f259411 
…langchain-ai#17014)

<!-- Thank you for contributing to LangChain!

Please title your PR "<package>: <description>", where <package> is
whichever of langchain, community, core, experimental, etc. is being
modified.

Replace this entire comment with:
  - **Description:** a description of the change, 
  - **Issue:** the issue # it fixes if applicable,
  - **Dependencies:** any dependencies required for this change,
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!

Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` from the root
of the package you've modified to check this locally.

See contribution guidelines for more information on how to write/run
tests, lint, etc: https://python.langchain.com/docs/contributing/

If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.

If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
 -->

- **Description: changes to you.com files** 
    - general cleanup
- adds community/utilities/you.py, moving bulk of code from retriever ->
utility
    - removes `snippet` as endpoint
    - adds `news` as endpoint
    - adds more tests

<s>**Description: update community MAKE file** 
    - adds `integration_tests`
    - adds `coverage`</s>

- **Issue:** the issue # it fixes if applicable,
- [For New Contributors: Update Integration
Documentation](langchain-ai#15664 (comment))
- **Dependencies:** n/a
- **Twitter handle:** @scottnath
- **Mastodon handle:** scottnath@mastodon.social

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
snsten pushed a commit to snsten/langchain that referenced this issue Feb 15, 2024
@PennlaineChu
Updated doc for tools/pubmed with new functions: invoke. (langchain-a…
4a33b22 
…i#17378)

Updated doc for integrations/chat/anthropic_functions langchain-ai#15664 

  - **Description:**
Adds `pip install` instructions
Update `run` with `invoke`

  - **Issue:** 
Fixes langchain-ai#15664
snsten pushed a commit to snsten/langchain that referenced this issue Feb 15, 2024
@jiangzf93
docs: update documentation for file system tool integration (langchai…
2b701c6 
…n-ai#17377)

- **Description:** Update the docs for the tool integration module `file
system`
- **Issue:** [For New Contributors: Update Integration Documentation
langchain-ai#15664](langchain-ai#15664 (comment))
  - **Dependencies:** N/A
snsten pushed a commit to snsten/langchain that referenced this issue Feb 15, 2024
@Naveenkhasyap
docs: Updated doc for integrations/chat/anthropic_functions langchain…
277606a 
…-ai#15664 (langchain-ai#17226)

Description: Updated doc for integrations/chat/anthropic_functions with
new functions: invoke. Changed structure of the document to match the
required one.
Issue: langchain-ai#15664
Dependencies: None
Twitter handle: None

---------

Co-authored-by: NaveenMaltesh <naveen@onmeta.in>
haydeniw pushed a commit to haydeniw/langchain that referenced this issue Feb 27, 2024
@PennlaineChu
Updated doc for tools/pubmed with new functions: invoke. (langchain-a…
24b9013 
…i#17378)

Updated doc for integrations/chat/anthropic_functions langchain-ai#15664 

  - **Description:**
Adds `pip install` instructions
Update `run` with `invoke`

  - **Issue:** 
Fixes langchain-ai#15664
haydeniw pushed a commit to haydeniw/langchain that referenced this issue Feb 27, 2024
@jiangzf93
docs: update documentation for file system tool integration (langchai…
57078b6 
…n-ai#17377)

- **Description:** Update the docs for the tool integration module `file
system`
- **Issue:** [For New Contributors: Update Integration Documentation
langchain-ai#15664](langchain-ai#15664 (comment))
  - **Dependencies:** N/A
haydeniw pushed a commit to haydeniw/langchain that referenced this issue Feb 27, 2024
@Naveenkhasyap
docs: Updated doc for integrations/chat/anthropic_functions langchain…
2c535ec 
…-ai#15664 (langchain-ai#17226)

Description: Updated doc for integrations/chat/anthropic_functions with
new functions: invoke. Changed structure of the document to match the
required one.
Issue: langchain-ai#15664
Dependencies: None
Twitter handle: None

---------

Co-authored-by: NaveenMaltesh <naveen@onmeta.in>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updated doc for tools/pubmed with new functions: invoke. PennlaineChu/langchain