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.
openai · Nov 1, 2024 · b0f9e5c · b0f9e5c
1 parent b8ec620
commit b0f9e5c
Show file tree

Hide file tree

Showing 329 changed files with 6,546 additions and 3,944 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,188 @@
+# editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+trim_trailing_whitespace = true
+
+# Default settings:
+# A newline ending every file
+# Use 4 spaces as indentation
+[sdk/*/{Azure.*,System.*}/**]
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+
+# C# files
+[src/*/{Custom.*}/**.cs]
+# New line preferences
+csharp_new_line_before_open_brace = all # vs-default: any
+csharp_new_line_before_else = true # vs-default: true
+csharp_new_line_before_catch = true # vs-default: true
+csharp_new_line_before_finally = true # vs-default: true
+csharp_new_line_before_members_in_object_initializers = true # vs-default: true
+csharp_new_line_before_members_in_anonymous_types = true # vs-default: true
+csharp_new_line_between_query_expression_clauses = true # vs-default: true
+
+# Indentation preferences
+csharp_indent_block_contents = true # vs-default: true
+csharp_indent_braces = false # vs-default: false
+csharp_indent_case_contents = true # vs-default: true
+csharp_indent_case_contents_when_block = true
+csharp_indent_switch_labels = true # vs-default: true
+csharp_indent_labels = one_less_than_current # vs-default: one_less_than_current
+
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+
+# avoid this. unless absolutely necessary
+dotnet_style_qualification_for_field = false:suggestion # vs-default: false:none
+dotnet_style_qualification_for_property = false:suggestion # vs-default: false:none
+dotnet_style_qualification_for_method = false:suggestion # vs-default: false:none
+dotnet_style_qualification_for_event = false:suggestion # vs-default: false:none
+
+# only use var when it's obvious what the variable type is
+csharp_style_var_for_built_in_types = false:none # vs-default: true:none
+csharp_style_var_when_type_is_apparent = false:none # vs-default: true:none
+csharp_style_var_elsewhere = false:suggestion # vs-default: true:none
+
+# use language keywords instead of BCL types
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion # vs-default: true:none
+dotnet_style_predefined_type_for_member_access = true:suggestion # vs-default: true:none
+
+# name all constant fields using PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
+
+dotnet_naming_symbols.constant_fields.applicable_kinds = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+# static fields should have s_ prefix
+dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
+dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields
+dotnet_naming_rule.static_fields_should_have_prefix.style = static_prefix_style
+
+dotnet_naming_symbols.static_fields.applicable_kinds = field
+dotnet_naming_symbols.static_fields.required_modifiers = static
+dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
+dotnet_naming_style.static_prefix_style.required_prefix = s_
+dotnet_naming_style.static_prefix_style.capitalization = camel_case
+
+# internal and private fields should be _camelCase
+dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
+dotnet_naming_rule.camel_case_for_private_internal_fields.symbols = private_internal_fields
+dotnet_naming_rule.camel_case_for_private_internal_fields.style = camel_case_underscore_style
+
+dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
+dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
+
+dotnet_naming_style.camel_case_underscore_style.required_prefix = _
+dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+# Code style defaults
+csharp_using_directive_placement = outside_namespace:suggestion
+dotnet_sort_system_directives_first = true # vs-default: true
+csharp_prefer_braces = true:refactoring
+csharp_preserve_single_line_blocks = true # vs-default: true
+csharp_preserve_single_line_statements = false # vs-default: true
+csharp_prefer_static_local_function = true:suggestion
+csharp_prefer_simple_using_statement = false:none
+csharp_style_prefer_switch_expression = true:suggestion
+
+# Code quality
+dotnet_style_readonly_field = true:suggestion
+dotnet_code_quality_unused_parameters = non_public:suggestion
+
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion # vs-default: true:suggestion
+dotnet_style_collection_initializer = true:suggestion # vs-default: true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion # vs-default: true:suggestion
+dotnet_style_coalesce_expression = true:suggestion # vs-default: true:suggestion
+dotnet_style_null_propagation = true:suggestion # vs-default: true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:refactoring
+dotnet_style_prefer_conditional_expression_over_return = true:refactoring
+csharp_prefer_simple_default_expression = true:suggestion
+
+# Expression-bodied members
+csharp_style_expression_bodied_methods = false:none # vs-default: false:none
+csharp_style_expression_bodied_constructors = false:none # vs-default: false:none
+csharp_style_expression_bodied_operators = false:none # vs-default: false:none
+csharp_style_expression_bodied_properties = true:none # vs-default: true:none
+csharp_style_expression_bodied_indexers = true:none # vs-default: true:none
+csharp_style_expression_bodied_accessors = true:none # vs-default: true:none
+csharp_style_expression_bodied_lambdas = true:refactoring
+csharp_style_expression_bodied_local_functions = true:refactoring
+
+# Pattern matching
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion # vs-default: true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion # vs-default: true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion # vs-default: true:suggestion
+
+# Null checking preferences
+csharp_style_throw_expression = true:suggestion # vs-default: true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion # vs-default: true:suggestion
+
+# Other features
+csharp_style_prefer_index_operator = false:none
+csharp_style_prefer_range_operator = false:none
+csharp_style_pattern_local_over_anonymous_function = false:none
+
+# Space preferences
+csharp_space_after_cast = false # vs-default: false
+csharp_space_after_colon_in_inheritance_clause = true # vs-default: true
+csharp_space_after_comma = true # vs-default: true
+csharp_space_after_dot = false # vs-default: false
+csharp_space_after_keywords_in_control_flow_statements = true # vs-default: true
+csharp_space_after_semicolon_in_for_statement = true # vs-default: true
+csharp_space_around_binary_operators = before_and_after # vs-default: before_and_after
+csharp_space_around_declaration_statements = do_not_ignore # vs-default: false
+csharp_space_before_colon_in_inheritance_clause = true # vs-default: true
+csharp_space_before_comma = false # vs-default: false
+csharp_space_before_dot = false # vs-default: false
+csharp_space_before_open_square_brackets = false # vs-default: false
+csharp_space_before_semicolon_in_for_statement = false # vs-default: false
+csharp_space_between_empty_square_brackets = false # vs-default: false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false # vs-default: false
+csharp_space_between_method_call_name_and_opening_parenthesis = false # vs-default: false
+csharp_space_between_method_call_parameter_list_parentheses = false # vs-default: false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false # vs-default: false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false # vs-default: false
+csharp_space_between_method_declaration_parameter_list_parentheses = false # vs-default: false
+csharp_space_between_parentheses = false # vs-default: false
+csharp_space_between_square_brackets = false # vs-default: false
+
+# Require accessibility modifiers
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion # vs-default: for_non_interface_members:none
+
+# Analyzers
+dotnet_code_quality.ca1802.api_surface = private, internal
+
+# Xml project files
+[*.{csproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
+indent_size = 2
+
+# Xml build files
+[*.builds]
+indent_size = 2
+
+# Xml files
+[*.{xml,stylecop,resx,ruleset}]
+indent_size = 2
+
+# Xml config files
+[*.{props,targets,config,nuspec}]
+indent_size = 2
+
+# Shell scripts
+[*.sh]
+end_of_line = lf
+[*.{cmd, bat}]
+end_of_line = crlf
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,26 @@
 # Release History
 
+## 2.1.0-beta.2 (Unreleased)
+
+### 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)). (commit_hash)
+  - 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)). (commit_hash)
+  - 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)). (commit_hash)
+  - 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. (commit_hash)
+- Added `Illicit` and `IllictViolent` properties `ModerationResult` to represent these two new moderation categories. (commit_hash)
+- 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)
+  - 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`. (commit_hash)
+  - 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.
+
 ## 2.1.0-beta.1 (2024-10-01)
 
 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/

diff --git a/README.md b/README.md
@@ -856,4 +856,4 @@ By default, the client classes will automatically retry the following errors up
 
 ### Observability
 
-OpenAI .NET library supports experimental distributed tracing and metrics with OpenTelemetry. Check out [Observability with OpenTelemetry](./docs/observability.md) for more details.
+OpenAI .NET library supports experimental distributed tracing and metrics with OpenTelemetry. Check out [Observability with OpenTelemetry](./docs/observability.md) for more details.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -856,4 +856,4 @@ By default, the client classes will automatically retry the following errors up

		### Observability

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