Skip to content

docs: Update Ask Akka guide - #535

Merged
patriknw merged 2 commits into
agent-devfrom
wip-ask-akka-patriknw
Jun 11, 2025
Merged

patriknw merged 2 commits into
agent-devfrom
wip-ask-akka-patriknw

Conversation

@patriknw

Copy link
Copy Markdown
Contributor
  • Changed the flow to start with the agent, then add indexing and RAG

@github-actions github-actions Bot added the documentation documentation related label Jun 10, 2025

@autodidaddict autodidaddict left a comment

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.

Love the new guide

--data '{ "userId": "001", "sessionId": "foo", "question":"What are the core components of Akka?"}'
----

it will answer something like

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.

can we clarify it here? Maybe "You should see output similar to the following"? or "The model response will look something like this..."

...
----

This is correct for the Akka libraries, but we want to know about the components in the Akka SDK. We need to give the LLM knowledge about the latest Akka documentation, which is the reason for adding Retrieval-Augmented Generation (RAG) to the agent.

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.

do we want to link away from the docs to a RAG reference, or should we have a list of docs to go read at the end of the guide?

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 think we should be careful with linking away from these guides. Easy to loose focus. Links at the end sounds good.

```
----

it will answer something like

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 "OpenAI will respond with something like..."

patriknw added 2 commits June 10, 2025 17:33
* Changed the flow to start with the agent, then add indexing and RAG
@patriknw
patriknw force-pushed the wip-ask-akka-patriknw branch from 44cec85 to 782fa0d Compare June 10, 2025 15:37

@octonato octonato left a comment

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.

LGTM

@patriknw
patriknw merged commit e2c4e60 into agent-dev Jun 11, 2025
@patriknw
patriknw deleted the wip-ask-akka-patriknw branch June 11, 2025 04:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants