-
Notifications
You must be signed in to change notification settings - Fork 180
/
ChatChoice.yml
134 lines (127 loc) · 4.19 KB
/
ChatChoice.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
### YamlMime:TSType
name: ChatChoice
uid: '@azure/openai.ChatChoice'
package: '@azure/openai'
summary: >-
The representation of a single prompt completion as part of an overall chat
completions request.
Generally, `n` choices are generated per provided prompt with a default value
of 1.
Token limits and other settings may limit the number of choices generated.
fullName: ChatChoice
remarks: ''
isDeprecated: false
type: interface
properties:
- name: contentFilterResults
uid: '@azure/openai.ChatChoice.contentFilterResults'
package: '@azure/openai'
summary: >-
Information about the content filtering category (hate, sexual, violence,
self_harm), if it
has been detected, as well as the severity level (very_low, low, medium,
high-scale that
determines the intensity and risk level of harmful content) and if it has
been filtered or not.
fullName: contentFilterResults
remarks: ''
isDeprecated: false
syntax:
content: 'contentFilterResults?: ContentFilterResultsForChoice'
return:
description: ''
type: <xref uid="@azure/openai.ContentFilterResultsForChoice" />
- name: delta
uid: '@azure/openai.ChatChoice.delta'
package: '@azure/openai'
summary: The delta message content for a streaming response.
fullName: delta
remarks: ''
isDeprecated: false
syntax:
content: 'delta?: ChatResponseMessage'
return:
description: ''
type: <xref uid="@azure/openai.ChatResponseMessage" />
- name: enhancements
uid: '@azure/openai.ChatChoice.enhancements'
package: '@azure/openai'
summary: >-
Represents the output results of Azure OpenAI enhancements to chat
completions, as configured via the matching input
provided in the request. This supplementary information is only available
when using Azure OpenAI and only when the
request is configured to use enhancements.
fullName: enhancements
remarks: ''
isDeprecated: false
syntax:
content: 'enhancements?: AzureChatEnhancements'
return:
description: ''
type: <xref uid="@azure/openai.AzureChatEnhancements" />
- name: finishDetails
uid: '@azure/openai.ChatChoice.finishDetails'
package: '@azure/openai'
summary: >-
The reason the model stopped generating tokens, together with any
applicable details.
This structured representation replaces 'finish_reason' for some models.
fullName: finishDetails
remarks: ''
isDeprecated: false
syntax:
content: 'finishDetails?: ChatFinishDetailsUnion'
return:
description: ''
type: <xref uid="@azure/openai.ChatFinishDetailsUnion" />
- name: finishReason
uid: '@azure/openai.ChatChoice.finishReason'
package: '@azure/openai'
summary: The reason that this chat completions choice completed its generated.
fullName: finishReason
remarks: ''
isDeprecated: false
syntax:
content: 'finishReason: null | string'
return:
description: ''
type: null | string
- name: index
uid: '@azure/openai.ChatChoice.index'
package: '@azure/openai'
summary: The ordered index associated with this chat completions choice.
fullName: index
remarks: ''
isDeprecated: false
syntax:
content: 'index: number'
return:
description: ''
type: number
- name: logprobs
uid: '@azure/openai.ChatChoice.logprobs'
package: '@azure/openai'
summary: >-
The log probability information for this choice, as enabled via the
'logprobs' request option.
fullName: logprobs
remarks: ''
isDeprecated: false
syntax:
content: 'logprobs: null | ChatChoiceLogProbabilityInfo'
return:
description: ''
type: null | <xref uid="@azure/openai.ChatChoiceLogProbabilityInfo" />
- name: message
uid: '@azure/openai.ChatChoice.message'
package: '@azure/openai'
summary: The chat message for a given chat completions prompt.
fullName: message
remarks: ''
isDeprecated: false
syntax:
content: 'message?: ChatResponseMessage'
return:
description: ''
type: <xref uid="@azure/openai.ChatResponseMessage" />