@azure/openai package

基になるキー値の更新をサポートする静的キーベースの資格情報。

Azure OpenAI と対話するためのクライアント。

クライアントには、OpenAI リソースのエンドポイントと、API キーやトークンなどの認証方法が必要です。 API キーとエンドポイントは、OpenAI リソース ページにあります。 これらは、リソースの [キーとエンドポイント] ページに配置されます。

認証の例:

API キー

import { OpenAIClient } from "@azure/openai";
import { AzureKeyCredential } from "@azure/core-auth";

const endpoint = "<azure endpoint>";
const credential = new AzureKeyCredential("<api key>");

const client = new OpenAIClient(endpoint, credential);

Azure Active Directory

import { OpenAIClient } from "@azure/openai";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "<azure endpoint>";
const credential = new DefaultAzureCredential();

const client = new OpenAIClient(endpoint, credential);

OpenAIKeyCredential クラスは OpenAI API キーを表し、OpenAI エンドポイントの OpenAI クライアントに対する認証に使用されます。

単純な文字起こし応答

文字起こし応答。

文字起こしセグメント。

使用可能な Azure OpenAI 拡張機能の構成を表します。

要求で指定された一致する入力を介して構成された、チャット完了に対する Azure 拡張機能の出力結果を表します。

1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、Azure OpenAI チャット拡張機能を使用して応答動作を拡張する必要があるチャット入力候補要求によって使用されます。 この構成の使用は、Azure OpenAI とのみ互換性があります。

Azure OpenAI チャット拡張機能が対応するチャット入力候補応答の生成に関与している場合に使用できる追加のコンテキスト情報の 1 つのインスタンス。 このコンテキスト情報は、一致する拡張機能を使用するように構成された Azure OpenAI 要求を使用する場合にのみ設定されます。

対応するチャット入力候補応答の生成に Azure OpenAI チャット拡張機能が関係している場合に使用できる追加のコンテキスト情報の表現。 このコンテキスト情報は、一致する拡張機能を使用するように構成された Azure OpenAI 要求を使用する場合にのみ設定されます。

Azure OpenAI の接地の強化に使用できるオプションを表します。

Azure OpenAI 光学式文字認識 (OCR) 拡張機能で使用できるオプションの表現。

Azure OpenAI チャット拡張機能として使用する場合の Azure Cosmos DB の構成可能なオプションの具体的な表現。

構成された Azure Cosmos DB リソースを使用する場合のフィールドの処理方法を制御するためのオプションの設定。

Azure OpenAI チャット拡張機能のオプション。

イメージで検出されたオブジェクトの境界ボックスを返す接地の機能強化。

Azure の接地の強化によって使用される単一の多角形ポイントの表現。

単語や選択マークなどのコンテンツ要素の隣接するシーケンスで構成されるコンテンツ行オブジェクト。

検出されたオブジェクトとその境界ボックス情報を表す span オブジェクト。

Azure OpenAI チャット拡張機能として使用する場合の Azure Machine Learning ベクター インデックスの構成可能なオプションの具体的な表現。

Azure OpenAI チャット拡張機能として使用する場合の Azure Searchの構成可能なオプションの具体的な表現。

構成された Azure Search リソースを使用する場合のフィールドの処理方法を制御するためのオプションの設定。

チャット完了要求全体の一部としての 1 つのプロンプト入力候補の表現。 一般に、 n 選択肢は指定されたプロンプトごとに生成され、既定値は 1 です。 トークンの制限やその他の設定では、生成される選択肢の数が制限される場合があります。

'logprobs' と 'top_logprobs' を介して要求された、選択肢の確率情報をログに記録します。

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

構成された関数ツールの評価でモデルによって発行される関数ツールのツール呼び出し。これは、後続のチャット完了要求を解決するために必要な関数呼び出しを表します。

ツール呼び出しに応答して関数を呼び出すことができるチャット入力候補関数ツールの定義情報。

チャットの完了を名前付き関数の使用に制限する特定の名前付き関数ツールのツール選択。

