你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

OpenAIClient 类

包:

com.azure.ai.openai

Maven 项目:

com.azure:azure-ai-openai:1.0.0-beta.5

• java.lang.Object
• • com.azure.ai.openai.OpenAIClient

public final class OpenAIClient

初始化同步 OpenAIClient 类型的新实例。

方法摘要

修饰符和类型	方法和描述
AudioTranscription	getAudioTranscription(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions) 从提供的语音音频文件数据中获取转录文本和关联的元数据。
String	getAudioTranscriptionAsPlainText(String deploymentOrModelName, AudioTranscriptionOptions audioTranscriptionOptions) 从提供的语音音频数据中获取听录的文本和关联的元数据。
Response<BinaryData>	getAudioTranscriptionAsPlainTextWithResponse(String deploymentOrModelName, BinaryData audioTranscriptionOptions, RequestOptions requestOptions) 从提供的语音音频数据中获取听录的文本和关联的元数据。
AudioTranscription	getAudioTranscriptionAsResponseObject(String deploymentOrModelName, AudioTranscriptionOptions audioTranscriptionOptions) 从提供的语音音频数据中获取听录的文本和关联的元数据。
Response<BinaryData>	getAudioTranscriptionAsResponseObjectWithResponse(String deploymentOrModelName, BinaryData audioTranscriptionOptions, RequestOptions requestOptions) 从提供的语音音频数据中获取听录的文本和关联的元数据。
String	getAudioTranscriptionText(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions) 从提供的语音音频文件数据中获取听录文本和关联的元数据。
Response<String>	getAudioTranscriptionTextWithResponse(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions, RequestOptions requestOptions) 从提供的语音音频文件数据中获取听录文本和关联的元数据。
Response<AudioTranscription>	getAudioTranscriptionWithResponse(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions, RequestOptions requestOptions) 从提供的语音音频文件数据中获取听录文本和关联的元数据。
AudioTranslation	getAudioTranslation(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions) 从提供的语音音频文件数据中获取英语转录文本和关联的元数据。
String	getAudioTranslationAsPlainText(String deploymentOrModelName, AudioTranslationOptions audioTranslationOptions) 从提供的语音音频数据中获取英语转录文本和关联的元数据。
Response<BinaryData>	getAudioTranslationAsPlainTextWithResponse(String deploymentOrModelName, BinaryData audioTranslationOptions, RequestOptions requestOptions) 从提供的语音音频数据中获取英语转录文本和关联的元数据。
AudioTranslation	getAudioTranslationAsResponseObject(String deploymentOrModelName, AudioTranslationOptions audioTranslationOptions) 从提供的语音音频数据中获取英语转录文本和关联的元数据。
Response<BinaryData>	getAudioTranslationAsResponseObjectWithResponse(String deploymentOrModelName, BinaryData audioTranslationOptions, RequestOptions requestOptions) 从提供的语音音频数据中获取英语转录文本和关联的元数据。
String	getAudioTranslationText(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions) 从提供的语音音频文件数据中获取英语转录文本和关联的元数据。
Response<String>	getAudioTranslationTextWithResponse(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions, RequestOptions requestOptions) 从提供的语音音频文件数据中获取英语转录文本和关联的元数据。
Response<AudioTranslation>	getAudioTranslationWithResponse(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions, RequestOptions requestOptions) 从提供的语音音频文件数据中获取英语转录文本和关联的元数据。
ChatCompletions	getChatCompletions(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions) 获取提供的聊天消息的聊天完成。
IterableStream<ChatCompletions>	getChatCompletionsStream(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions) 获取提供的聊天消息的聊天完成。
Response<ChatCompletions>	getChatCompletionsWithResponse(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, RequestOptions requestOptions) 获取提供的聊天消息的聊天完成。
Response<BinaryData>	getChatCompletionsWithResponse(String deploymentOrModelName, BinaryData chatCompletionsOptions, RequestOptions requestOptions) 获取提供的聊天消息的聊天完成。
Completions	getCompletions(String deploymentOrModelName, CompletionsOptions completionsOptions) 获取提供的输入提示的完成。
Completions	getCompletions(String deploymentOrModelName, String prompt) 获取提供的输入提示的完成。
IterableStream<Completions>	getCompletionsStream(String deploymentOrModelName, CompletionsOptions completionsOptions) 获取作为提供的输入提示的流的完成。
Response<Completions>	getCompletionsWithResponse(String deploymentOrModelName, CompletionsOptions completionsOptions, RequestOptions requestOptions) 获取提供的输入提示的完成。
Response<BinaryData>	getCompletionsWithResponse(String deploymentOrModelName, BinaryData completionsOptions, RequestOptions requestOptions) 获取提供的输入提示的完成。
Embeddings	getEmbeddings(String deploymentOrModelName, EmbeddingsOptions embeddingsOptions) 返回给定提示的嵌入。
Response<Embeddings>	getEmbeddingsWithResponse(String deploymentOrModelName, EmbeddingsOptions embeddingsOptions, RequestOptions requestOptions) 返回给定提示的嵌入。
Response<BinaryData>	getEmbeddingsWithResponse(String deploymentOrModelName, BinaryData embeddingsOptions, RequestOptions requestOptions) 返回给定提示的嵌入。
ImageResponse	getImages(ImageGenerationOptions imageGenerationOptions) 开始从文本描述文字生成一批图像。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

