azure-sdk-for-java

5.13.0 (2024-06-06)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (Unreleased)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (2024-06-06)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (2024-06-06)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (2024-06-06)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (2024-06-06)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (2024-06-06)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (2024-06-06)

Please refer to spring/CHANGELOG.md for more details.

5.13.0 (2024-06-06)

Features Added

• Added support for @Transient annotation - see PR 40401.

Bugs Fixed

• Fixing bug with annotated queries that have no where clause but do have a sort - See PR 40165.
• Fixing bug with Spring JPA keywords that don't lead to criteria creation - See PR 40204.

1.0.0-beta.3 (2024-06-06)

Features Added

Streaming

• Operation updates:
  • Added createRunStream, createThreadAndRunStream and submitToolOutputsToRunStream methods to AssistantsClient and AssistantsAsyncClient classes.
    A suite of classes extending from StreamUpdate were added for users to be able to consume the incremental updates from the service.

Assistants

• Model updates:
  • Assistant, AssistantCreationOptions and UpdateAssistantOptions models:
    • Added new fields: toolResources , temperature, topP and responseFormat.

Files

• Model updates:
  • OpenAIFile model changes:
    • Added new fields: status of FileState type and status_details of String type.
  • Added new enum FileState representing the type of the status field mentioned in the previous point.
  • Added new possible values for FilePurpose: batch, batch_output and vision.

Messages

• Operation updates:

  • Updated listMessages to accept the filter runId.

• Model updates:

  • Added new model MessageAttachment.
  • Updated docs renaming mentions of retrieval tool to file_search.
  • Added new field, startIndex and endIndex to MessageTextFileCitationAnnotation, MessageTextFilePathAnnotation model.

Run Step

• Model updates:
  • ThreadRun model updates:
    • Added fields: temperature, topP, maxPromptTokens, maxCompletionTokens, truncationStrategy, toolChoice and responseFormat.
  • Updated documentation for RunCompletionUsage.
  • CreateRunOptions model updates:
    • Added fields: additionalMessages, temperature, topP, maxPromptTokens, maxCompletionTokens, truncationStrategy, toolChoice and responseFormat.
  • CreateAndRunThreadOptions model updates:
    • Added fields: toolResources, temperature, topP, maxPromptTokens, maxCompletionTokens, truncationStrategy, toolChoice and responseFormat.
  • Added new model for all the truncationStrategy fields called TruncationObject.

Threads

• Model updates:
  • AssistantThread model now includes toolResources field as nullable.
  • AssistantThreadCreationOptions updates include: messages type using renamed type ThreadInitializationMessage -> ThreadMessageOptions, toolResources.

Tool Resources (new)

• Model updates:
  • There are 3 new models that were added: ToolResources, CreateToolResourcesOptions and UpdateToolResourcesOptions. As the name implies, wherever there is
    a field toolResource we use the appropriate type, depending on the model declaring it is meant to be a response object, create request object or update request object, respectively.

Vector Stores (new)

There are 3 main areas for vector stores into which its models and operations can be divided. That is vector stores themselves, vector store files and vector store file batches.

• Model updates:

  • new models (I will just list the top level response and request objects, but there are several subtypes describing more complex JSON object fields): VectorStore and VectorStoreOptions, VectorStoreFile and there is no request object, VectorStoreFileBatch and there is no request object.

• Operation Updates:

  • new operations listVectorStores , createVectorStore, getVectorStore, modifyVectorStore and deleteVectorStore.
  • new vector store file operations: listVectorStoreFiles, createVectorStoreFile, getVectorStoreFile and deleteVectorStoreFile.
  • new vector store file batch operations: createVectorStoreFileBatch, getVectorStoreFileBatch, cancelVectorStoreFileBatch and listVectorStoreFileBatchFiles.

Breaking Changes

Assistants

• Model updates:
  • Removed AssistantFile model.
  • Assistant, AssistantCreateOptions and UpdateAssistantOptions models:
    • removed fields: fileIds.
• Operation updates:
  • Removed operations: createAssistantFile , listAssistantFiles, getAssistantFile and deleteAssistantFile.

Files

• Removed method uploadFile(FileDetails file, FilePurpose purpose). Use uploadFile(FileDetails file, FilePurpose purpose, String fileName) instead

Messages

• Model updates:

  • Renamed ThreadInitializationMessage to ThreadMessageOptions.
  • Removed MessageFile model.
  • Updated ThreadMessage model:
    • The field incomplete_details was of the wrong type. Corrected from MessageIncompleteDetailsReason -> MessageIncompleteDetails.
    • assistantId was marked as optional, but it was in fact nullable
    • runId was marked as optional, but it was in fact nullable
    • Removed field fileIds
    • Added new field attachments a nullable array of MessageAttachment

• Operation updates:

  • Removed MessageFile related operations: listMessageFiles and getMessageFile
  • Updated createMessage to accept the ThreadMessageOptions model (also used in AssistantThreadCreationOptions)

Run Step

• Model updates:
  • ThreadRun model updates:
    • Removed field fileIds

Threads

• Model updates:

  • Extracted fields used in updateThread operation into model UpdateAssistantThreadOptions which now includes the new fields toolResources.

• Operation updates:

  • updateThread using extracted model UpdatedAssistantThreadOptions instead of parameters using the spread operator.

Tools

• Model updates: (mostly about renaming tool retrieval to file_search)
  • Renamed model RetrievalToolDefinition to FileSearchToolDefinition and the associated discriminator value.
  • Renamed model RunStepDeltaRetrievalToolCall to RunStepDeltaFileSearchToolCall.
  • RunStepToolCall variant RunStepRetrievalToolCall renamed to RunStepFileSearchToolCall and the associated discriminator value.

Bugs Fixed