有効な JSON オブジェクトの出力に応答を制限するチャット入力候補の応答形式。

チャットの完了を名前付き関数の使用に制限する特定の名前付き関数ツールのツール選択。

チャット入力候補要求に使用する明示的な名前付きツール選択の抽象表現。

チャット入力候補で使用できる応答形式の構成の抽象的な表現。 JSON モードを有効にするために使用できます。

テキストを自由に生成でき、特定のスキーマに準拠する応答コンテンツを生成することは保証されていない標準のチャット完了応答形式。

要求されたチャット完了を実行するために後続の要求で解決する必要があるツール呼び出しの抽象的な表現。

モデルがチャット完了応答を改善するために使用できるツールの抽象的な表現。

チャットの完了応答が終了した理由に関する構造化された情報の抽象的な表現。

チャット メッセージ内の構造化コンテンツ アイテムの抽象的な表現。

イメージ参照を含む構造化チャット コンテンツアイテム。

モデルがイメージを取得できるインターネット上の場所。

プレーン テキストを含む構造化チャット コンテンツアイテム。

アシスタントからの応答またはアクションを表す要求チャット メッセージ。

構成された関数から要求された出力を表す要求チャット メッセージ。

要求で提供されるチャット メッセージの抽象的な表現。

モデルがチャット完了応答を生成する方法に影響を与えるシステム命令を含む要求チャット メッセージ。

構成されたツールから要求された出力を表す要求チャット メッセージ。

アシスタントへのユーザー入力を表す要求チャット メッセージ。

応答で受信したチャット メッセージの表現。

1 つのメッセージ コンテンツ トークンのログ確率情報の表現。

"top_logprobs" が要求された場合に最も可能性の高いトークンの一覧を含む、1 つのコンテンツ トークンのログ確率情報の表現。

全体的な入力候補要求の一部としての単一のプロンプト入力候補の表現。 一般に、 n 選択肢は指定されたプロンプトごとに生成され、既定値は 1 です。 トークンの制限やその他の設定では、生成される選択肢の数が制限される場合があります。

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

完了生成のログ確率モデルの表現。

完了要求に対して処理されたトークン数の表現。 カウントでは、プロンプト、選択肢、選択肢の代替、best_of世代、およびその他のコンシューマー全体のすべてのトークンが考慮されます。

コンテンツ フィルター処理によって実行されるカスタム ブロックリストに対する評価の結果を表します。

コンテンツ フィルター処理によって実行される保護されたリソースに対する検出操作の結果を表します。

コンテンツ フィルター処理によって実行される検出操作の結果を表します。

コンテンツ フィルター エラーの結果に関する情報。

フィルター処理されたコンテンツの重大度レベルに関する情報と、フィルター処理されたかどうかに関する情報。

要求内の 1 つのプロンプトに対するコンテンツ フィルター処理の結果。

コンテンツ フィルター処理の成功結果に関する情報。

生成されたモデル出力に対して評価されるコンテンツ フィルター処理に関する情報。

Elasticsearch を Azure OpenAI チャット拡張機能として使用する場合の構成可能なオプションの具体的な表現。

構成された Elasticsearch® リソースを使用する場合のフィールドの処理方法を制御するためのオプションの設定。

単一の埋め込み関連度比較の表現。

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

この要求と応答で使用されるトークンの量の測定。

読み取り可能で使い捨て可能なストリーム。

モデルによって生成された、呼び出される関数の名前と引数。

一致するユーザー入力に応じてチャット完了が呼び出すことができる呼び出し元指定の関数の定義。

チャットの完了操作を処理するときに使用する、要求が指定された特定の関数の正確な名前を指定する構造体。

オーディオ文字起こし要求のオプション

オーディオ翻訳要求のオプション

このモジュールには、対応する生成されたモデルと並行してライブするモデルが含まれています。 これは、生成されたモデルとは異なる名前/型を持つ顧客向けモデルを提供する場合に便利です。

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