方法详细信息

getAudioTranscription

public AudioTranscription getAudioTranscription(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions)

从提供的语音音频文件数据中获取转录文本和关联的元数据。 音频将以与所讲语言对应的书面语言进行听录。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranscriptionOptions文件名。

audioTranscriptionOptions - 音频听录请求的配置信息。

Returns:

AudioTranscription 从提供的语音音频数据中转录文本和关联的元数据。

getAudioTranscriptionAsPlainText

public String getAudioTranscriptionAsPlainText(String deploymentOrModelName, AudioTranscriptionOptions audioTranscriptionOptions)

从提供的语音音频数据中获取听录的文本和关联的元数据。 音频将以与所讲语言对应的书面语言进行听录。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranscriptionOptions - 音频听录请求的配置信息。

Returns:

从提供的语音音频数据中转录文本和关联的元数据。

getAudioTranscriptionAsPlainTextWithResponse

public Response getAudioTranscriptionAsPlainTextWithResponse(String deploymentOrModelName, BinaryData audioTranscriptionOptions, RequestOptions requestOptions)

从提供的语音音频数据中获取听录的文本和关联的元数据。 音频将以与所讲语言对应的书面语言进行听录。

请求正文架构

{
     file: byte[] (Required)
     response_format: String(json/verbose_json/text/srt/vtt) (Optional)
     language: String (Optional)
     prompt: String (Optional)
     temperature: Double (Optional)
     model: String (Optional)
 }

响应正文架构

String

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranscriptionOptions - 音频听录请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置该请求的选项。

Returns:

从提供的语音音频数据中听录的文本和关联的元数据以及 Response<T>。

getAudioTranscriptionAsResponseObject

public AudioTranscription getAudioTranscriptionAsResponseObject(String deploymentOrModelName, AudioTranscriptionOptions audioTranscriptionOptions)

从提供的语音音频数据中获取听录的文本和关联的元数据。 音频将以与所讲语言对应的书面语言进行听录。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranscriptionOptions - 音频听录请求的配置信息。

Returns:

从提供的语音音频数据中转录文本和关联的元数据。

getAudioTranscriptionAsResponseObjectWithResponse

public Response getAudioTranscriptionAsResponseObjectWithResponse(String deploymentOrModelName, BinaryData audioTranscriptionOptions, RequestOptions requestOptions)

从提供的语音音频数据中获取听录的文本和关联的元数据。 音频将以与所讲语言对应的书面语言进行听录。

请求正文架构

