OpenAIClient クラス

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

指定された音声オーディオ ファイル データから文字起こしされたテキストと関連付けられたメタデータを取得します。 音声は、読み上げられた言語に対応する書き込み言語で文字起こしされます。

Parameters:

Returns:

public String getAudioTranscriptionAsPlainText(String deploymentOrModelName, AudioTranscriptionOptions audioTranscriptionOptions)

指定された音声データから文字起こしされたテキストと関連付けられたメタデータを取得します。 音声は、読み上げられた言語に対応する書き込み言語で文字起こしされます。

Parameters:

Returns:

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:

Returns:

public AudioTranscription getAudioTranscriptionAsResponseObject(String deploymentOrModelName, AudioTranscriptionOptions audioTranscriptionOptions)

指定された音声データから文字起こしされたテキストと関連付けられたメタデータを取得します。 音声は、読み上げられた言語に対応する書き込み言語で文字起こしされます。

Parameters:

Returns:

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:

Returns:

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

指定された音声オーディオ ファイル データから文字起こしされたテキストと関連付けられたメタデータを取得します。 音声は、読み上げられた言語に対応する書き込み言語で文字起こしされます。

Parameters:

Returns:

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

指定された音声オーディオ ファイル データから文字起こしされたテキストと関連するメタデータを取得します。 音声は、読み上げられた言語に対応する書き込み言語で文字起こしされます。

Parameters:

Returns:

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

指定された音声オーディオ ファイル データから文字起こしされたテキストと関連するメタデータを取得します。 音声は、読み上げられた言語に対応する書き込み言語で文字起こしされます。

Parameters:

Returns:

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

指定された音声オーディオ ファイル データから英語の文字起こしテキストと関連メタデータを取得します。

Parameters:

Returns:

public String getAudioTranslationAsPlainText(String deploymentOrModelName, AudioTranslationOptions audioTranslationOptions)

英語で文字起こしされたテキストと、指定された音声データから関連するメタデータを取得します。

Parameters:

Returns:

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:

Returns:

public AudioTranslation getAudioTranslationAsResponseObject(String deploymentOrModelName, AudioTranslationOptions audioTranslationOptions)

英語で文字起こしされたテキストと、指定された音声データから関連するメタデータを取得します。

Parameters:

Returns:

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:

Returns:

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

指定された音声オーディオ ファイル データから英語の文字起こしテキストと関連メタデータを取得します。

Parameters:

Returns:

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

指定された音声オーディオ ファイル データから英語の文字起こしテキストと関連メタデータを取得します。

Parameters:

Returns:

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

指定された音声オーディオ ファイル データから英語の文字起こしテキストと関連メタデータを取得します。

Parameters:

Returns:

public ChatCompletions getChatCompletions(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)

指定されたチャット メッセージのチャット完了を取得します。 入力候補は、さまざまなタスクをサポートし、指定されたプロンプト データから継続または "完了" するテキストを生成します。

Parameters:

Returns:

public IterableStream getChatCompletionsStream(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)

指定されたチャット メッセージのチャット完了を取得します。 チャットの完了は、さまざまなタスクをサポートし、指定されたプロンプト データから継続または "完了" するテキストを生成します。

Parameters:

Returns:

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:

Returns:

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:

Returns:

public Completions getCompletions(String deploymentOrModelName, CompletionsOptions completionsOptions)

指定された入力プロンプトの入力候補を取得します。 入力候補は、さまざまなタスクをサポートし、指定されたプロンプト データから継続または "完了" するテキストを生成します。

Parameters:

Returns:

public Completions getCompletions(String deploymentOrModelName, String prompt)

指定された入力プロンプトの入力候補を取得します。 入力候補は、さまざまなタスクをサポートし、指定されたプロンプト データから継続または "完了" するテキストを生成します。

Parameters:

Returns:

public IterableStream getCompletionsStream(String deploymentOrModelName, CompletionsOptions completionsOptions)

指定された入力プロンプトのストリームとして入力候補を取得します。 入力候補は、さまざまなタスクをサポートし、指定されたプロンプト データから継続または "完了" するテキストを生成します。

Parameters:

Returns:

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:

Returns:

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:

Returns:

public Embeddings getEmbeddings(String deploymentOrModelName, EmbeddingsOptions embeddingsOptions)

指定されたプロンプトの埋め込みを返却します。

Parameters:

Returns:

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:

Returns:

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:

Returns:

public ImageResponse getImages(ImageGenerationOptions imageGenerationOptions)

テキスト キャプションから画像のバッチの生成を開始します。

Parameters:

Returns: