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

[JS] feat: streaming support for Tools Augmentation #2195

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Stevenic
Copy link
Contributor

@Stevenic Stevenic commented Nov 20, 2024

Linked issues

closes: #2197

Details

This update adds support for properly calling tools with streaming support. It doesn't solve for the other augmentation types as that's much more challenging.

Change details

The challenge with streaming + tool use is that we need to make multiple calls to the model and we can only have a single stream open to the teams client. To address this we end up leveraging the fact that the Streamer is being cached to temp state and we let the tool call happen as it normally world. To the tool call its as if its a non-streaming message but the Streamer object is kept in memory (temp state) waiting for the tool call to complete. We a new request is made to the ActionPlanner, the created LLMClient will see that it's already created a Streamer and attach to that instance.

There was a bit of book keeping that needed to be done but it's a straightforward change.

code snippets:

screenshots:

Attestation Checklist

  • [x ] My code follows the style guidelines of this project

  • I have checked for/fixed spelling, linting, and other errors

  • I have commented my code for clarity

  • I have made corresponding changes to the documentation (updating the doc strings in the code is sufficient)

  • My changes generate no new warnings

  • I have added tests that validates my changes, and provides sufficient test coverage. I have tested with:

    • Local testing
    • E2E testing in Teams
  • New and existing unit tests pass locally with my changes

Additional information

Feel free to add other relevant information below

@Stevenic Stevenic marked this pull request as ready for review November 21, 2024 01:12
@corinagum
Copy link
Collaborator

Hey Steve, I filed a sub issue and linked it in your summary :)

@@ -373,20 +373,44 @@ export class OpenAIModel implements PromptCompletionModel {
if (delta.content) {
message.content += delta.content;
}

Copy link
Collaborator

Choose a reason for hiding this comment

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

Do these changes need tests?

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.

[JS] ToolsAugmentation compatibility with streaming
2 participants