{
     file: byte[] (Required)
     response_format: String(json/verbose_json/text/srt/vtt) (Optional)
     language: String (Optional)
     prompt: String (Optional)
     temperature: Double (Optional)
     model: String (Optional)
 }

响应正文架构

{
     text: String (Required)
     task: String(transcribe/translate) (Optional)
     language: String (Optional)
     duration: Double (Optional)
     segments (Optional): [
          (Optional){
             id: int (Required)
             start: double (Required)
             end: double (Required)
             text: String (Required)
             temperature: double (Required)
             avg_logprob: double (Required)
             compression_ratio: double (Required)
             no_speech_prob: double (Required)
             tokens (Required): [
                 int (Required)
             ]
             seek: int (Required)
         }
     ]
 }

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranscriptionOptions - 音频听录请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置该请求的选项。

Returns:

从提供的语音音频数据中听录的文本和关联的元数据以及 Response<T>。

getAudioTranscriptionText

public String getAudioTranscriptionText(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions)

从提供的语音音频文件数据中获取转录文本和关联的元数据。 音频将以与所使用的语言相对应的书面语言进行听录。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranscriptionOptions文件名。

audioTranscriptionOptions - 音频听录请求的配置信息。

Returns:

从提供的语音音频数据转录文本和关联的元数据。

getAudioTranscriptionTextWithResponse

public Response getAudioTranscriptionTextWithResponse(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions, RequestOptions requestOptions)

从提供的语音音频文件数据中获取听录文本和关联的元数据。 音频将以与所使用的语言相对应的书面语言进行听录。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranscriptionOptions文件名。

audioTranscriptionOptions - 音频听录请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置它的选项。

Returns:

从提供的语音音频数据转录文本和关联的元数据。

getAudioTranscriptionWithResponse

public Response getAudioTranscriptionWithResponse(String deploymentOrModelName, String fileName, AudioTranscriptionOptions audioTranscriptionOptions, RequestOptions requestOptions)

从提供的语音音频文件数据中获取听录文本和关联的元数据。 音频将以与所使用的语言相对应的书面语言进行听录。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranscriptionOptions文件名。

audioTranscriptionOptions - 音频听录请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置它的选项。

Returns:

AudioTranscription 从提供的语音音频数据 Response<T>以及听录文本和关联的元数据。

getAudioTranslation

public AudioTranslation getAudioTranslation(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions)

从提供的语音音频文件数据中获取英语转录文本和关联的元数据。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranslationOptions文件名。

audioTranslationOptions - 音频翻译请求的配置信息。

Returns:

AudioTranscription 来自提供的语音音频文件数据的英语转录文本和关联的元数据。

getAudioTranslationAsPlainText

public String getAudioTranslationAsPlainText(String deploymentOrModelName, AudioTranslationOptions audioTranslationOptions)

从提供的语音音频数据中获取英语转录文本和关联的元数据。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranslationOptions - 音频翻译请求的配置信息。

Returns:

来自提供的语音音频数据的英语转录文本和相关元数据。

getAudioTranslationAsPlainTextWithResponse

public Response getAudioTranslationAsPlainTextWithResponse(String deploymentOrModelName, BinaryData audioTranslationOptions, RequestOptions requestOptions)

从提供的语音音频数据中获取英语转录文本和关联的元数据。

请求正文架构

{
     file: byte[] (Required)
     response_format: String(json/verbose_json/text/srt/vtt) (Optional)
     prompt: String (Optional)
     temperature: Double (Optional)
     model: String (Optional)
 }

响应正文架构

String

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranslationOptions - 音频翻译请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置它的选项。

Returns:

来自提供的语音音频数据的英语转录文本和关联的元数据以及 Response<T>。

getAudioTranslationAsResponseObject

public AudioTranslation getAudioTranslationAsResponseObject(String deploymentOrModelName, AudioTranslationOptions audioTranslationOptions)

从提供的语音音频数据中获取英语转录文本和关联的元数据。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranslationOptions - 音频翻译请求的配置信息。

