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

.Net: [Draft] main -> feature-connectors-assemblyai #8530

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

RogerBarreto
Copy link
Member

DRAFT PR FOR VISIBILITY ONLY (IN PROGRESS)

Swimburger and others added 5 commits March 20, 2024 12:35
### Motivation and Context

AssemblyAI is a speech AI company and SK provides a new
`IAudioToTextService` for different connectors to implement.

### Description

I added a connector for AssemblyAI that implements
`IAudioToTextService`.
The `AssemblyAIAudioToTextService` accepts `AudioContent` as mandated by
the interface, but also a `Stream` as discussed
[here](#4932), a
`FileInfo`, and a `Uri`.

Remarks:
- I couldn't run tests in Connectors.UnitTests because of compilation
issues in referenced projects, but I could verify the functionality in
the integration tests.
- We're working on our C# SDK, so the code will be updated once our C#
SDK lands.

Questions:
- How should I set up the icon and README.md file in this connector
project?
- Should the `IAudioToTextService` interface accept
`PromptExecutionSettings`? It seems a little odd to me since this isn't
prompting an LLM.
- Which of these overloads makes sense to pull into
`IAudioToTextService`? I added `Stream`, `FileInfo`, and `Uri` to our
implementation.

Upcoming changes.

- Change AudioAbstractions to accept an IAsyncEnumerable<StreamingAudioContent> instead of AudioStreamContent class.

### Contribution Checklist

- [ ] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Roger Barreto <[email protected]>
AssemblyAI is a speech AI company and SK provides a new
`IAudioToTextService` for different connectors to implement.

I added a connector for AssemblyAI that implements
`IAudioToTextService`.
The `AssemblyAIAudioToTextService` accepts `AudioContent` as mandated by
the interface, but also a `Stream` as discussed
[here](#4932), a
`FileInfo`, and a `Uri`.

Remarks:
- I couldn't run tests in Connectors.UnitTests because of compilation
issues in referenced projects, but I could verify the functionality in
the integration tests.
- We're working on our C# SDK, so the code will be updated once our C#
SDK lands.

Questions:
- How should I set up the icon and README.md file in this connector
project?
- Should the `IAudioToTextService` interface accept
`PromptExecutionSettings`? It seems a little odd to me since this isn't
prompting an LLM.
- Which of these overloads makes sense to pull into
`IAudioToTextService`? I added `Stream`, `FileInfo`, and `Uri` to our
implementation.

Upcoming changes.

- Change AudioAbstractions to accept an IAsyncEnumerable<StreamingAudioContent> instead of AudioStreamContent class.

- [ ] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Roger Barreto <[email protected]>
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

---------

Co-authored-by: Niels Swimberghe <[email protected]>
@RogerBarreto RogerBarreto self-assigned this Sep 5, 2024
@markwallace-microsoft markwallace-microsoft added .NET Issue or Pull requests regarding .NET code kernel Issues or pull requests impacting the core kernel kernel.core documentation labels Sep 5, 2024
### Motivation and Context

### Description

By using the SDK, users can use the `TranscriptOptionalParams` class
from the SDK to pass parameters to the AssemblyAI transcription
endpoint.

### Contribution Checklist

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Roger Barreto <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation kernel Issues or pull requests impacting the core kernel .NET Issue or Pull requests regarding .NET code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants