Conversation API support #787

elena-kolevska · 2025-02-24T11:26:49Z

Description

Adds support for the Dapr Conversation API.

I suffixed the converse method name with alpha1. This is open for discussion. We haven't been using the suffix in the python sdk, but we do it in Go. I believe it's safer to have it suffixed, but if we're reasonably certain the API won't break we can just use converse.

Issue reference

#786

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

Code compiles correctly
Created/updated tests
Extended the documentation

codecov · 2025-02-24T11:30:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (release-1.15@ba64f31). Learn more about missing BASE report.

Additional details and impacted files

@@               Coverage Diff               @@
##             release-1.15     #787   +/-   ##
===============================================
  Coverage                ?   86.39%           
===============================================
  Files                   ?       89           
  Lines                   ?     5064           
  Branches                ?        0           
===============================================
  Hits                    ?     4375           
  Misses                  ?      689           
  Partials                ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

elena-kolevska · 2025-02-24T15:28:46Z

README.md

@@ -8,7 +8,9 @@
 [![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/dapr/python-sdk?query=type%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22&label=Good%20first%20issues&style=flat&logo=github)](https://github.com/dapr/python-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 
 [![Discord](https://img.shields.io/discord/778680217417809931?label=Discord&style=flat&logo=discord)](http://bit.ly/dapr-discord) 
 [![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCtpSQ9BLB_3EXdWAUQYwnRA?style=flat&label=YouTube%20views&logo=youtube)](https://youtube.com/@daprdev) 
+<!-- IGNORE_LINKS -->


This is needed because x.com profiles are not public anymore and return 403, making the Mechanical markdown validation fail.

marcduiker

Added two suggestions for the PII scrubbing

dapr/aio/clients/grpc/client.py

dapr/clients/grpc/client.py

Signed-off-by: Elena Kolevska <[email protected]>

Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]>

Signed-off-by: Elena Kolevska <[email protected]>

* Conversation API support (sync) Signed-off-by: Elena Kolevska <[email protected]> * async conversation api support Signed-off-by: Elena Kolevska <[email protected]> * Adds docs Signed-off-by: Elena Kolevska <[email protected]> * Ignore validation of x.com link that needs authentication Signed-off-by: Elena Kolevska <[email protected]> * Registers e2e test. Clean up. Signed-off-by: Elena Kolevska <[email protected]> * Apply suggestions from code review Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Linter Signed-off-by: Elena Kolevska <[email protected]> * Updates protos and renames parameter Signed-off-by: Elena Kolevska <[email protected]> * Improves error handling Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]>

* Conversation API support (sync) Signed-off-by: Elena Kolevska <[email protected]> * async conversation api support Signed-off-by: Elena Kolevska <[email protected]> * Adds docs Signed-off-by: Elena Kolevska <[email protected]> * Ignore validation of x.com link that needs authentication Signed-off-by: Elena Kolevska <[email protected]> * Registers e2e test. Clean up. Signed-off-by: Elena Kolevska <[email protected]> * Apply suggestions from code review Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Linter Signed-off-by: Elena Kolevska <[email protected]> * Updates protos and renames parameter Signed-off-by: Elena Kolevska <[email protected]> * Improves error handling Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> Co-authored-by: Marc Duiker <[email protected]>

* Conversation API support (sync) Signed-off-by: Elena Kolevska <[email protected]> * async conversation api support Signed-off-by: Elena Kolevska <[email protected]> * Adds docs Signed-off-by: Elena Kolevska <[email protected]> * Ignore validation of x.com link that needs authentication Signed-off-by: Elena Kolevska <[email protected]> * Registers e2e test. Clean up. Signed-off-by: Elena Kolevska <[email protected]> * Apply suggestions from code review Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Linter Signed-off-by: Elena Kolevska <[email protected]> * Updates protos and renames parameter Signed-off-by: Elena Kolevska <[email protected]> * Improves error handling Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]>

* Catch error in sdk when workflow instance not found (#771) * Catch error in sdk when workflow instance not found Signed-off-by: Elena Kolevska <[email protected]> * fixes demo workflow example test Signed-off-by: Elena Kolevska <[email protected]> * Only return None for the correct error Signed-off-by: Elena Kolevska <[email protected]> * Adds test Signed-off-by: Elena Kolevska <[email protected]> * Linter Signed-off-by: Elena Kolevska <[email protected]> * Extends test Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> * Fix get_worfklow_state docstring to match fetch_payloads default (#772) Signed-off-by: Adam Stewart <[email protected]> Co-authored-by: Elena Kolevska <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Remove test sleep (#778) Signed-off-by: Elena Kolevska <[email protected]> * Restores sleeps in test, as it was decided not to invest making synchronous the APIs that are getting deleted next version (#781) Signed-off-by: Elena Kolevska <[email protected]> * Updates workflows docs to use the new workflows client (#780) * Updates docs Signed-off-by: Elena Kolevska <[email protected]> * More workflows docs Signed-off-by: Elena Kolevska <[email protected]> * Move workflows examples, based on review Signed-off-by: Elena Kolevska <[email protected]> * Small fixes Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> * Workflow fixes and improvements (#784) * Converts demo_workflow example to DaprWorkflowClient and removes default timeout of 60seconds on `wait_for_workflow_start` and `wait_for_workflow_completion` Signed-off-by: Elena Kolevska <[email protected]> * Bumps durable task library. Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> # Conflicts: # ext/dapr-ext-workflow/setup.cfg * Retry streaming subscription on status UNKNOWN as well (#783) Signed-off-by: Elena Kolevska <[email protected]> * Adds examples and docs for cloud events messages (#785) Signed-off-by: Elena Kolevska <[email protected]> * Conversation API support (#787) * Conversation API support (sync) Signed-off-by: Elena Kolevska <[email protected]> * async conversation api support Signed-off-by: Elena Kolevska <[email protected]> * Adds docs Signed-off-by: Elena Kolevska <[email protected]> * Ignore validation of x.com link that needs authentication Signed-off-by: Elena Kolevska <[email protected]> * Registers e2e test. Clean up. Signed-off-by: Elena Kolevska <[email protected]> * Apply suggestions from code review Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Linter Signed-off-by: Elena Kolevska <[email protected]> * Updates protos and renames parameter Signed-off-by: Elena Kolevska <[email protected]> * Improves error handling Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> * Updates dev version to 1.15.0 Signed-off-by: Elena Kolevska <[email protected]> --------- Signed-off-by: Elena Kolevska <[email protected]> Signed-off-by: Adam Stewart <[email protected]> Signed-off-by: Elena Kolevska <[email protected]> Co-authored-by: Adam Stewart <[email protected]> Co-authored-by: Marc Duiker <[email protected]>

elena-kolevska changed the title ~~Conversation API support (sync)~~ Conversation API support Feb 24, 2025

elena-kolevska marked this pull request as ready for review February 24, 2025 11:46

elena-kolevska requested review from a team as code owners February 24, 2025 11:46

elena-kolevska mentioned this pull request Feb 24, 2025

Add Dapr's Conversation API as LLM inference provider dapr/dapr-agents#8

Merged

elena-kolevska commented Feb 24, 2025

View reviewed changes

marcduiker suggested changes Feb 24, 2025

View reviewed changes

dapr/aio/clients/grpc/client.py Outdated Show resolved Hide resolved

dapr/clients/grpc/client.py Outdated Show resolved Hide resolved

famarting approved these changes Feb 24, 2025

View reviewed changes

elena-kolevska and others added 7 commits February 24, 2025 18:21

Conversation API support (sync)

9d006b7

Signed-off-by: Elena Kolevska <[email protected]>

async conversation api support

d40751b

Signed-off-by: Elena Kolevska <[email protected]>

Adds docs

516bd9f

Signed-off-by: Elena Kolevska <[email protected]>

Ignore validation of x.com link that needs authentication

ae74482

Signed-off-by: Elena Kolevska <[email protected]>

Registers e2e test. Clean up.

a23adb9

Signed-off-by: Elena Kolevska <[email protected]>

Apply suggestions from code review

73dcb0c

Co-authored-by: Marc Duiker <[email protected]> Signed-off-by: Elena Kolevska <[email protected]>

Linter

ae378bb

Signed-off-by: Elena Kolevska <[email protected]>

elena-kolevska force-pushed the conversation-api branch from 036d9d8 to a642176 Compare February 24, 2025 18:41

elena-kolevska changed the base branch from main to release-1.15 February 24, 2025 18:41

Updates protos and renames parameter

9bf0e27

Signed-off-by: Elena Kolevska <[email protected]>

elena-kolevska force-pushed the conversation-api branch from a642176 to 9bf0e27 Compare February 24, 2025 18:47

yaron2 approved these changes Feb 24, 2025

View reviewed changes

Improves error handling

9686dee

Signed-off-by: Elena Kolevska <[email protected]>

elena-kolevska force-pushed the conversation-api branch from e769371 to 9686dee Compare February 24, 2025 23:00

elena-kolevska added this to the v1.15 milestone Feb 24, 2025

elena-kolevska merged commit 6c3e40c into dapr:release-1.15 Feb 24, 2025
15 checks passed

elena-kolevska deleted the conversation-api branch February 24, 2025 23:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Conversation API support #787

Conversation API support #787

elena-kolevska commented Feb 24, 2025 •

edited

Loading

codecov bot commented Feb 24, 2025 •

edited

Loading

elena-kolevska Feb 24, 2025 •

edited

Loading

marcduiker left a comment

Conversation API support #787

Conversation API support #787

Conversation

elena-kolevska commented Feb 24, 2025 • edited Loading

Description

Issue reference

Checklist

codecov bot commented Feb 24, 2025 • edited Loading

Codecov Report

elena-kolevska Feb 24, 2025 • edited Loading

Choose a reason for hiding this comment

marcduiker left a comment

Choose a reason for hiding this comment

elena-kolevska commented Feb 24, 2025 •

edited

Loading

codecov bot commented Feb 24, 2025 •

edited

Loading

elena-kolevska Feb 24, 2025 •

edited

Loading