You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk_v2/js/docs/classes/AudioClient.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: AudioClient
8
8
9
-
Defined in: [openai/audioClient.ts:40](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L40)
9
+
Defined in: [openai/audioClient.ts:40](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L40)
10
10
11
11
Client for performing audio operations (transcription, translation) with a loaded model.
12
12
Follows the OpenAI Audio API structure.
@@ -17,10 +17,13 @@ Follows the OpenAI Audio API structure.
Defined in: [openai/audioClient.ts:50](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L50)
20
+
Defined in: [openai/audioClient.ts:54](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L54)
21
21
22
22
**`Internal`**
23
23
24
+
Restricted to internal use because CoreInterop is an internal implementation detail.
25
+
Users should create clients via the Model.createAudioClient() factory method.
26
+
24
27
#### Parameters
25
28
26
29
##### modelId
@@ -41,7 +44,7 @@ Defined in: [openai/audioClient.ts:50](https://github.com/microsoft/Foundry-Loca
Defined in: [openai/audioClient.ts:47](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L47)
47
+
Defined in: [openai/audioClient.ts:47](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L47)
45
48
46
49
Configuration settings for audio operations.
47
50
@@ -51,7 +54,7 @@ Configuration settings for audio operations.
Defined in: [openai/audioClient.ts:60](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L60)
57
+
Defined in: [openai/audioClient.ts:75](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L75)
55
58
56
59
Transcribes audio into the input language.
57
60
@@ -69,13 +72,17 @@ Path to the audio file to transcribe.
69
72
70
73
The transcription result.
71
74
75
+
#### Throws
76
+
77
+
Error - If audioFilePath is invalid or transcription fails.
Defined in: [openai/audioClient.ts:77](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L77)
85
+
Defined in: [openai/audioClient.ts:98](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L98)
79
86
80
87
Transcribes audio into the input language using streaming.
81
88
@@ -98,3 +105,7 @@ A callback function that receives each chunk of the streaming response.
98
105
`Promise`\<`void`\>
99
106
100
107
A promise that resolves when the stream is complete.
108
+
109
+
#### Throws
110
+
111
+
Error - If audioFilePath or callback are invalid, or streaming fails.
Copy file name to clipboardExpand all lines: sdk_v2/js/docs/classes/AudioClientSettings.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: AudioClientSettings
8
8
9
-
Defined in: [openai/audioClient.ts:3](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L3)
9
+
Defined in: [openai/audioClient.ts:3](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L3)
10
10
11
11
## Constructors
12
12
@@ -24,23 +24,23 @@ Defined in: [openai/audioClient.ts:3](https://github.com/microsoft/Foundry-Local
24
24
25
25
> `optional`**language**: `string`
26
26
27
-
Defined in: [openai/audioClient.ts:4](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L4)
27
+
Defined in: [openai/audioClient.ts:4](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L4)
28
28
29
29
***
30
30
31
31
### temperature?
32
32
33
33
> `optional`**temperature**: `number`
34
34
35
-
Defined in: [openai/audioClient.ts:5](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L5)
35
+
Defined in: [openai/audioClient.ts:5](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L5)
36
36
37
37
## Methods
38
38
39
39
### \_serialize()
40
40
41
41
> **\_serialize**(): `object`
42
42
43
-
Defined in: [openai/audioClient.ts:11](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/audioClient.ts#L11)
43
+
Defined in: [openai/audioClient.ts:11](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/audioClient.ts#L11)
Copy file name to clipboardExpand all lines: sdk_v2/js/docs/classes/ChatClient.md
+16-5Lines changed: 16 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: ChatClient
8
8
9
-
Defined in: [openai/chatClient.ts:50](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L50)
9
+
Defined in: [openai/chatClient.ts:50](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L50)
10
10
11
11
Client for performing chat completions with a loaded model.
12
12
Follows the OpenAI Chat Completion API structure.
@@ -17,10 +17,13 @@ Follows the OpenAI Chat Completion API structure.
Defined in: [openai/chatClient.ts:60](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L60)
20
+
Defined in: [openai/chatClient.ts:64](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L64)
21
21
22
22
**`Internal`**
23
23
24
+
Restricted to internal use because CoreInterop is an internal implementation detail.
25
+
Users should create clients via the Model.createChatClient() factory method.
26
+
24
27
#### Parameters
25
28
26
29
##### modelId
@@ -41,7 +44,7 @@ Defined in: [openai/chatClient.ts:60](https://github.com/microsoft/Foundry-Local
Defined in: [openai/chatClient.ts:57](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L57)
47
+
Defined in: [openai/chatClient.ts:57](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L57)
45
48
46
49
Configuration settings for chat completions.
47
50
@@ -51,7 +54,7 @@ Configuration settings for chat completions.
Defined in: [openai/chatClient.ts:70](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L70)
57
+
Defined in: [openai/chatClient.ts:96](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L96)
55
58
56
59
Performs a synchronous chat completion.
57
60
@@ -69,13 +72,17 @@ An array of message objects (e.g., { role: 'user', content: 'Hello' }).
69
72
70
73
The chat completion response object.
71
74
75
+
#### Throws
76
+
77
+
Error - If messages are invalid or completion fails.
Defined in: [openai/chatClient.ts:88](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L88)
85
+
Defined in: [openai/chatClient.ts:120](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L120)
79
86
80
87
Performs a streaming chat completion.
81
88
@@ -98,3 +105,7 @@ A callback function that receives each chunk of the streaming response.
98
105
`Promise`\<`void`\>
99
106
100
107
A promise that resolves when the stream is complete.
108
+
109
+
#### Throws
110
+
111
+
Error - If messages or callback are invalid, or streaming fails.
Copy file name to clipboardExpand all lines: sdk_v2/js/docs/classes/ChatClientSettings.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: ChatClientSettings
8
8
9
-
Defined in: [openai/chatClient.ts:3](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L3)
9
+
Defined in: [openai/chatClient.ts:3](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L3)
10
10
11
11
## Constructors
12
12
@@ -24,71 +24,71 @@ Defined in: [openai/chatClient.ts:3](https://github.com/microsoft/Foundry-Local/
24
24
25
25
> `optional`**frequencyPenalty**: `number`
26
26
27
-
Defined in: [openai/chatClient.ts:4](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L4)
27
+
Defined in: [openai/chatClient.ts:4](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L4)
28
28
29
29
***
30
30
31
31
### maxTokens?
32
32
33
33
> `optional`**maxTokens**: `number`
34
34
35
-
Defined in: [openai/chatClient.ts:5](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L5)
35
+
Defined in: [openai/chatClient.ts:5](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L5)
36
36
37
37
***
38
38
39
39
### n?
40
40
41
41
> `optional`**n**: `number`
42
42
43
-
Defined in: [openai/chatClient.ts:6](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L6)
43
+
Defined in: [openai/chatClient.ts:6](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L6)
44
44
45
45
***
46
46
47
47
### presencePenalty?
48
48
49
49
> `optional`**presencePenalty**: `number`
50
50
51
-
Defined in: [openai/chatClient.ts:8](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L8)
51
+
Defined in: [openai/chatClient.ts:8](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L8)
52
52
53
53
***
54
54
55
55
### randomSeed?
56
56
57
57
> `optional`**randomSeed**: `number`
58
58
59
-
Defined in: [openai/chatClient.ts:9](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L9)
59
+
Defined in: [openai/chatClient.ts:9](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L9)
60
60
61
61
***
62
62
63
63
### temperature?
64
64
65
65
> `optional`**temperature**: `number`
66
66
67
-
Defined in: [openai/chatClient.ts:7](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L7)
67
+
Defined in: [openai/chatClient.ts:7](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L7)
68
68
69
69
***
70
70
71
71
### topK?
72
72
73
73
> `optional`**topK**: `number`
74
74
75
-
Defined in: [openai/chatClient.ts:10](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L10)
75
+
Defined in: [openai/chatClient.ts:10](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L10)
76
76
77
77
***
78
78
79
79
### topP?
80
80
81
81
> `optional`**topP**: `number`
82
82
83
-
Defined in: [openai/chatClient.ts:11](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L11)
83
+
Defined in: [openai/chatClient.ts:11](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L11)
84
84
85
85
## Methods
86
86
87
87
### \_serialize()
88
88
89
89
> **\_serialize**(): `object`
90
90
91
-
Defined in: [openai/chatClient.ts:17](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/openai/chatClient.ts#L17)
91
+
Defined in: [openai/chatClient.ts:17](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/openai/chatClient.ts#L17)
Copy file name to clipboardExpand all lines: sdk_v2/js/docs/classes/Configuration.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: Configuration
8
8
9
-
Defined in: [configuration.ts:75](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/configuration.ts#L75)
9
+
Defined in: [configuration.ts:75](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/configuration.ts#L75)
10
10
11
11
**`Internal`**
12
12
@@ -16,7 +16,7 @@ Defined in: [configuration.ts:75](https://github.com/microsoft/Foundry-Local/blo
Defined in: [configuration.ts:78](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/configuration.ts#L78)
19
+
Defined in: [configuration.ts:78](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/configuration.ts#L78)
20
20
21
21
#### Parameters
22
22
@@ -34,7 +34,7 @@ Defined in: [configuration.ts:78](https://github.com/microsoft/Foundry-Local/blo
34
34
35
35
> **params**: `object`
36
36
37
-
Defined in: [configuration.ts:76](https://github.com/microsoft/Foundry-Local/blob/03d8abe494b495f2cafc516bcebbbb66a9b6662f/sdk_v2/js/src/configuration.ts#L76)
37
+
Defined in: [configuration.ts:76](https://github.com/microsoft/Foundry-Local/blob/a42a7bf2423d2b1da6cca82531f4977f139aef46/sdk_v2/js/src/configuration.ts#L76)
0 commit comments