Skip to content

Commit b0f9e5c

Browse files
joseharriagajoseharriaga
authored
Prepare 2.1.0-beta.2 release (Part 1) (#278)
### Features added - Added a `StoredOutputEnabled` property to `ChatCompletionOptions` ([`store` in the REST API](https://platform.openai.com/docs/api-reference/chat/create#chat-create-store)). - Use this property to indicate whether or not to store the output of the chat completion for use in model distillation or evals. - Added a `Metadata` property to `ChatCompletionOptions` ([`metadata` in the REST API](https://platform.openai.com/docs/api-reference/chat/create#chat-create-metadata)). - Use this property to add custom tags and values to the chat completions for filtering in the OpenAI dashboard. - Added an `InputTokenDetails` property to `ChatTokenUsage` ([`usage.prompt_token_details` in the REST API](https://platform.openai.com/docs/api-reference/chat/object#chat/object-usage)). - The property is of a new type called `ChatInputTokenUsageDetails`, which contains properties for `AudioTokenCount` and `CachedTokenCount` for usage with supported models. - Added an `AudioTokenCount` property to `ChatOutputTokenUsageDetails` ([`usage.completion_token_details` in the REST API](https://platform.openai.com/docs/api-reference/chat/object#chat/object-usage)). Audio support in chat completions is coming soon. - Added `Illicit` and `IllictViolent` properties `ModerationResult` to represent these two new moderation categories. - Made improvements to the experimental Realtime API. Please note this features area is currently under rapid development and not all changes may be reflected here. - Several types have been renamed for consistency and clarity. - `ConversationRateLimitsUpdate` (previously `ConversationRateLimitsUpdatedUpdate`) now includes named `RequestDetails` and `TokenDetails` properties, mapping to the corresponding named items in the underlying `rate_limits` command payload. ### Other Changes - Updated the `System.ClientModel` dependency to version `1.2.1`. - This updates the `System.Text.Json` transitive dependency to version `6.0.10`, which includes a security compliance fix for [CVE-2024-43485](GHSA-8g4q-xg66-9fp4). Please note that the OpenAI library was not impacted by this vulnerability since it does not use the `[JsonExtensionData]` feature.
1 parent b8ec620 commit b0f9e5c

File tree

329 files changed

+6546
-3944
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

329 files changed

+6546
-3944
lines changed

‎.editorconfig‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
# editorconfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
trim_trailing_whitespace = true
8+
9+
# Default settings:
10+
# A newline ending every file
11+
# Use 4 spaces as indentation
12+
[sdk/*/{Azure.*,System.*}/**]
13+
insert_final_newline = true
14+
indent_style = space
15+
indent_size = 4
16+
17+
# C# files
18+
[src/*/{Custom.*}/**.cs]
19+
# New line preferences
20+
csharp_new_line_before_open_brace = all # vs-default: any
21+
csharp_new_line_before_else = true # vs-default: true
22+
csharp_new_line_before_catch = true # vs-default: true
23+
csharp_new_line_before_finally = true # vs-default: true
24+
csharp_new_line_before_members_in_object_initializers = true # vs-default: true
25+
csharp_new_line_before_members_in_anonymous_types = true # vs-default: true
26+
csharp_new_line_between_query_expression_clauses = true # vs-default: true
27+
28+
# Indentation preferences
29+
csharp_indent_block_contents = true # vs-default: true
30+
csharp_indent_braces = false # vs-default: false
31+
csharp_indent_case_contents = true # vs-default: true
32+
csharp_indent_case_contents_when_block = true
33+
csharp_indent_switch_labels = true # vs-default: true
34+
csharp_indent_labels = one_less_than_current # vs-default: one_less_than_current
35+
36+
# Modifier preferences
37+
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
38+
39+
# avoid this. unless absolutely necessary
40+
dotnet_style_qualification_for_field = false:suggestion # vs-default: false:none
41+
dotnet_style_qualification_for_property = false:suggestion # vs-default: false:none
42+
dotnet_style_qualification_for_method = false:suggestion # vs-default: false:none
43+
dotnet_style_qualification_for_event = false:suggestion # vs-default: false:none
44+
45+
# only use var when it's obvious what the variable type is
46+
csharp_style_var_for_built_in_types = false:none # vs-default: true:none
47+
csharp_style_var_when_type_is_apparent = false:none # vs-default: true:none
48+
csharp_style_var_elsewhere = false:suggestion # vs-default: true:none
49+
50+
# use language keywords instead of BCL types
51+
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion # vs-default: true:none
52+
dotnet_style_predefined_type_for_member_access = true:suggestion # vs-default: true:none
53+
54+
# name all constant fields using PascalCase
55+
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
56+
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
57+
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
58+
59+
dotnet_naming_symbols.constant_fields.applicable_kinds = field
60+
dotnet_naming_symbols.constant_fields.required_modifiers = const
61+
62+
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
63+
64+
# static fields should have s_ prefix
65+
dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
66+
dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields
67+
dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style
68+
69+
dotnet_naming_symbols.static_fields.applicable_kinds = field
70+
dotnet_naming_symbols.static_fields.required_modifiers = static
71+
dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
72+
dotnet_naming_style.static_prefix_style.required_prefix = s_
73+
dotnet_naming_style.static_prefix_style.capitalization = camel_case
74+
75+
# internal and private fields should be _camelCase
76+
dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
77+
dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields
78+
dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style
79+
80+
dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
81+
dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
82+
83+
dotnet_naming_style.camel_case_underscore_style.required_prefix = _
84+
dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
85+
86+
# Code style defaults
87+
csharp_using_directive_placement = outside_namespace:suggestion
88+
dotnet_sort_system_directives_first = true # vs-default: true
89+
csharp_prefer_braces = true:refactoring
90+
csharp_preserve_single_line_blocks = true # vs-default: true
91+
csharp_preserve_single_line_statements = false # vs-default: true
92+
csharp_prefer_static_local_function = true:suggestion
93+
csharp_prefer_simple_using_statement = false:none
94+
csharp_style_prefer_switch_expression = true:suggestion
95+
96+
# Code quality
97+
dotnet_style_readonly_field = true:suggestion
98+
dotnet_code_quality_unused_parameters = non_public:suggestion
99+
100+
# Expression-level preferences
101+
dotnet_style_object_initializer = true:suggestion # vs-default: true:suggestion
102+
dotnet_style_collection_initializer = true:suggestion # vs-default: true:suggestion
103+
dotnet_style_explicit_tuple_names = true:suggestion # vs-default: true:suggestion
104+
dotnet_style_coalesce_expression = true:suggestion # vs-default: true:suggestion
105+
dotnet_style_null_propagation = true:suggestion # vs-default: true:suggestion
106+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
107+
dotnet_style_prefer_inferred_tuple_names = true:suggestion
108+
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
109+
dotnet_style_prefer_auto_properties = true:suggestion
110+
dotnet_style_prefer_conditional_expression_over_assignment = true:refactoring
111+
dotnet_style_prefer_conditional_expression_over_return = true:refactoring
112+
csharp_prefer_simple_default_expression = true:suggestion
113+
114+
# Expression-bodied members
115+
csharp_style_expression_bodied_methods = false:none # vs-default: false:none
116+
csharp_style_expression_bodied_constructors = false:none # vs-default: false:none
117+
csharp_style_expression_bodied_operators = false:none # vs-default: false:none
118+
csharp_style_expression_bodied_properties = true:none # vs-default: true:none
119+
csharp_style_expression_bodied_indexers = true:none # vs-default: true:none
120+
csharp_style_expression_bodied_accessors = true:none # vs-default: true:none
121+
csharp_style_expression_bodied_lambdas = true:refactoring
122+
csharp_style_expression_bodied_local_functions = true:refactoring
123+
124+
# Pattern matching
125+
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion # vs-default: true:suggestion
126+
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion # vs-default: true:suggestion
127+
csharp_style_inlined_variable_declaration = true:suggestion # vs-default: true:suggestion
128+
129+
# Null checking preferences
130+
csharp_style_throw_expression = true:suggestion # vs-default: true:suggestion
131+
csharp_style_conditional_delegate_call = true:suggestion # vs-default: true:suggestion
132+
133+
# Other features
134+
csharp_style_prefer_index_operator = false:none
135+
csharp_style_prefer_range_operator = false:none
136+
csharp_style_pattern_local_over_anonymous_function = false:none
137+
138+
# Space preferences
139+
csharp_space_after_cast = false # vs-default: false
140+
csharp_space_after_colon_in_inheritance_clause = true # vs-default: true
141+
csharp_space_after_comma = true # vs-default: true
142+
csharp_space_after_dot = false # vs-default: false
143+
csharp_space_after_keywords_in_control_flow_statements = true # vs-default: true
144+
csharp_space_after_semicolon_in_for_statement = true # vs-default: true
145+
csharp_space_around_binary_operators = before_and_after # vs-default: before_and_after
146+
csharp_space_around_declaration_statements = do_not_ignore # vs-default: false
147+
csharp_space_before_colon_in_inheritance_clause = true # vs-default: true
148+
csharp_space_before_comma = false # vs-default: false
149+
csharp_space_before_dot = false # vs-default: false
150+
csharp_space_before_open_square_brackets = false # vs-default: false
151+
csharp_space_before_semicolon_in_for_statement = false # vs-default: false
152+
csharp_space_between_empty_square_brackets = false # vs-default: false
153+
csharp_space_between_method_call_empty_parameter_list_parentheses = false # vs-default: false
154+
csharp_space_between_method_call_name_and_opening_parenthesis = false # vs-default: false
155+
csharp_space_between_method_call_parameter_list_parentheses = false # vs-default: false
156+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false # vs-default: false
157+
csharp_space_between_method_declaration_name_and_open_parenthesis = false # vs-default: false
158+
csharp_space_between_method_declaration_parameter_list_parentheses = false # vs-default: false
159+
csharp_space_between_parentheses = false # vs-default: false
160+
csharp_space_between_square_brackets = false # vs-default: false
161+
162+
# Require accessibility modifiers
163+
dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion # vs-default: for_non_interface_members:none
164+
165+
# Analyzers
166+
dotnet_code_quality.ca1802.api_surface = private, internal
167+
168+
# Xml project files
169+
[*.{csproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
170+
indent_size = 2
171+
172+
# Xml build files
173+
[*.builds]
174+
indent_size = 2
175+
176+
# Xml files
177+
[*.{xml,stylecop,resx,ruleset}]
178+
indent_size = 2
179+
180+
# Xml config files
181+
[*.{props,targets,config,nuspec}]
182+
indent_size = 2
183+
184+
# Shell scripts
185+
[*.sh]
186+
end_of_line = lf
187+
[*.{cmd, bat}]
188+
end_of_line = crlf

‎CHANGELOG.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Release History
22

3+
## 2.1.0-beta.2 (Unreleased)
4+
5+
### Features added
6+
7+
- Added a `StoredOutputEnabled` property to `ChatCompletionOptions` ([`store` in the REST API](https://platform.openai.com/docs/api-reference/chat/create#chat-create-store)). (commit_hash)
8+
- Use this property to indicate whether or not to store the output of the chat completion for use in model distillation or evals.
9+
- Added a `Metadata` property to `ChatCompletionOptions` ([`metadata` in the REST API](https://platform.openai.com/docs/api-reference/chat/create#chat-create-metadata)). (commit_hash)
10+
- Use this property to add custom tags and values to the chat completions for filtering in the OpenAI dashboard.
11+
- Added an `InputTokenDetails` property to `ChatTokenUsage` ([`usage.prompt_token_details` in the REST API](https://platform.openai.com/docs/api-reference/chat/object#chat/object-usage)). (commit_hash)
12+
- The property is of a new type called `ChatInputTokenUsageDetails`, which contains properties for `AudioTokenCount` and `CachedTokenCount` for usage with supported models.
13+
- Added an `AudioTokenCount` property to `ChatOutputTokenUsageDetails` ([`usage.completion_token_details` in the REST API](https://platform.openai.com/docs/api-reference/chat/object#chat/object-usage)). Audio support in chat completions is coming soon. (commit_hash)
14+
- Added `Illicit` and `IllictViolent` properties `ModerationResult` to represent these two new moderation categories. (commit_hash)
15+
- Made improvements to the experimental Realtime API. Please note this features area is currently under rapid development and not all changes may be reflected here. (commit_hash)
16+
- Several types have been renamed for consistency and clarity.
17+
- `ConversationRateLimitsUpdate` (previously `ConversationRateLimitsUpdatedUpdate`) now includes named `RequestDetails` and `TokenDetails` properties, mapping to the corresponding named items in the underlying `rate_limits` command payload.
18+
19+
### Other Changes
20+
21+
- Updated the `System.ClientModel` dependency to version `1.2.1`. (commit_hash)
22+
- This updates the `System.Text.Json` transitive dependency to version `6.0.10`, which includes a security compliance fix for [CVE-2024-43485](https://github.com/advisories/GHSA-8g4q-xg66-9fp4). Please note that the OpenAI library was not impacted by this vulnerability since it does not use the `[JsonExtensionData]` feature.
23+
324
## 2.1.0-beta.1 (2024-10-01)
425

526
With this updated preview library release, we're excited to bring early support for the newly-announced `/realtime` beta API. You can read more about `/realtime` here: https://openai.com/index/introducing-the-realtime-api/

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -856,4 +856,4 @@ By default, the client classes will automatically retry the following errors up
856856

857857
### Observability
858858

859-
OpenAI .NET library supports experimental distributed tracing and metrics with OpenTelemetry. Check out [Observability with OpenTelemetry](./docs/observability.md) for more details.
859+
OpenAI .NET library supports experimental distributed tracing and metrics with OpenTelemetry. Check out [Observability with OpenTelemetry](./docs/observability.md) for more details.

0 commit comments

Comments
 (0)