Skip to content

Update adapters docs#422

Merged
harishmohanraj merged 12 commits into
mainfrom
410-update-adapters-docs
Oct 18, 2024
Merged

Update adapters docs#422
harishmohanraj merged 12 commits into
mainfrom
410-update-adapters-docs

Conversation

@harishmohanraj

@harishmohanraj harishmohanraj commented Oct 17, 2024

Copy link
Copy Markdown
Contributor

Description

Fixes #410

Type of change

  • Documentation (typos, code examples, or any documentation updates)

@harishmohanraj harishmohanraj linked an issue Oct 17, 2024 that may be closed by this pull request
2 tasks
@codecov

codecov Bot commented Oct 17, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
...c/getting_started/nats_n_fastapi/main_2_fastapi.py 87.50% <ø> (ø)

The FastAgency FastAPI App forms the backend of our system and consists of:

- **AutoGen Workflows**: These define the core logic and behavior of our application, utilizing agents to perform various tasks and achieve specific goals.
- **FastAPI Adapter**: This component receives requests from the FastAPI Provider and executes the corresponding AutoGen workflows.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably say something like this:

Communicates with autogen, and implents routes and websocket for FastAPI

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content is updated accordingly

- **FastAPI**: Provides the infrastructure for building and exposing AutoGen workflows via REST API.

### Interaction Flow

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure, but maybe this is too detailed information. Lets see how others feel about it.


The following diagram illustrates the high-level architecture of an application using the **FastAPI Adapter with Mesop UI** as its frontend:

![Mesop FastAPI](../images/mesop_fastapi.png)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe in the diagram, we could beside Mesop draw an "Custom application", so that we show that Mesop client is not mandatory for this setup

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the images and the content to reflect the same

The FastAgency FastAPI App forms the backend of our system and consists of:

- **Nats Provider**: Responsible for connecting to the Nats Provider, receiving workflow initiation messages, and distributing them to the workers for execution.
- **FastAPI Adapter**: This component receives requests from the FastAPI Provider and interacts with the Nats Provider for workflow initiation and result retrieval.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would probably say something like this:

Communicates with NatsProvider, and implents routes and websocket for FastAPI

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content is updated accordingly

The FastAgency Nats App forms the backend of the system and consists of:

- **AutoGen Workflows**: The workflows defined using the AutoGen framework. They are executed by the workers in the Nats Adapter.
- **Nats Adapter**: Responsible for connecting to the Nats Provider, receiving workflow initiation messages, and distributing them to the workers for execution.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Communicates with Autogen, and makes workflow messages available on corresponding Nats topics.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content is updated accordingly

@harishmohanraj harishmohanraj added this pull request to the merge queue Oct 18, 2024
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update adapters docs

2 participants