Azure OpenAI (プレビュー)

OpenAI の最先端の人工知能機能Azureワークフローに簡単に統合

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
Copilot Studio Premium 次を除くすべてのPower Automateリージョン:
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - 中国リージョンAzure
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべてのPower Appsリージョン:
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべてのPower Automateリージョン:
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Microsoft
URL https://support.microsoft.com
コネクタ メタデータ
Publisher Microsoft
Website https://azure.microsoft.com/en-us/products/cognitive-services/openai-service
プライバシー ポリシー https://learn.microsoft.com/en-us/legal/cognitive-services/openai/data-privacy
カテゴリ 人工知能;ビジネス インテリジェンス

Azure OpenAI On Your Data を使用すると、モデルのトレーニングや微調整を行うことなく、独自のエンタープライズ データで GPT-35-Turbo や GPT-4 などの高度な AI モデルを実行できます。 より正確にデータをチャットし、分析することができます。 また、指定したデータ ソースで利用可能な最新の情報に基づいてモデルの応答をサポートするソースを指定したり、データ ソースを省略して、データを固定せずに Azure OpenAI モデルを呼び出すこともできます。

前提条件

ヒント

Azure OpenAI On Your Data を初めて使用する場合は、quickstart を試してサービスを開始してください。

資格情報を取得する

API 要求を認証するには、Azure OpenAI リソースとAzure AI 検索 リソースのキーとエンドポイントが必要です。

Azure OpenAI リソースの場合:

  1. Azure ポータルでリソースに移動します。
  2. リソースのページで、左側のナビゲーション メニューの [キーとエンドポイント ] を選択します。 資格情報を書き留めます。 キーとエンドポイントのいずれかを使用します。

Azure AI 検索 リソースの場合:

  1. Azure ポータルでリソースに移動します。
  2. リソースの [概要 ] ページで、 URL をメモします。
  3. 左側のナビゲーション メニューで [ キー ] を選択します。 管理者キーのいずれかを使用します。

既知の問題と制限事項

  • Azure AI 検索のみが、この Power Platform コネクタでデータで Azure OpenAI を使用するためのデータ ソースとしてサポートされます。
  • 関数呼び出しはサポートされていません。
  • メッセージ コンテンツでは、イメージはサポートされていません。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。
API キー OPENAI リソース名と API キー Azure指定して、AI モデルをホストする Azure OpenAI にアクセスします。 すべてのリージョン 共有可能
ロジック アプリのマネージド ID LogicApps マネージド ID を使用して接続を作成する LOGICAPPS のみ 共有可能
既定 [非推奨] このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。 すべてのリージョン 共有不可

API キー

認証 ID: keyBasedAuth

適用対象: すべてのリージョン

OPENAI リソース名と API キー Azure指定して、AI モデルをホストする Azure OpenAI にアクセスします。

これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、キャンバス アプリの Connectors の概要 - Power Apps |Microsoft Docs

名前 タイプ Description 必須
OpenAI リソース名のAzure 文字列 AI モデルをホストする Azure OpenAI リソースの名前 正しい
OpenAI API キーのAzure securestring AI モデルをホストする Azure OpenAI リソースにアクセスするための API キー 正しい
エンドポイント URL のAzure Cognitive Search 文字列 データのインデックスを作成するAzure Cognitive Search エンドポイントの URL
Azure Cognitive Search API キー securestring データのインデックスを作成するAzure Cognitive Search エンドポイントにアクセスするための API キー

Logic Apps マネージド ID

認証 ID: managedIdentityAuth

適用: LOGICAPPS のみ

LogicApps マネージド ID を使用して接続を作成する

これは共有可能な接続です。 電源アプリが別のユーザーと共有されている場合は、接続も共有されます。 詳細については、キャンバス アプリの Connectors の概要 - Power Apps |Microsoft Docs

名前 タイプ Description 必須
LogicApps マネージド ID managedIdentity Logic Apps マネージド ID を使用してサインインする 正しい
OpenAI リソース名のAzure 文字列 AI モデルをホストする Azure OpenAI リソースの名前 正しい