• A combination of inputs for uploadFile would allow users to not send String filename to the service resulting always in an error, as this is actually mandatory.

Other Changes

Dependency Updates

• Upgraded azure-core to version 1.49.1.
• Upgraded azure-core-http-netty to version 1.15.1.

1.0.0-beta.9 (2024-06-06)

Features Added

• Added support for service API versions, 2024-04-01-preview and 2024-05-01-preview.
• Note that AOAI refers to Azure OpenAI and OAI refers to OpenAI.
• Added timestamp granularity to Whisper transcription; this is an array of enumerated string values
  (word and/or segment) that controls which, if any, timestamp information is emitted to transcription results.
  • AudioTranscriptionTimestampGranularity enum to represent the timestamp granularity options for Whisper transcription.
  • AudioTranscriptionWord class to represent the word timestamp information in the transcription results.
• Added two new audio formats, wav and pcm, to the SpeechGenerationResponseFormat enum.

AOAI ONLY

• Added a new RAI content filter schema type, ContentFilterDetailedResults, that features:
  • The boolean filtered property from ContentFilterResult.
  • An array named details of the existing ContentFilterBlocklistIdResult type, each of which has:
    • The base boolean filtered
    • A string id
• Added a new property indirectAttack in ContentFilterResultDetailsForPrompt class to represent the indirect attack results.
• Added a new property custom_blocklists in ImageGenerationPromptFilterResults class to represent the prompt filter results.

On Your Data

• New string enum type used in options: OnYourDataContextProperty: "citations" | "intent" | "allRetrievedDocuments"
  • This is used in arrays like a bitmasked flag; "give me citations and documents" == [ "citations", "allRetrievedDocuments" ]
  • It's not dissimilar to how transcription uses timestamp_granularities[]
• New model type used in response extensions: retrievedDocument
  • Inherits from existing citation
  • Required properties: content (string, inherited), search_queries (array of strings), data_source_index (int32), original_search_score (double)
  • Optional properties: title, url, filepath, chunk_id (all strings inherited from citation); re_rank_score (double)
• New options fields for chat extension parameters (request options):
  • max_search_queries (optional int32)
  • allow_partial_result (optional boolean)
  • include_contexts (optional array of the above OnYourDataContextProperty enum (effective flag selection))
  • Affected *parameters types:
    • AzureSearchChatExtensionParameters
    • AzureMachineLearningIndexChatExtensionParameters
    • AzureCosmosDBChatExtensionParameters
    • ElasticsearchChatExtensionParameters
    • PineconeChatExtensionParameters
• Vectorization source types have a new dimensions property (optional int32)
  • Affected: OnYourDataEndpointVectorizationSource, OnYourDataDeploymentNameVectorizationSource
• AzureSearchChatExtensionParameters now supports OnYourDataAccessTokenAuthenticationOptions in its named authentication field
• OnYourDataEndpointVectorizationSource now supports OnYourDataAccessTokenAuthenticationOptions for its named authentication field.
• Added new class OnYourDataVectorSearchAuthenticationType, OnYourDataVectorSearchAuthenticationOptions,
  OnYourDataVectorSearchApiKeyAuthenticationOptions, OnYourDataVectorSearchAccessTokenAuthenticationOptions for the
  vector search authentication options.
• The response extension type AzureChatExtensionsMessageContext has a new all_retrieved_documents field, which is an optional array of the new retrievedDocument type defined earlier.

Breaking Changes

• Replaced Jackson Databind annotations with azure-json functionality for OpenAI service models.
• [AOAI] Added a new class ContentFilterDetailedResults to represent detailed content filter results, which replaces the
  customBlocklists response property type, List<ContentFilterBlocklistIdResult> in
  ContentFilterResultDetailsForPrompt and ContentFilterResultsForChoice class.
• [AOAI] Replaced OnYourDataAuthenticationOptions with OnYourDataVectorSearchAuthenticationOptions in the OnYourDataEndpointVectorizationSource class.
  Currently, OnYourDataEndpointVectorizationSource only supports OnYourDataApiKeyAuthenticationOptions and OnYourDataAccessTokenAuthenticationOptions as authentication options.

Other Changes

Dependency Updates

• Upgraded azure-core to version 1.49.1.
• Upgraded azure-core-http-netty to version 1.15.1.

1.0.0-beta.47 (2024-06-06)

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.
• Upgraded OpenTelemetry from 1.37.0 to 1.38.0.

1.26.0 (2024-06-06)

Features Added

• Added InterceptoprManager.removeSanitizers to remove sanitizers used by Test Proxy.

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.

1.4.13 (2024-06-06)

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.

1.2.13 (2024-06-06)

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.

1.0.0-beta.47 (2024-06-06)

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.

1.0.0-beta.20 (2024-06-06)

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.
• Upgraded opentelemetry-api from 1.37.0 to 1.38.0.

1.15.0 (2024-06-06)

Features Added

• Added new Azure region Region.ISRAEL_CENTRAL.
• SubResource now implements JsonSerializable.

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.

1.0.0-beta.19 (2024-06-06)

Features Added

• Added support for response timeout and per-request response timeout. (#40017)

Breaking Changes

• Removed VertxAsyncHttpClientBuilder.idleTimeout, renamed readIdleTimeout to readTimeout and writeIdleTimeout
  to writeTimeout in VertxAsyncHttpClientBuilder. (#40017)

Other Changes

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.
• Upgraded Vertx from 4.5.7 to 4.5.8.

1.12.0 (2024-06-06)

Features Added

• Added support for response timeout and per-request response timeout. (#40017)

Other Changes

• Fixed errant warning about okio being included on the module path multiple times. (#40115)

Dependency Updates

• Upgraded azure-core from 1.49.0 to 1.49.1.