Azure/azure-sdk-for-java azure-ai-openai_1.0.0-beta.12

on GitHub

1.0.0-beta.12 (2024-10-22)

Features Added

• Added support for service API version 2024-08-01-preview.
• Structured Outputs can be enabled by setting the parameter strict: true in an API call with either a defined response format or function definitions.
  • Added refusal property in ChatChoiceLogProbabilityInfo, ChatMessageContentItem, ChatResponseMessage classes,
    and a new type of content item class ChatMessageRefusalContentItem to support refusal. refusal only works with structured output.
  • Added json_schema property in ChatCompletionsResponseFormat class to support JSON schema.
    New classes ChatCompletionsJsonSchemaResponseFormat and ChatCompletionsJsonSchemaResponseFormatJsonSchema are added to support JSON schema response format.
• Added support for uploading large files in multiple parts. New client methods createUpload, addUploadPart,
  completeUpload and cancelUpload introduced in OpenAIClient and OpenAIAsyncClient classes.
• Updated ChatRequestMessages derived classes,
  • ChatRequestSystemMessage content: String or ChatMessageTextContentItem[].
  • ChatRequestAssistantMessage content: String, ChatMessageTextContentItem[], ChatMessageRefusalContentItem[] or null.
  • ChatRequestToolMessage content: String or ChatMessageTextContentItem[].
• Added rerank_score property in AzureChatExtensionDataSourceResponseCitation class to support re-rank score.
• Added support for MongoDB chat extension. New classes MongoDBChatExtensionConfiguration, MongoDBChatExtensionParameters,
  and MongoDBChatExtensionParametersFieldsMapping are added to support MongoDB chat extension.
• Added username_and_password in OnYourDataAuthenticationOptions class and an input option classOnYourDataUsernameAndPasswordAuthenticationOptions to support username and password authentication.
• Added intergrated property in OnYourDataVectorizationSource class and OnYourDataVectorizationSourceType to support integrated vectorization source.

Breaking Changes

• Replaced FunctionDefintion by ChatCompletionsFunctionToolDefinitionFunction in ChatCompletionsFunctionToolDefinition class.
  FunctionDefintion only works for functions but not tools, The functions is deprecated.
• Removed azure_ml_index from AzureChatExtensionConfiguration class, and its response models AzureMachineLearningIndexConfiguration and AzureMachineLearningIndexChatExtensionParameters.
• Removed role_information from AzureSearchChatExtensionParameters, ElasticsearchChatExtensionParameters and PineconeChatExtensionParameters classes.

Other Changes

• Upgraded azure-core to version 1.53.0.
• Upgraded azure-core-http-netty to version 1.15.5.