既定 [非推奨]

適用対象: すべてのリージョン

このオプションは、明示的な認証の種類がない古い接続に対してのみ行われ、下位互換性のためにのみ提供されます。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前 タイプ Description 必須
OpenAI リソース名のAzure 文字列 AI モデルをホストする Azure OpenAI リソースの名前 正しい
OpenAI API キーのAzure securestring AI モデルをホストする Azure OpenAI リソースにアクセスするための API キー 正しい
エンドポイント URL のAzure Cognitive Search 文字列 データのインデックスを作成するAzure Cognitive Search エンドポイントの URL
Azure Cognitive Search API キー securestring データのインデックスを作成するAzure Cognitive Search エンドポイントにアクセスするための API キー

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 1000 60 秒

アクション

チャット メッセージの補完を作成します

チャット メッセージの補完を作成します
埋め込みを取得する

機械学習モデルとアルゴリズムで簡単に使用できる、特定の入力のベクター表現を取得する
拡張機能を使用してチャット メッセージの入力候補を作成する

拡張機能を使用してチャット メッセージの入力候補を作成する
複数の埋め込みを取得する

機械学習モデルとアルゴリズムで簡単に使用できる入力の特定の配列のベクター表現を取得する

チャット メッセージの補完を作成します

操作 ID:
ChatCompletions_Create_2024Feb15Preview

チャット メッセージの補完を作成します

パラメーター

名前 キー 必須 型 説明
デプロイされたモデルのデプロイ ID
 deployment-id True string

デプロイされたモデルのデプロイ ID
API バージョン
 api-version True string

API バージョン
温度
 temperature number

使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
top_p
 top_p number

温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
ストリーミング
 stream boolean

設定すると、ChatGPT のように部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。
stop
 stop array of string

API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。
マックス_トークン
 max_tokens integer

生成された回答に許可されるトークンの最大数。 既定では、モデルが返すことができるトークンの数は (4096 - プロンプト トークン) になります。
presence_penalty
 presence_penalty number

-2.0 から 2.0 までの数値。 正の値を指定すると、これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティが課せられ、モデルが新しいトピックを扱う可能性が高まります。
頻度ペナルティ (frequency_penalty)
 frequency_penalty number

-2.0 から 2.0 までの数値。 値を正にすると、これまでのテキストに存在する頻度に基づいて新しいトークンにペナルティが課せられ、モデルが同じ行を逐語的に繰り返す可能性が低下します。
ロジットバイアス
 logit_bias object

指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルによって異なりますが、-1 と1の間の値は選択の可能性を低下または増加させる必要があります。-100 や 100 などの値は、関連するトークンを禁止または排他的に選択する必要があります。
ユーザー
 user string

エンド ユーザーを表す一意の識別子。OpenAI をAzureして不正使用を監視および検出するのに役立ちます。
ロール
 role True string

メッセージ作成者のロール。
コンテンツ
 content True string

定義された型を持つコンテンツ パーツの配列。それぞれが text型にすることができます。
型
 type True string

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

構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。
in_scope
 in_scope boolean

クエリをインデックス付きデータの使用に制限するかどうか。
strictness
 strictness integer

検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。
role_information
 role_information string

ふるまいに関する指示と、応答の生成時に参照する必要があるコンテキストをモデルに与えます。 アシスタントの性格を説明し、応答の書式設定方法を伝えることができます。 トークンには 100 個のトークン制限があり、全体的なトークン制限に対してカウントされます。
インデックス名
 index_name True string

参照先の Azure Search リソースで使用可能なインデックスの名前。
title_field
 title_field string

タイトルとして使用するインデックス フィールドの名前。
url_field
 url_field string

URL として使用するインデックス フィールドの名前。
filepath_field
 filepath_field string

ファイルパスとして使用するインデックス フィールドの名前。
content_fields
 content_fields array of string

コンテンツとして扱う必要があるインデックス フィールドの名前。
content_fields_separator
 content_fields_separator string

コンテンツ フィールドで使用する区切り記号パターン。
vector_fields
 vector_fields array of string

