次の方法で共有


OpenAIClient クラス

  • 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

メソッドの詳細

getAudioTranscription

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranscriptionOptionsfile表されるファイル名。
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 要求を送信する前に 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 要求を送信する前に HTTP 要求を構成するためのオプション。

Returns:

と共 Response<T>に、提供された音声データから文字起こしされたテキストと関連するメタデータ。

getAudioTranscriptionText

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranscriptionOptionsfile表されるファイル名。
audioTranscriptionOptions - オーディオ文字起こし要求の構成情報。

Returns:

指定された音声データから文字起こしされたテキストと関連するメタデータ。

getAudioTranscriptionTextWithResponse

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranscriptionOptionsfile表されるファイル名。
audioTranscriptionOptions - オーディオ文字起こし要求の構成情報。
requestOptions - HTTP クライアントが HTTP 要求を送信する前に HTTP 要求を構成するためのオプション。

Returns:

指定された音声データから文字起こしされたテキストと関連するメタデータ。

getAudioTranscriptionWithResponse

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranscriptionOptionsfile表されるファイル名。
audioTranscriptionOptions - オーディオ文字起こし要求の構成情報。
requestOptions - HTTP クライアントが HTTP 要求を送信する前に HTTP 要求を構成するためのオプション。

Returns:

AudioTranscription と共 Response<T>に、指定された音声オーディオ データから文字起こしされたテキストと関連するメタデータ。

getAudioTranslation

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranslationOptionsfile表されるファイル名。
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 要求を送信する前に 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 要求を送信する前に HTTP 要求を構成するためのオプション。

Returns:

英語で文字起こしされたテキストと、提供された音声データからの関連メタデータと と共 Response<T>に。

getAudioTranslationText

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranslationOptionsfile表されるファイル名。
audioTranslationOptions - オーディオ翻訳要求の構成情報。

Returns:

英語の文字起こしテキストと、提供された音声オーディオ ファイル データからの関連メタデータ。

getAudioTranslationTextWithResponse

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranslationOptionsfile表されるファイル名。
audioTranslationOptions - オーディオ翻訳要求の構成情報。
requestOptions - HTTP クライアントが HTTP 要求を送信する前に HTTP 要求を構成するためのオプション。

Returns:

英語の文字起こしテキストと、提供された音声オーディオ ファイル データからの関連メタデータと と共 Response<T>に。

getAudioTranslationWithResponse

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

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

Parameters:

deploymentOrModelName - この要求に使用するモデル デプロイ名 (Azure OpenAI を使用する場合) またはモデル名 (Azure 以外の OpenAI を使用する場合) のいずれかを指定します。
fileName - の フィールドAudioTranslationOptionsfile表されるファイル名。
audioTranslationOptions - オーディオ翻訳要求の構成情報。
requestOptions - HTTP クライアントが 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 要求を送信する前に 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 要求を送信する前に 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 要求を送信する前に 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 要求を送信する前に 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 要求を送信する前に 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 要求を送信する前に HTTP 要求を構成するためのオプション。

Returns:

埋め込み要求からの応答データの表現。 埋め込みでは、テキスト文字列の関連性が測定され、検索、クラスタリング、推奨事項、およびその他の同様のシナリオと共 Response<T>に一般的に使用されます。

getImages

public ImageResponse getImages(ImageGenerationOptions imageGenerationOptions)

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

Parameters:

imageGenerationOptions - イメージの生成に使用される要求データを表します。

Returns:

イメージ ImageResponse 生成結果の 。

適用対象