Commit b379679
Synchronize real-time audio API names (#692)
### Description
This PR standardizes the names of several real-time audio APIs across
the Foundry Local SDK language bindings. It also removes an extra unused
API in the JS SDK.
### Motivation and Context
The API names and their usage should be similar across the language
bindings. This ensures one language binding is not favored over another
language binding due to API usage.
### Copilot Summary
This pull request standardizes the naming of the real-time transcription
stream method across all SDKs by renaming methods like
`GetTranscriptionStream`, `getTranscriptionStream`, and
`get_transcription_stream` to `GetStream`, `getStream`, and `get_stream`
respectively. It also renames related files and updates all references
in documentation, tests, and code to match the new naming. Additionally,
C++ and JS client files are renamed for consistency. These changes
improve API clarity and make the SDKs more consistent across languages.
**SDK method and API renaming:**
* Renamed all real-time transcription stream methods to
`GetStream`/`getStream`/`get_stream` in C#, JS, Python, and Rust SDKs,
replacing previous names like `GetTranscriptionStream` and
`getTranscriptionStream`. All usages and documentation references are
updated accordingly.
**File and import renaming for consistency:**
* Renamed C++ and JS client files from `openai_live_audio_client.*` and
`liveAudioTranscriptionClient.js` to `openai_live_audio_session.*` and
`liveAudioSession.js`, updating all includes/imports throughout the
codebase.
**Interface and API cleanup:**
* Removed the `createLiveTranscriptionSession` method from the JS
`IModel` interface, reflecting the new naming and usage patterns.
These changes ensure a consistent and predictable developer experience
across all supported languages.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>1 parent 58bba93 commit b379679
42 files changed
Lines changed: 88 additions & 95 deletions
File tree
- samples
- cs/live-audio-transcription
- js/live-audio-transcription
- python/live-audio-transcription
- src
- rust/live-audio-transcription/src
- sdk
- cpp
- include
- openai
- src
- test
- cs
- src/OpenAI
- test/FoundryLocal.Tests
- js
- src
- detail
- openai
- test/openai
- python
- src/openai
- test/openai
- rust
- src/openai
- tests/integration
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
| 55 | + | |
56 | 56 | | |
57 | 57 | | |
58 | 58 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
| 58 | + | |
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
44 | | - | |
| 44 | + | |
45 | 45 | | |
46 | 46 | | |
47 | 47 | | |
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | | - | |
| 62 | + | |
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
| 56 | + | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
0 commit comments