Returns:

来自提供的语音音频数据的英语转录文本和相关元数据。

getAudioTranslationAsResponseObjectWithResponse

public Response getAudioTranslationAsResponseObjectWithResponse(String deploymentOrModelName, BinaryData audioTranslationOptions, RequestOptions requestOptions)

从提供的语音音频数据中获取英语转录文本和关联的元数据。

请求正文架构

{
     file: byte[] (Required)
     response_format: String(json/verbose_json/text/srt/vtt) (Optional)
     prompt: String (Optional)
     temperature: Double (Optional)
     model: String (Optional)
 }

响应正文架构

{
     text: String (Required)
     task: String(transcribe/translate) (Optional)
     language: String (Optional)
     duration: Double (Optional)
     segments (Optional): [
          (Optional){
             id: int (Required)
             start: double (Required)
             end: double (Required)
             text: String (Required)
             temperature: double (Required)
             avg_logprob: double (Required)
             compression_ratio: double (Required)
             no_speech_prob: double (Required)
             tokens (Required): [
                 int (Required)
             ]
             seek: int (Required)
         }
     ]
 }

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

audioTranslationOptions - 音频翻译请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置它的选项。

Returns:

来自提供的语音音频数据的英语转录文本和关联的元数据以及 Response<T>。

getAudioTranslationText

public String getAudioTranslationText(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions)

从提供的语音音频文件数据中获取英语转录文本和关联的元数据。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranslationOptions文件名。

audioTranslationOptions - 音频翻译请求的配置信息。

Returns:

来自提供的语音音频文件数据的英语转录文本和关联的元数据。

getAudioTranslationTextWithResponse

public Response getAudioTranslationTextWithResponse(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions, RequestOptions requestOptions)

从提供的语音音频文件数据中获取英语转录文本和关联的元数据。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranslationOptions文件名。

audioTranslationOptions - 音频翻译请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置它的选项。

Returns:

从提供的语音音频文件数据 Response<T>以及 中听录的英语转录文本和关联的元数据。

getAudioTranslationWithResponse

public Response getAudioTranslationWithResponse(String deploymentOrModelName, String fileName, AudioTranslationOptions audioTranslationOptions, RequestOptions requestOptions)

从提供的语音音频文件数据中获取英语转录文本和关联的元数据。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

fileName - 在 的 字段中表示 file 的 AudioTranslationOptions文件名。

audioTranslationOptions - 音频翻译请求的配置信息。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置它的选项。

Returns:

AudioTranslation 从提供的语音音频文件数据 Response<T>以及 中听录的英语转录文本和关联的元数据。

getChatCompletions

public ChatCompletions getChatCompletions(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)

获取提供的聊天消息的聊天完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

chatCompletionsOptions - 聊天完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Returns:

提供的聊天消息的聊天完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

getChatCompletionsStream

public IterableStream getChatCompletionsStream(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)

获取提供的聊天消息的聊天完成。 聊天完成支持各种任务，并生成从提供的提示数据继续或“完成”的文本。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

chatCompletionsOptions - 聊天完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Returns:

提供的聊天消息的聊天完成流。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

getChatCompletionsWithResponse

public Response getChatCompletionsWithResponse(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, RequestOptions requestOptions)

获取提供的聊天消息的聊天完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

请求正文架构

{
     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)
 }

响应正文架构

{
     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:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

chatCompletionsOptions - 聊天完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置它的选项。

Returns:

提供的聊天消息的聊天完成。 完成支持各种任务，并生成继续或“完成”提供提示数据的文本以及 Response<T>。

getChatCompletionsWithResponse

public Response getChatCompletionsWithResponse(String deploymentOrModelName, BinaryData chatCompletionsOptions, RequestOptions requestOptions)

获取提供的聊天消息的聊天完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

请求正文架构

{
     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)
 }

响应正文架构