カスタム埋め込み要求に対する オプション

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

イメージ生成要求のコンテンツ フィルター結果について説明します。

base64 でエンコードされたデータまたはイメージの取得元となる URL として提供される、生成された 1 つのイメージの表現。

イメージ生成要求のプロンプトのコンテンツ フィルター結果について説明します。

イメージ生成操作が成功した結果。

モデルが自然に完了する前にトークンの制限に達したことを示す停止理由の構造化表現。

アクセス トークンを使用する場合の Azure OpenAI On Your Data の認証オプション。

API キーを使用する場合の Azure OpenAI On Your Data の認証オプション。

Azure OpenAI On Your Data の認証オプション。

接続文字列を使用する場合の Azure OpenAI On Your Data の認証オプション。

ベクター検索を適用するときに Azure OpenAI On Your Data によって使用されるベクター化ソースの詳細。これは、同じ Azure OpenAI リソース内の内部埋め込みモデルデプロイ名に基づいています。

Elasticsearch でエンコードされた API キーを使用する場合の Azure OpenAI On Your Data の認証オプション。

ベクター検索を適用するときに Azure OpenAI On Your Data によって使用されるベクター化ソースの詳細。埋め込み用のパブリック Azure OpenAI エンドポイント呼び出しに基づいています。

Elasticsearch キーとキー ID のペアを使用する場合の Azure OpenAI On Your Data の認証オプション。

ベクター検索を適用するときに Azure OpenAI On Your Data によって使用されるベクター化ソースの詳細。これは、検索サービス モデル ID に基づいています。 現在、Elasticsearch® でのみサポートされています。

システム割り当てマネージド ID を使用する場合の Azure OpenAI On Your Data の認証オプション。

ユーザー割り当てマネージド ID を使用する場合の Azure OpenAI On Your Data の認証オプション。

ベクター検索を使用した Azure OpenAI On Your Data のベクター化ソースの抽象表現。

Pinecone を Azure OpenAI チャット拡張機能として使用する場合の構成可能なオプションの具体的な表現。

構成された Pinecone リソースを使用する場合のフィールドの処理方法を制御するためのオプションの設定。

モデルによる自然終了を示す停止理由の構造化表現。

要求された応答形式に基づく文字起こしの結果の型

オーディオ タスクの結果形式

"文字起こし"、"translate"

AzureChatExtensionConfigurationUnion のエイリアス

"azure_search"、"azure_ml_index"、"azure_cosmos_db"、"elasticsearch"、"pinecone"

"simple"、"semantic"、"vector"、"vector_simple_hybrid"、"vector_semantic_hybrid"

ChatCompletionsNamedToolSelectionUnion のエイリアス

ChatCompletionsResponseFormatUnion のエイリアス

ChatCompletionsToolCallUnion のエイリアス

ChatCompletionsToolDefinitionUnion のエイリアス

"auto"、"none"

ChatFinishDetailsUnion のエイリアス

ChatMessageContentItemUnion のエイリアス

"auto"、"low"、"high"

ChatRequestMessageUnion のエイリアス

"system"、"アシスタント"、"user"、"function"、"tool"

"stop"、"length"、"content_filter"、"function_call"、"tool_calls"

コンテンツ フィルター カテゴリ (検出された場合) に関する情報。

検出された場合のコンテンツ フィルター結果に関する情報。

"safe"、"low"、"medium"、"high"

"simple"、"vector"

"auto"、"none"

"standard"、"hd"

"url"、"b64_json"

"natural"、"vivid"

"256x256"、"512x512"、"1024x1024"、"1792x1024"、"1024x1792"

OnYourDataAuthenticationOptionsUnion のエイリアス

"api_key"、"connection_string"、"key_and_key_id"、"encoded_api_key"、"access_token"、"system_assigned_managed_identity"、"user_assigned_managed_identity"

"endpoint"、"deployment_name"、"model_id"

OnYourDataVectorizationSourceUnion のエイリアス