OpenAIAsyncClient Class
- java.
lang. Object - com.
azure. ai. openai. OpenAIAsyncClient
- com.
public final class OpenAIAsyncClient
Initializes a new instance of the asynchronous OpenAIClient type.
Method Summary
Methods inherited from java.lang.Object
Method Details
cancelBatch
public Mono
Gets details for a single batch specified by the given batchID.
Parameters:
Returns:
cancelBatchWithResponse
public Mono
Gets details for a single batch specified by the given batchID.
Response Body Schema
{
id: String (Required)
object: String (Required)
endpoint: String (Optional)
errors (Optional): {
object: String (Required)
data (Optional): [
(Optional){
code: String (Optional)
message: String (Optional)
param: String (Optional)
line: Integer (Optional)
}
]
}
input_file_id: String (Required)
completion_window: String (Optional)
status: String(validating/failed/in_progress/finalizing/completed/expired/cancelling/cancelled) (Optional)
output_file_id: String (Optional)
error_file_id: String (Optional)
created_at: Long (Optional)
in_progress_at: Long (Optional)
expires_at: Long (Optional)
finalizing_at: Long (Optional)
completed_at: Long (Optional)
failed_at: Long (Optional)
expired_at: Long (Optional)
cancelling_at: Long (Optional)
cancelled_at: Long (Optional)
request_counts (Optional): {
total: Integer (Optional)
completed: Integer (Optional)
failed: Integer (Optional)
}
metadata (Optional): {
String: String (Required)
}
}
Parameters:
Returns:
createBatch
public Mono
Creates and executes a batch from an uploaded file of requests. Response includes details of the enqueued job including job status. The ID of the result file is added to the response once complete.
Parameters:
Returns:
createBatchWithResponse
public Mono
Creates and executes a batch from an uploaded file of requests. Response includes details of the enqueued job including job status. The ID of the result file is added to the response once complete.
Request Body Schema
{
endpoint: String (Required)
input_file_id: String (Required)
completion_window: String (Required)
metadata (Optional): {
String: String (Required)
}
}
Response Body Schema
{
id: String (Required)
object: String (Required)
endpoint: String (Optional)
errors (Optional): {
object: String (Required)
data (Optional): [
(Optional){
code: String (Optional)
message: String (Optional)
param: String (Optional)
line: Integer (Optional)
}
]
}
input_file_id: String (Required)
completion_window: String (Optional)
status: String(validating/failed/in_progress/finalizing/completed/expired/cancelling/cancelled) (Optional)
output_file_id: String (Optional)
error_file_id: String (Optional)
created_at: Long (Optional)
in_progress_at: Long (Optional)
expires_at: Long (Optional)
finalizing_at: Long (Optional)
completed_at: Long (Optional)
failed_at: Long (Optional)
expired_at: Long (Optional)
cancelling_at: Long (Optional)
cancelled_at: Long (Optional)
request_counts (Optional): {
total: Integer (Optional)
completed: Integer (Optional)
failed: Integer (Optional)
}
metadata (Optional): {
String: String (Required)
}
}
Parameters:
Returns:
deleteFile
public Mono
Delete a previously uploaded file.
Parameters:
Returns:
deleteFileWithResponse
public Mono
Delete a previously uploaded file.
Response Body Schema
{
id: String (Required)
deleted: boolean (Required)
object: String (Required)
}
Parameters:
Returns:
generateSpeechFromText
public Mono
Generates text-to-speech audio from the input text.
Parameters:
Returns:
generateSpeechFromTextWithResponse
public Mono
Generates text-to-speech audio from the input text.
Request Body Schema
{
input: String (Required)
voice: String(alloy/echo/fable/onyx/nova/shimmer) (Required)
response_format: String(mp3/opus/aac/flac) (Optional)
speed: Double (Optional)
}
Response Body Schema
BinaryData
Parameters:
Returns:
getAudioTranscription
public Mono
Gets transcribed text and associated metadata from provided spoken audio file data. Audio will be transcribed in the written language corresponding to the language it was spoken in.
Parameters:
Returns:
getAudioTranscriptionAsPlainText
public Mono
Gets transcribed text and associated metadata from provided spoken audio data. Audio will be transcribed in the written language corresponding to the language it was spoken in.
Parameters:
Returns:
getAudioTranscriptionText
public Mono
Gets transcribed text and associated metadata from provided spoken audio file data. Audio will be transcribed in the written language corresponding to the language it was spoken in.
Parameters:
Returns:
getAudioTranscriptionTextWithResponse
public Mono
Gets transcribed text and associated metadata from provided spoken audio file data. Audio will be transcribed in the written language corresponding to the language it was spoken in.
Parameters:
Returns:
getAudioTranscriptionWithResponse
public Mono
Gets transcribed text and associated metadata from provided spoken audio file data. Audio will be transcribed in the written language corresponding to the language it was spoken in.
Parameters:
Returns:
getAudioTranslation
public Mono
Gets English language transcribed text and associated metadata from provided spoken audio file data.
Parameters:
Returns:
getAudioTranslationAsPlainText
public Mono
Gets English language transcribed text and associated metadata from provided spoken audio data.
Parameters:
Returns:
getAudioTranslationText
public Mono
Gets English language transcribed text and associated metadata from provided spoken audio file data.
Parameters:
Returns:
getAudioTranslationTextWithResponse
public Mono
Gets English language transcribed text and associated metadata from provided spoken audio file data.
Parameters:
Returns:
getAudioTranslationWithResponse
public Mono
Gets English language transcribed text and associated metadata from provided spoken audio file data.
Parameters:
Returns:
getBatch
public Mono
Gets details for a single batch specified by the given batchID.
Parameters:
Returns:
getBatchWithResponse
public Mono
Gets details for a single batch specified by the given batchID.
Response Body Schema
{
id: String (Required)
object: String (Required)
endpoint: String (Optional)
errors (Optional): {
object: String (Required)
data (Optional): [
(Optional){
code: String (Optional)
message: String (Optional)
param: String (Optional)
line: Integer (Optional)
}
]
}
input_file_id: String (Required)
completion_window: String (Optional)
status: String(validating/failed/in_progress/finalizing/completed/expired/cancelling/cancelled) (Optional)
output_file_id: String (Optional)
error_file_id: String (Optional)
created_at: Long (Optional)
in_progress_at: Long (Optional)
expires_at: Long (Optional)
finalizing_at: Long (Optional)
completed_at: Long (Optional)
failed_at: Long (Optional)
expired_at: Long (Optional)
cancelling_at: Long (Optional)
cancelled_at: Long (Optional)
request_counts (Optional): {
total: Integer (Optional)
completed: Integer (Optional)
failed: Integer (Optional)
}
metadata (Optional): {
String: String (Required)
}
}
Parameters:
Returns:
getChatCompletions
public Mono
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:
Returns:
getChatCompletionsStream
public Flux
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:
Returns:
getChatCompletionsStreamWithResponse
public Flux
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.
Code Samples
openAIAsyncClient
.getChatCompletionsStreamWithResponse(deploymentOrModelId, new ChatCompletionsOptions(chatMessages),
new RequestOptions().setHeader("my-header", "my-header-value"))
.subscribe(response -> System.out.print(response.getValue().getId()),
error -> System.err.println("There was an error getting chat completions." + error),
() -> System.out.println("Completed called getChatCompletionsStreamWithResponse."));
Parameters:
Returns:
getChatCompletionsWithResponse
public Mono
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:
Returns:
getChatCompletionsWithResponse
public Mono
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:
Returns:
getCompletions
public Mono
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:
Returns:
getCompletions
public Mono
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:
Returns:
getCompletionsStream
public Flux
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.
Code Samples
openAIAsyncClient
.getChatCompletionsStream(deploymentOrModelId, new ChatCompletionsOptions(chatMessages))
.subscribe(
chatCompletions -> System.out.print(chatCompletions.getId()),
error -> System.err.println("There was an error getting chat completions." + error),
() -> System.out.println("Completed called getChatCompletionsStream."));
Parameters:
Returns:
getCompletionsWithResponse
public Mono
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:
Returns:
getCompletionsWithResponse
public Mono
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:
Returns:
getEmbeddings
public Mono
Return the embeddings for a given prompt.
Parameters:
Returns:
getEmbeddingsWithResponse
public Mono
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:
Returns:
getEmbeddingsWithResponse
public Mono
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:
Returns:
getFile
public Mono
Returns information about a specific file. Does not retrieve file content.
Parameters:
Returns:
getFileContent
public Mono
Returns information about a specific file. Does not retrieve file content.
Parameters:
Returns:
getFileContentWithResponse
public Mono
Returns information about a specific file. Does not retrieve file content.
Response Body Schema
byte[]
Parameters:
Returns:
getFileWithResponse
public Mono
Returns information about a specific file. Does not retrieve file content.
Response Body Schema
{
object: String (Required)
id: String (Required)
bytes: int (Required)
filename: String (Required)
created_at: long (Required)
purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
status_details: String (Optional)
}
Parameters:
Returns:
getImageGenerations
public Mono
Creates an image given a prompt.
Parameters:
Returns:
getImageGenerationsWithResponse
public Mono
Creates an image given a prompt.
Request Body Schema
{
model: String (Optional)
prompt: String (Required)
n: Integer (Optional)
size: String(256x256/512x512/1024x1024/1792x1024/1024x1792) (Optional)
response_format: String(url/b64_json) (Optional)
quality: String(standard/hd) (Optional)
style: String(natural/vivid) (Optional)
user: String (Optional)
}
Response Body Schema
{
created: long (Required)
data (Required): [
(Required){
url: String (Optional)
b64_json: String (Optional)
revised_prompt: String (Optional)
}
]
}
Parameters:
Returns:
listBatches
public Mono
Gets a list of all batches owned by the Azure OpenAI resource.
Returns:
listBatches
public Mono
Gets a list of all batches owned by the Azure OpenAI resource.
Parameters:
Returns:
listBatchesWithResponse
public Mono
Gets a list of all batches owned by the Azure OpenAI resource.
Query Parameters
| ----- | ------- | -------- | ------------------------------------------------------------------- |
| Name | Type | Required | Description |
| after | String | No | Identifier for the last event from the previous pagination request. |
| limit | Integer | No | Number of batches to retrieve. Defaults to 20. |
You can add these to a request with RequestOptions#addQueryParam
Response Body Schema
{
object: String (Required)
data (Optional): [
(Optional){
id: String (Required)
object: String (Required)
endpoint: String (Optional)
errors (Optional): {
object: String (Required)
data (Optional): [
(Optional){
code: String (Optional)
message: String (Optional)
param: String (Optional)
line: Integer (Optional)
}
]
}
input_file_id: String (Required)
completion_window: String (Optional)
status: String(validating/failed/in_progress/finalizing/completed/expired/cancelling/cancelled) (Optional)
output_file_id: String (Optional)
error_file_id: String (Optional)
created_at: Long (Optional)
in_progress_at: Long (Optional)
expires_at: Long (Optional)
finalizing_at: Long (Optional)
completed_at: Long (Optional)
failed_at: Long (Optional)
expired_at: Long (Optional)
cancelling_at: Long (Optional)
cancelled_at: Long (Optional)
request_counts (Optional): {
total: Integer (Optional)
completed: Integer (Optional)
failed: Integer (Optional)
}
metadata (Optional): {
String: String (Required)
}
}
]
first_id: String (Optional)
last_id: String (Optional)
has_more: Boolean (Optional)
}
Parameters:
Returns:
listFiles
public Mono
Gets a list of previously uploaded files.
Returns:
listFiles
public Mono
Gets a list of previously uploaded files.
Parameters:
Returns:
listFilesWithResponse
public Mono
Gets a list of previously uploaded files.
Query Parameters
| ------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Type | Required | Description |
| purpose | String | No | A value that, when provided, limits list results to files matching the corresponding purpose. Allowed values: "fine-tune", "fine-tune-results", "assistants", "assistants\_output", "batch", "batch\_output", "vision". |
You can add these to a request with RequestOptions#addQueryParam
Response Body Schema
{
object: String (Required)
data (Required): [
(Required){
object: String (Required)
id: String (Required)
bytes: int (Required)
filename: String (Required)
created_at: long (Required)
purpose: String(fine-tune/fine-tune-results/assistants/assistants_output/batch/batch_output/vision) (Required)
status: String(uploaded/pending/running/processed/error/deleting/deleted) (Optional)
status_details: String (Optional)
}
]
}
Parameters:
Returns:
uploadFile
public Mono
Uploads a file for use by other operations.
Parameters:
Returns:
Applies to
Azure SDK for Java