{
     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:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

chatCompletionsOptions - 聊天完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置该请求的选项。

Returns:

提供的聊天消息的聊天完成。 完成支持各种任务，并生成继续或“完成”提供提示数据的文本以及 Response<T>。

getCompletions

public Completions getCompletions(String deploymentOrModelName, CompletionsOptions completionsOptions)

获取提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

completionsOptions - 完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Returns:

提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

getCompletions

public Completions getCompletions(String deploymentOrModelName, String prompt)

获取提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

prompt - 从中生成完成文本的提示。

Returns:

提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

getCompletionsStream

public IterableStream getCompletionsStream(String deploymentOrModelName, CompletionsOptions completionsOptions)

获取作为提供的输入提示的流的完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

completionsOptions - 完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

Returns:

提供的 IterableStream<T> 输入提示的完成的 。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

getCompletionsWithResponse

public Response getCompletionsWithResponse(String deploymentOrModelName, CompletionsOptions completionsOptions, RequestOptions requestOptions)

获取提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

请求正文架构

{
     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)
 }

响应正文架构

{
     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:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

completionsOptions - 完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置该请求的选项。

Returns:

提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供提示数据的文本以及 Response<T>。

getCompletionsWithResponse

public Response getCompletionsWithResponse(String deploymentOrModelName, BinaryData completionsOptions, RequestOptions requestOptions)

获取提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

请求正文架构

{
     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)
 }

响应正文架构

{
     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:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

completionsOptions - 完成请求的配置信息。 完成支持各种任务，并生成继续或“完成”提供的提示数据的文本。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置该请求的选项。

Returns:

提供的输入提示的完成。 完成支持各种任务，并生成继续或“完成”提供提示数据的文本以及 Response<T>。

getEmbeddings

public Embeddings getEmbeddings(String deploymentOrModelName, EmbeddingsOptions embeddingsOptions)

返回给定提示的嵌入。

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

embeddingsOptions - 嵌入请求的配置信息。 嵌入可衡量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案。

Returns:

嵌入请求中的响应数据的表示形式。 嵌入可衡量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案。

getEmbeddingsWithResponse

public Response getEmbeddingsWithResponse(String deploymentOrModelName, EmbeddingsOptions embeddingsOptions, RequestOptions requestOptions)

返回给定提示的嵌入。

请求正文架构

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

响应正文架构

{
     data (Required): [
          (Required){
             embedding (Required): [
                 double (Required)
             ]
             index: int (Required)
         }
     ]
     usage (Required): {
         prompt_tokens: int (Required)
         total_tokens: int (Required)
     }
 }

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

embeddingsOptions - 嵌入请求的配置信息。 嵌入可衡量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置该请求的选项。

Returns:

嵌入请求中的响应数据的表示形式。 嵌入度量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案Response<T>。

getEmbeddingsWithResponse

public Response getEmbeddingsWithResponse(String deploymentOrModelName, BinaryData embeddingsOptions, RequestOptions requestOptions)

返回给定提示的嵌入。

请求正文架构

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

响应正文架构

{
     data (Required): [
          (Required){
             embedding (Required): [
                 double (Required)
             ]
             index: int (Required)
         }
     ]
     usage (Required): {
         prompt_tokens: int (Required)
         total_tokens: int (Required)
     }
 }

Parameters:

deploymentOrModelName - 指定使用 Azure OpenAI) 时 (模型部署名称，或使用非 Azure OpenAI) 用于此请求时 (模型名称。

embeddingsOptions - 嵌入请求的配置信息。 嵌入可衡量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案。

requestOptions - 用于在 HTTP 客户端发送 HTTP 请求之前配置该请求的选项。

Returns:

嵌入请求中的响应数据的表示形式。 嵌入度量文本字符串的相关性，通常用于搜索、聚类分析、建议和其他类似方案Response<T>。

getImages

public ImageResponse getImages(ImageGenerationOptions imageGenerationOptions)

开始从文本描述文字生成一批图像。

Parameters:

imageGenerationOptions - 表示用于生成图像的请求数据。

Returns:

ImageResponse映像生成结果的 。