ベクトル データを表すフィールドの名前。
クエリタイプ
 query_type string

Azure OpenAI チャット拡張機能として使用するときに実行する必要がある検索検索クエリAzureの種類。
semantic_configuration
 semantic_configuration string

クエリの追加のセマンティック構成。
フィルタ
 filter string

検索フィルター。
型
 type string

OpenAI On Your Data Azure使用可能なソースを表し、ベクター検索で使用するデータのベクター化を構成できます。
デプロイメント名
 deployment_name True string

ベクター化に使用するモデル デプロイの名前を指定します。 このモデルデプロイは、OpenAI リソースAzure同じである必要がありますが、On Your Data では、プライベート ネットワークでもベクター検索を可能にするパブリック呼び出しではなく、内部呼び出しを介してこのモデルデプロイを使用します。
n
 n integer

入力メッセージごとに生成するチャット補完の選択肢の数。
seed
 seed integer

指定した場合、システムは、同じ seed とパラメーターを持つ繰り返し要求が同じ結果を返すように、決定論的にサンプリングするように最善を尽くします。決定性は保証されません。バックエンドの変更を監視するには、 system_fingerprint 応答パラメーターを参照する必要があります。
logprobs
 logprobs boolean

出力トークンのログ確率を返すかどうかを指定します。 true に設定すると、content の message に含まれる各出力トークンのログ確率が返されます。 このオプションは現在、 gpt-4-vision-preview モデルでは使用できません。
top_logprobs
 top_logprobs integer

各トークン位置で返される可能性が最も高いトークンの数を指定する 0 ~ 5 の整数。それぞれに、ログ確率が関連付けられています。 このパラメーターを使う場合、logprobs は true に設定する必要があります。
型
 type string

json_objectに設定すると、JSON モードが有効になります。 これにより、モデルによって生成されるメッセージが有効な JSON であることが保証されます。

返品

Body
createChatCompletionResponse_2024Feb15Preview

埋め込みを取得する

操作 ID:
SingleEmbeddings_Create_2024Feb15Preview

機械学習モデルとアルゴリズムで簡単に使用できる、特定の入力のベクター表現を取得する

パラメーター

名前 キー 必須 型 説明
デプロイされたモデルのデプロイ ID
 deployment-id True string

デプロイされたモデルのデプロイ ID
API バージョン
 api-version True string

API バージョン
入力
 input True string

埋め込みを取得するテキストを入力し、文字列としてエンコードします。 入力文字列の長さが 2048 トークンを超えないようにする
ユーザー
 user string

エンド ユーザーを表す一意の識別子。OpenAI をAzureして不正使用を監視および検出するのに役立ちます。
input_type
 input_type string

使用する埋め込み検索の入力の種類。

返品

Body
getSingleEmbeddingsResponse_2024Feb15Preview

拡張機能を使用してチャット メッセージの入力候補を作成する

操作 ID:
ExtensionsChatCompletions_Create

拡張機能を使用してチャット メッセージの入力候補を作成する

パラメーター

名前 キー 必須 型 説明
デプロイされたモデルのデプロイ ID
 deployment-id True string

デプロイされたモデルのデプロイ ID
デプロイされたモデルのデプロイ ID を確認する
 deploymentId True string

デプロイされたモデルのデプロイ ID を確認する
API バージョン
 api-version True string

API バージョン
インデックス
 index integer

会話内のメッセージのインデックス。
ロール
 role True string

このメッセージの作成者の役割。
受信者
 recipient string

