GetChatCompletionsOptions interface

パッケージ:

@azure/openai

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

Extends

OperationOptions

プロパティ

azureExtensionOptions	それらを使用する Azure OpenAI チャット拡張機能の構成エントリ。 この追加仕様は、Azure OpenAI とのみ互換性があります。
frequencyPenalty	生成されたテキストの累積頻度に基づいて生成されたトークンが出現する確率に影響を与える値。 正の値を指定すると、頻度が高くなり、モデルが同じステートメントを逐語的に繰り返す可能性が低下するにつれて、トークンが表示される可能性が低くなります。
functionCall	モデルが関数呼び出しにどのように応答するかを制御します。 "none" は、モデルが関数を呼び出さず、エンドユーザーに応答することを意味します。 "auto" は、モデルがエンド ユーザーまたは関数の呼び出しのどちらかを選択できることを意味します。 を使用して {"name": "my_function"} 特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 関数が存在しない場合は、"none" が既定値です。 関数が存在する場合は、"auto" が既定値です。
functions	モデルが JSON 入力を生成する可能性がある関数の一覧。
logitBias	完了応答に特定のトークンが出現する確率に影響を与える GPT トークン ID とバイアス スコアの間のマップ。 トークン ID は外部トークナイザー ツールを使用して計算されますが、バイアス スコアは、トークンの完全な禁止または排他的選択に対応する最小値と最大値を持つ -100 から 100 の範囲に存在します。 特定のバイアス スコアの正確な動作は、モデルによって異なります。
maxTokens	生成するトークンの最大数。
n	チャット入力候補の応答に対して生成する必要があるチャット入力候補の選択肢の数。 この設定では多くの入力候補が生成される可能性があるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、maxTokens と stop の適切な設定を確認します。
presencePenalty	生成されたテキスト内の既存の存在に基づいて生成されたトークンが出現する確率に影響する 値。 正の値を指定すると、トークンが既に存在する場合にトークンが表示される可能性が低くなり、モデルが新しいトピックを出力する可能性が高くなります。
responseFormat	モデルが出力する必要がある形式を指定する オブジェクト。 JSON モードを有効にするために使用されます。
seed	指定した場合、システムは、同じシードとパラメーターを使用して繰り返される要求が同じ結果を返すように、決定論的にサンプリングするためのベスト エフォートを行います。 決定性は保証されません。バックエンドの変更を監視するには、system_fingerprint応答パラメーターを参照する必要があります。
stop	補完の生成を終了するテキスト シーケンスのコレクション。
temperature	生成された完了の明らかな創造性を制御する使用するサンプリング温度。 値を大きくすると出力がランダムになりますが、値を小さくすると結果のフォーカスが高くなり、決定論的になります。 これら 2 つの設定の相互作用は予測が困難であるため、同じ完了要求に対して温度と topP を変更することはお勧めしません。
toolChoice	指定した場合、モデルでは、チャット入力候補の応答に使用できるツールのうち、どれを使用できるかが構成されます。
tools	呼び出し元定義関数など、チャット入力候補要求で使用できるツール定義。
topP	核サンプリングと呼ばれる温度によるサンプリングの代替。 この値により、モデルは、指定された確率質量を持つトークンの結果を考慮します。 たとえば、値が 0.15 の場合、確率質量の上位 15% を構成するトークンのみが考慮されます。 これら 2 つの設定の相互作用は予測が困難であるため、同じ完了要求に対して温度と topP を変更することはお勧めしません。
user	操作の呼び出し元またはエンド ユーザーの識別子。 これは、追跡またはレート制限の目的で使用できます。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

azureExtensionOptions

それらを使用する Azure OpenAI チャット拡張機能の構成エントリ。 この追加仕様は、Azure OpenAI とのみ互換性があります。

azureExtensionOptions?: AzureExtensionsOptions

プロパティ値

AzureExtensionsOptions

frequencyPenalty

生成されたテキストの累積頻度に基づいて生成されたトークンが出現する確率に影響を与える値。 正の値を指定すると、頻度が高くなり、モデルが同じステートメントを逐語的に繰り返す可能性が低下するにつれて、トークンが表示される可能性が低くなります。

