Package com.azure.ai.openai

Class OpenAIAsyncClient

java.lang.Object
com.azure.ai.openai.OpenAIAsyncClient
public final class OpenAIAsyncClient extends Object
Initializes a new instance of the asynchronous OpenAIClient type.

  • Method Details

    • getEmbeddingsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getEmbeddingsWithResponse(String deploymentId, com.azure.core.util.BinaryData embeddingsOptions, com.azure.core.http.rest.RequestOptions requestOptions)
      Return the embeddings for a given prompt.

      Request Body Schema 

      
 {
     user: String (Optional)
     model: String (Optional)
     input (Required): [
         String (Required)
     ]
 }

      Response Body Schema 

      
 {
     data (Required): [
          (Required){
             embedding (Required): [
                 double (Required)
             ]
             index: int (Required)
         }
     ]
     usage (Required): {
         prompt_tokens: int (Required)
         total_tokens: int (Required)
     }
 }
      Parameters:
      deploymentId - deployment id of the deployed model.
      embeddingsOptions - The configuration information for an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getCompletionsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getCompletionsWithResponse(String deploymentId, com.azure.core.util.BinaryData completionsOptions, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.

      Request Body Schema 

      
 {
     prompt (Required): [
         String (Required)
     ]
     max_tokens: Integer (Optional)
     temperature: Double (Optional)
     top_p: Double (Optional)
     logit_bias (Optional): {
         String: int (Optional)
     }
     user: String (Optional)
     n: Integer (Optional)
     logprobs: Integer (Optional)
     echo: Boolean (Optional)
     stop (Optional): [
         String (Optional)
     ]
     presence_penalty: Double (Optional)
     frequency_penalty: Double (Optional)
     best_of: Integer (Optional)
     stream: Boolean (Optional)
     model: String (Optional)
 }

      Response Body Schema 

      
 {
     id: String (Required)
     created: int (Required)
     choices (Required): [
          (Required){
             text: String (Required)
             index: int (Required)
             logprobs (Required): {
                 tokens (Required): [
                     String (Required)
                 ]
                 token_logprobs (Required): [
                     double (Required)
                 ]
                 top_logprobs (Required): [
                      (Required){
                         String: double (Required)
                     }
                 ]
                 text_offset (Required): [
                     int (Required)
                 ]
             }
             finish_reason: String(stopped/tokenLimitReached/contentFiltered) (Required)
         }
     ]
     usage (Required): {
         completion_tokens: int (Required)
         prompt_tokens: int (Required)
         total_tokens: int (Required)
     }
 }
      Parameters:
      deploymentId - deployment id of the deployed model.
      completionsOptions - The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getChatCompletionsWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>> getChatCompletionsWithResponse(String deploymentId, com.azure.core.util.BinaryData chatCompletionsOptions, com.azure.core.http.rest.RequestOptions requestOptions)
      Gets chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.

      Request Body Schema 

      
 {
     messages (Required): [
          (Required){
             role: String(system/assistant/user) (Required)
             content: String (Optional)
         }
     ]
     max_tokens: Integer (Optional)
     temperature: Double (Optional)
     top_p: Double (Optional)
     logit_bias (Optional): {
         String: int (Optional)
     }
     user: String (Optional)
     n: Integer (Optional)
     stop (Optional): [
         String (Optional)
     ]
     presence_penalty: Double (Optional)
     frequency_penalty: Double (Optional)
     stream: Boolean (Optional)
     model: String (Optional)
 }

      Response Body Schema 

      
 {
     id: String (Required)
     created: int (Required)
     choices (Required): [
          (Required){
             message (Optional): {
                 role: String(system/assistant/user) (Required)
                 content: String (Optional)
             }
             index: int (Required)
             finish_reason: String(stopped/tokenLimitReached/contentFiltered) (Required)
             delta (Optional): {
                 role: String(system/assistant/user) (Optional)
                 content: String (Optional)
             }
         }
     ]
     usage (Required): {
         completion_tokens: int (Required)
         prompt_tokens: int (Required)
         total_tokens: int (Required)
     }
 }
      Parameters:
      deploymentId - deployment id of the deployed model.
      chatCompletionsOptions - The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data along with Response on successful completion of Mono.
      Throws:
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getEmbeddings

      public Mono<Embeddings> getEmbeddings(String deploymentId, EmbeddingsOptions embeddingsOptions)
      Return the embeddings for a given prompt.
      Parameters:
      deploymentId - deployment id of the deployed model.
      embeddingsOptions - The configuration information for an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.
      Returns:
      representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getCompletions

      public Mono<Completions> getCompletions(String deploymentId, CompletionsOptions completionsOptions)
      Gets completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Parameters:
      deploymentId - deployment id of the deployed model.
      completionsOptions - The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Returns:
      completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getCompletions

      public Mono<Completions> getCompletions(String deploymentId, String prompt)
      Gets completions for the provided input prompt. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Parameters:
      deploymentId - deployment id of the deployed model.
      prompt - The prompt to generate completion text from.
      Returns:
      completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getCompletionsStream

      public Flux<Completions> getCompletionsStream(String deploymentId, CompletionsOptions completionsOptions)
      Gets completions as a stream for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Parameters:
      deploymentId - deployment id of the deployed model.
      completionsOptions - The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Returns:
      a Flux of completions for the provided input prompts. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getChatCompletions

      public Mono<ChatCompletions> getChatCompletions(String deploymentId, ChatCompletionsOptions chatCompletionsOptions)
      Gets chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Parameters:
      deploymentId - deployment id of the deployed model.
      chatCompletionsOptions - The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Returns:
      chat completions for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getChatCompletionsStream

      public Flux<ChatCompletions> getChatCompletionsStream(String deploymentId, ChatCompletionsOptions chatCompletionsOptions)
      Gets chat completions for the provided chat messages. Chat completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Parameters:
      deploymentId - deployment id of the deployed model.
      chatCompletionsOptions - The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Returns:
      chat completions stream for the provided chat messages. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.
      com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.