メッセージの受信者 ( <namespace>.<操作>。 受信者がツールの場合にのみ表示されます。
コンテンツ
 content True string

メッセージの内容
end_turn
 end_turn boolean

メッセージがターンを終了するかどうか。
型
 type True string

データ ソースの種類。
parameters
 parameters object

実行時にデータ ソースに使用されるパラメーター。
温度
 temperature number

使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
top_p
 top_p number

温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。 一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
ストリーミング
 stream boolean

設定すると、ChatGPT のように部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。
stop
 stop array of string

配列の最小サイズは 1、最大 4
マックス_トークン
 max_tokens integer

生成された回答に許可されるトークンの最大数。 既定では、モデルが返すことができるトークンの数は (4096 - プロンプト トークン) になります。
presence_penalty
 presence_penalty number

-2.0 から 2.0 までの数値。 正の値を指定すると、これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティが課せられ、モデルが新しいトピックを扱う可能性が高まります。
頻度ペナルティ (frequency_penalty)
 frequency_penalty number

-2.0 から 2.0 までの数値。 値を正にすると、これまでのテキストに存在する頻度に基づいて新しいトークンにペナルティが課せられ、モデルが同じ行を逐語的に繰り返す可能性が低下します。
ロジットバイアス
 logit_bias object

指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルによって異なりますが、-1 と1の間の値は選択の可能性を低下または増加させる必要があります。-100 や 100 などの値は、関連するトークンを禁止または排他的に選択する必要があります。
ユーザー
 user string

エンド ユーザーを表す一意の識別子。OpenAI をAzureして不正使用を監視および検出するのに役立ちます。

返品

拡張機能チャットの完了の応答。

Body
ExtensionsChatCompletionsResponse

複数の埋め込みを取得する

操作 ID:
MultipleEmbeddings_Create_2024Feb15Preview

機械学習モデルとアルゴリズムで簡単に使用できる入力の特定の配列のベクター表現を取得する

パラメーター

名前 キー 必須 型 説明
デプロイされたモデルのデプロイ ID
 deployment-id True string

デプロイされたモデルのデプロイ ID
API バージョン
 api-version True string

API バージョン
入力
 input True array of string

埋め込みを取得する入力テキストの配列。文字列としてエンコードされます。 各入力文字列の長さが 2048 トークンを超えてはなりません
ユーザー
 user string

エンド ユーザーを表す一意の識別子。OpenAI をAzureして不正使用を監視および検出するのに役立ちます。
input_type
 input_type string

使用する埋め込み検索の入力の種類。

返品

Body
getMultipleEmbeddingsResponse_2024Feb15Preview

定義

メッセージ

チャット メッセージ。

名前 パス 型 説明
インデックス
 index integer

会話内のメッセージのインデックス。
ロール
 role string

このメッセージの作成者の役割。
受信者
 recipient string

メッセージの受信者 ( <namespace>.<操作>。 受信者がツールの場合にのみ表示されます。
コンテンツ
 content string

メッセージの内容
end_turn
 end_turn boolean

メッセージがターンを終了するかどうか。

ExtensionsChatCompletionsResponse

拡張機能チャットの完了の応答。

名前 パス 型 説明
id
 id string
オブジェクト
 object string
作成済み
 created integer
モデル
 model string
prompt_filter_results
 prompt_filter_results promptFilterResults

要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。
prompt_tokens
 usage.prompt_tokens integer
completion_tokens
 usage.completion_tokens integer
total_tokens
 usage.total_tokens integer
choices
 choices array of ExtensionsChatCompletionChoice

ExtensionsChatCompletionChoice

名前 パス 型 説明
インデックス
 index integer
終了理由
 finish_reason string
content_filter_results
 content_filter_results contentFilterResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。
messages
 messages array of Message

サービスによって返されるメッセージの一覧。

contentFilterResult

名前 パス 型 説明
severity
 severity string
filtered
 filtered boolean

contentFilterResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。

名前 パス 型 説明
sexual
 sexual contentFilterResult
violence
 violence contentFilterResult
hate
 hate contentFilterResult
self_harm
 self_harm contentFilterResult
エラー
 error errorBase

promptFilterResult

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

名前 パス 型 説明
prompt_index
 prompt_index integer
content_filter_results
 content_filter_results contentFilterResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。

promptFilterResults

要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。

名前 パス 型 説明
アイテム
 promptFilterResult

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

errorBase

名前 パス 型 説明
コード
 code string
メッセージ
 message string

errorBase_2024Feb15Preview

名前 パス 型 説明
コード
 code string
メッセージ
 message string

contentFilterSeverityResult_2024Feb15Preview

名前 パス 型 説明
filtered
 filtered boolean
severity
 severity string

contentFilterDetectedResult_2024Feb15Preview

名前 パス 型 説明
filtered
 filtered boolean
detected
 detected boolean

contentFilterDetectedWithCitationResult_2024Feb15Preview

名前 パス 型 説明
filtered
 filtered boolean
detected
 detected boolean
URL
 citation.URL string
ライセンス
 citation.license string

contentFilterIdResult_2024Feb15Preview

名前 パス 型 説明
id
 id string
filtered
 filtered boolean

contentFilterPromptResults_2024Feb15Preview

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、それがフィルター処理されたかどうか。 また、顧客のブロック リストに関する情報 (フィルター処理されているかどうかとその ID)。

名前 パス 型 説明
sexual
 sexual contentFilterSeverityResult_2024Feb15Preview
violence
 violence contentFilterSeverityResult_2024Feb15Preview
hate
 hate contentFilterSeverityResult_2024Feb15Preview
self_harm
 self_harm contentFilterSeverityResult_2024Feb15Preview
profanity
 profanity contentFilterDetectedResult_2024Feb15Preview
custom_blocklists
 custom_blocklists array of contentFilterIdResult_2024Feb15Preview
エラー
 error errorBase_2024Feb15Preview
jailbreak
 jailbreak contentFilterDetectedResult_2024Feb15Preview

contentFilterChoiceResults_2024Feb15Preview

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 サード パーティのテキストと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロック リストに関する情報 (フィルター処理されているかどうかとその ID)。

名前 パス 型 説明
sexual
 sexual contentFilterSeverityResult_2024Feb15Preview
violence
 violence contentFilterSeverityResult_2024Feb15Preview
hate
 hate contentFilterSeverityResult_2024Feb15Preview
self_harm
 self_harm contentFilterSeverityResult_2024Feb15Preview
profanity
 profanity contentFilterDetectedResult_2024Feb15Preview
custom_blocklists
 custom_blocklists array of contentFilterIdResult_2024Feb15Preview
エラー
 error errorBase_2024Feb15Preview
protected_material_text
 protected_material_text contentFilterDetectedResult_2024Feb15Preview
protected_material_code
 protected_material_code contentFilterDetectedWithCitationResult_2024Feb15Preview

promptFilterResult_2024Feb15Preview

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

名前 パス 型 説明
prompt_index
 prompt_index integer
content_filter_results
 content_filter_results contentFilterPromptResults_2024Feb15Preview

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、それがフィルター処理されたかどうか。 また、顧客のブロック リストに関する情報 (フィルター処理されているかどうかとその ID)。

promptFilterResults_2024Feb15Preview

要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。

名前 パス 型 説明
アイテム
 promptFilterResult_2024Feb15Preview

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

azureChatExtensionsMessageContext_2024Feb15Preview

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

名前 パス 型 説明
citations
 citations array of citation_2024Feb15Preview

応答でアシスタント メッセージを生成するために使用されるデータ ソースの取得結果。
意図
 intent string

チャット履歴から検出されたインテント。コンテキストを引き継ぐ次のターンに渡すために使用されます。

citation_2024Feb15Preview

チャット補完応答メッセージの引用情報。

名前 パス 型 説明
コンテンツ
 content string

引用の内容。
title
 title string

引用のタイトル。
URL
 url string

引用の URL。
FilePath
 filepath string

引用のファイル パス。
chunk_id
 chunk_id string

引用のチャンク ID。

createChatCompletionResponse_2024Feb15Preview

名前 パス 型 説明
id
 id string

チャット入力候補の一意識別子。
オブジェクト
 object chatCompletionResponseObject_2024Feb15Preview

オブジェクトの種類。
作成済み
 created integer

チャット入力候補が作成されたときの Unix タイムスタンプ (秒単位)。
モデル
 model string

チャット入力候補に使われるモデル。
使用
 usage completionUsage_2024Feb15Preview

入力候補要求の使用状況の統計情報。
system_fingerprint
 system_fingerprint string

seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。
prompt_filter_results
 prompt_filter_results promptFilterResults_2024Feb15Preview

要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。
choices
 choices array of object
インデックス
 choices.index integer
終了理由
 choices.finish_reason string
メッセージ
 choices.message chatCompletionResponseMessage_2024Feb15Preview

モデルによって生成されたチャット入力候補メッセージ。
content_filter_results
 choices.content_filter_results contentFilterChoiceResults_2024Feb15Preview

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 サード パーティのテキストと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロック リストに関する情報 (フィルター処理されているかどうかとその ID)。
logprobs
 choices.logprobs chatCompletionChoiceLogProbs_2024Feb15Preview

選択肢のログ確率情報。

chatCompletionChoiceLogProbs_2024Feb15Preview

選択肢のログ確率情報。

名前 パス 型 説明
コンテンツ
 content array of chatCompletionTokenLogprob_2024Feb15Preview

ログ確率情報を含むメッセージ コンテンツ トークンの一覧。

chatCompletionTokenLogprob_2024Feb15Preview

名前 パス 型 説明
トークン
 token string

トークン。
logprob
 logprob number

このトークンのログ確率。
バイト
 bytes array of integer

トークンの UTF-8 バイト表現を表す整数の一覧。 文字が複数のトークンによって表され、そのバイト表現を組み合わせて正しいテキスト表現を生成する必要がある場合に便利です。 トークンのバイト表現がない場合は、null を指定できます。
top_logprobs
 top_logprobs array of object

このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 まれに、要求したよりも少ない数の top_logprobs が返される場合があります。
トークン
 top_logprobs.token string

トークン。
logprob
 top_logprobs.logprob number

このトークンのログ確率。
バイト
 top_logprobs.bytes array of integer

トークンの UTF-8 バイト表現を表す整数の一覧。 文字が複数のトークンによって表され、そのバイト表現を組み合わせて正しいテキスト表現を生成する必要がある場合に便利です。 トークンのバイト表現がない場合は、null を指定できます。

chatCompletionResponseMessage_2024Feb15Preview

モデルによって生成されたチャット入力候補メッセージ。

名前 パス 型 説明
ロール
 role chatCompletionResponseMessageRole_2024Feb15Preview

応答メッセージの作成者のロール。
コンテンツ
 content string

メッセージの内容。
コンテキスト
 context azureChatExtensionsMessageContext_2024Feb15Preview

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

chatCompletionResponseMessageRole_2024Feb15Preview

応答メッセージの作成者のロール。

応答メッセージの作成者のロール。

string

chatCompletionResponseObject_2024Feb15Preview

オブジェクトの種類。

オブジェクトの種類。

string

completionUsage_2024Feb15Preview

入力候補要求の使用状況の統計情報。

名前 パス 型 説明
prompt_tokens
 prompt_tokens integer

プロンプト内のトークンの数。
completion_tokens
 completion_tokens integer

生成された入力候補内のトークンの数。
total_tokens
 total_tokens integer

要求内で使われたトークンの合計数 (プロンプトと入力候補の和)。

getSingleEmbeddingsResponse_2024Feb15Preview

名前 パス 型 説明
オブジェクト
 object string

応答オブジェクトの種類の詳細
モデル
 model string

モデル名
embedding
 embedding array of number

指定された入力の計算された埋め込みを表す浮動小数点の配列
prompt_tokens
 usage.prompt_tokens integer

入力で使用されるトークンの数
total_tokens
 usage.total_tokens integer

使用されたトークンの合計

getMultipleEmbeddingsResponse_2024Feb15Preview

名前 パス 型 説明
オブジェクト
 object string

応答オブジェクトの種類の詳細
モデル
 model string

モデル名
embeddings
 embeddings array of array

入力文字列コレクションの計算された埋め込みを表す float の配列を持つ配列
items
 embeddings array of number
prompt_tokens
 usage.prompt_tokens integer

入力で使用されるトークンの数
total_tokens
 usage.total_tokens integer

使用されたトークンの合計