docs icon indicating copy to clipboard operation
docs copied to clipboard

conversation api typo in image

Open sicoyle opened this issue 6 months ago • 1 comments

URL of the docs page https://docs.dapr.io/developing-applications/building-blocks/conversation/conversation-overview/

How is it currently worded? the image shows the api as ....v1.0-alpha1/conversation/<llm-name>/converse when it should be <llm-provider>.

How should it be worded? ...<llm-provider>

Screenshots

Image

Additional context We reference LLM providers elsewhere, so the api should reflect this as well.

sicoyle avatar Jun 10 '25 21:06 sicoyle

llm-name is also in the API reference:

llm-name - The name of the LLM component.

I suggest we clarify the diagram that llm-name means the name of the llm component.

marcduiker avatar Jun 11 '25 12:06 marcduiker

llm-name is not perfect but it is consistent with how we document the rest of the APIs

/state/<storename>
/publish/<pubsubname>/<topic>
/conversation/<llm-name>/converse

In all of these cases, it is the component name. I suggest we keep it as is unless we want to refactor all places with a consistent terminology accross api such as

<statestore-component>
<pubsub-component>
<conversation-component>

bibryam avatar Sep 11 '25 16:09 bibryam

Closing issue. No change needed.

msfussell avatar Sep 12 '25 18:09 msfussell