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.

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

docs: concepts for cloud and doc-reorg #2196

Merged
merged 44 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
63d3e33
concepts for cloud
hwchase17 Oct 26, 2024
18a9455
cr
hwchase17 Oct 28, 2024
9e57f23
update
vbarda Oct 28, 2024
d05a884
update
vbarda Oct 28, 2024
197c4c7
update
vbarda Oct 28, 2024
e3d1c32
update
vbarda Oct 28, 2024
d178b85
Apply suggestions from code review
eyurtsev Oct 28, 2024
2a53197
Apply suggestions from code review
eyurtsev Oct 28, 2024
f361209
Apply suggestions from code review
eyurtsev Oct 28, 2024
85b8bee
format API ref
vbarda Oct 29, 2024
eb8e504
docs: add a how-to guide for using remote graph (#2218)
vbarda Oct 29, 2024
9cc9395
docs: update concepts and how-to guide indexes (#2203)
eyurtsev Oct 30, 2024
8eafb10
cr
hwchase17 Oct 30, 2024
c734f44
nit
ccurme Oct 30, 2024
c553a40
add guide
ccurme Oct 30, 2024
5cd5aa8
docs: update platform api ref (#2205)
vbarda Oct 30, 2024
72bf29f
cr
ccurme Oct 30, 2024
d61addc
Merge pull request #2234 from langchain-ai/cc/template_apps
ccurme Oct 30, 2024
62657af
docs: add webhooks to concepts (#2240)
ccurme Oct 30, 2024
8c853f0
docs: update cloud tutorial (#2233)
vbarda Oct 30, 2024
971bdcd
fix link
vbarda Oct 30, 2024
1d441c3
docs: update platform / langgraph server (#2231)
eyurtsev Oct 30, 2024
f4eeadb
docs: update streaming concepts (#2239)
vbarda Oct 30, 2024
da5369f
format
vbarda Oct 30, 2024
14dba26
update links (#2241)
eyurtsev Oct 30, 2024
180a861
Update CLI docs (#2238)
hinthornw Oct 30, 2024
02572f3
fix cli formatting issues (#2243)
eyurtsev Oct 30, 2024
4d8467f
format
vbarda Oct 30, 2024
0b6ef0f
add sdk concept doc, more links (#2244)
eyurtsev Oct 30, 2024
ffc8fc9
merge references (#2245)
eyurtsev Oct 30, 2024
2697898
update some language (#2248)
eyurtsev Oct 30, 2024
a83f880
docs: update cloud streaming guides (#2249)
vbarda Oct 31, 2024
478a86b
update API ref
vbarda Oct 31, 2024
5d3d13f
docs: update remote graph how-to (#2254)
vbarda Oct 31, 2024
6000900
docs: update deployment plans (#2255)
eyurtsev Oct 31, 2024
efce940
typo
vbarda Oct 31, 2024
5037cf7
fix some links (#2257)
eyurtsev Oct 31, 2024
c7303da
docs: fix docker-compose in self-hosted (#2258)
vbarda Oct 31, 2024
e22d387
remove deployment concept (#2259)
eyurtsev Oct 31, 2024
2dccfba
cr
hwchase17 Oct 31, 2024
540a30b
cr
hwchase17 Oct 31, 2024
eb2cbf8
docs: fix more broken links (#2260)
eyurtsev Oct 31, 2024
04d6ad9
docs: boom (#2261)
eyurtsev Oct 31, 2024
c391cb0
Merge branch 'main' into harrison/concepts-cloud
eyurtsev Oct 31, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/docs/cloud/deployment/img/api_page.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/docs/cloud/deployment/img/deploy_filled_out.png
Binary file not shown.
Binary file modified docs/docs/cloud/deployment/img/deployed_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/cloud/deployment/img/deployment_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/docs/cloud/deployment/img/graph_run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 11 additions & 5 deletions docs/docs/cloud/deployment/test_locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,25 @@ Testing locally ensures that there are no errors or conflicts with Python depend

Install the proper packages:

```shell
pip install langgraph-cli
```

Ensure you have an API key, which you can create from the LangSmith UI (Settings > API Keys). This is required to authenticate that you have LangGraph Cloud access. After you have saved the key to a safe place, place the following line in your `.env` file:
=== "pip"
```bash
pip install -U langgraph-cli
```
=== "Homebrew" (macOS only)
```bash
brew install langgraph-cli
```

Ensure you have an API key, which you can create from the [LangSmith UI](https://smith.langchain.com) (Settings > API Keys). This is required to authenticate that you have LangGraph Cloud access. After you have saved the key to a safe place, place the following line in your `.env` file:

```python
LANGCHAIN_API_KEY = *********
```

## Start the API server

Once you have downloaded the CLI, you can run the following command to start the API server for local testing:
Once you have installed the CLI, you can run the following command to start the API server for local testing:

```shell
langgraph up
Expand Down
1 change: 1 addition & 0 deletions docs/docs/cloud/how-tos/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ LangGraph Cloud gives you best in class observability, testing, and hosting serv
Learn how to deploy your app to LangGraph Cloud in these how to guides:

- [How to deploy to LangGraph cloud](../deployment/cloud.md)
- [How to interact with the deployment using RemoteGraph](../../how-tos/use-remote-graph.md)


## Streaming
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/cloud/how-tos/stream_debug.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# How to stream debug events

!!! info "Prerequisites"
* [Streaming](../../concepts/streaming.md)

This guide covers how to stream debug events from your graph (`stream_mode="debug"`). Streaming debug events produces responses containing `type` and `timestamp` keys. Debug events correspond to different steps in the graph's execution, and there are three different types of steps that will get streamed back to you:

- `checkpoint`: These events will get streamed anytime the graph saves its state, which occurs after every super-step. Read more about checkpoints [here](https://langchain-ai.github.io/langgraph/concepts/low_level/#checkpointer)
Expand Down
5 changes: 4 additions & 1 deletion docs/docs/cloud/how-tos/stream_events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# How to stream events

This guide covers how to stream events from your graph (`stream_mode="events"`). Depending on the use case and user experience of your LangGraph application, your application may process event types differently. Read more about events in this [conceptual guide](https://langchain-ai.github.io/langgraph/concepts/low_level/#astream_events-for-streaming-tokens-of-llm-calls).
!!! info "Prerequisites"
* [Streaming](../../concepts/streaming.md#streaming-llm-tokens-and-events-astream_events)

This guide covers how to stream events from your graph (`stream_mode="events"`). Depending on the use case and user experience of your LangGraph application, your application may process event types differently.

## Setup

Expand Down
Loading
Loading