frequencyPenalty?: number

プロパティ値

number

functionCall

モデルが関数呼び出しにどのように応答するかを制御します。 "none" は、モデルが関数を呼び出さず、エンドユーザーに応答することを意味します。 "auto" は、モデルがエンド ユーザーまたは関数の呼び出しのどちらかを選択できることを意味します。 を使用して {"name": "my_function"} 特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 関数が存在しない場合は、"none" が既定値です。 関数が存在する場合は、"auto" が既定値です。

functionCall?: string | FunctionName

プロパティ値

string | FunctionName

functions

モデルが JSON 入力を生成する可能性がある関数の一覧。

functions?: FunctionDefinition[]

プロパティ値

FunctionDefinition[]

logitBias

完了応答に特定のトークンが出現する確率に影響を与える GPT トークン ID とバイアス スコアの間のマップ。 トークン ID は外部トークナイザー ツールを使用して計算されますが、バイアス スコアは、トークンの完全な禁止または排他的選択に対応する最小値と最大値を持つ -100 から 100 の範囲に存在します。 特定のバイアス スコアの正確な動作は、モデルによって異なります。

logitBias?: Record<string, number>

プロパティ値

Record<string, number>

maxTokens

生成するトークンの最大数。

maxTokens?: number

プロパティ値

number

n

チャット入力候補の応答に対して生成する必要があるチャット入力候補の選択肢の数。 この設定では多くの入力候補が生成される可能性があるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、maxTokens と stop の適切な設定を確認します。

n?: number

プロパティ値

number

presencePenalty

生成されたテキスト内の既存の存在に基づいて生成されたトークンが出現する確率に影響する 値。 正の値を指定すると、トークンが既に存在する場合にトークンが表示される可能性が低くなり、モデルが新しいトピックを出力する可能性が高くなります。

presencePenalty?: number

プロパティ値

number

responseFormat

モデルが出力する必要がある形式を指定する オブジェクト。 JSON モードを有効にするために使用されます。

responseFormat?: ChatCompletionsResponseFormat

プロパティ値

ChatCompletionsResponseFormat

seed

指定した場合、システムは、同じシードとパラメーターを使用して繰り返される要求が同じ結果を返すように、決定論的にサンプリングするためのベスト エフォートを行います。 決定性は保証されません。バックエンドの変更を監視するには、system_fingerprint応答パラメーターを参照する必要があります。

seed?: number

プロパティ値

number

stop

補完の生成を終了するテキスト シーケンスのコレクション。

stop?: string[]

プロパティ値

string[]

temperature

生成された完了の明らかな創造性を制御する使用するサンプリング温度。 値を大きくすると出力がランダムになりますが、値を小さくすると結果のフォーカスが高くなり、決定論的になります。 これら 2 つの設定の相互作用は予測が困難であるため、同じ完了要求に対して温度と topP を変更することはお勧めしません。

temperature?: number

プロパティ値

number

toolChoice

指定した場合、モデルでは、チャット入力候補の応答に使用できるツールのうち、どれを使用できるかが構成されます。

toolChoice?: ChatCompletionsNamedToolSelectionUnion

プロパティ値

ChatCompletionsNamedToolSelectionUnion

tools

呼び出し元定義関数など、チャット入力候補要求で使用できるツール定義。

tools?: ChatCompletionsToolDefinitionUnion[]

プロパティ値

ChatCompletionsToolDefinitionUnion[]

topP

核サンプリングと呼ばれる温度によるサンプリングの代替。 この値により、モデルは、指定された確率質量を持つトークンの結果を考慮します。 たとえば、値が 0.15 の場合、確率質量の上位 15% を構成するトークンのみが考慮されます。 これら 2 つの設定の相互作用は予測が困難であるため、同じ完了要求に対して温度と topP を変更することはお勧めしません。

topP?: number

プロパティ値

number

user

操作の呼び出し元またはエンド ユーザーの識別子。 これは、追跡またはレート制限の目的で使用できます。

user?: string

プロパティ値

string

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

継承元 OperationOptions.abortSignal

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

継承元 OperationOptions.onResponse

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

継承元 OperationOptions.requestOptions

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

継承元 OperationOptions.tracingOptions