@azure-rest/ai-inference package
インターフェイス
| ChatChoiceOutput |
チャットの完了要求全体の一部としての 1 つのプロンプト入力候補の表現。
一般に、 |
| ChatCompletionsNamedToolChoice |
チャットの完了を名前付き関数の使用に制限する、特定の名前付き関数ツールのツール選択。 |
| ChatCompletionsNamedToolChoiceFunction |
チャットの完了を名前付き関数の使用に制限する、特定の名前付き関数ツールのツール選択。 |
| ChatCompletionsOutput |
チャット完了要求からの応答データの表現。 入力候補は、さまざまなタスクをサポートし、指定されたプロンプト データから続行または "完了" するテキストを生成します。 |
| ChatCompletionsResponseFormatJsonObject |
有効な JSON オブジェクトの出力に応答を制限するチャット完了の応答形式。 JSON モードを有効にするために、一部の AI モデルでは、システムまたはユーザー メッセージを介して JSON を生成するようにモデルに指示する必要がある場合もあります。 |
| ChatCompletionsResponseFormatJsonSchema |
呼び出し元によって指定された JSON スキーマを使用して、有効な JSON オブジェクトの出力に応答を制限するチャット完了の応答形式。 |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
チャット入力候補の応答形式を、特定のスキーマを持つ JSON として定義します。 完了を生成するときは、AI モデルがこのスキーマに従う必要があります。 |
| ChatCompletionsResponseFormatParent |
モデルが出力する必要がある形式を表します。 これを使用して、既定のテキスト モードではなく JSON モードを有効にします。 JSON モードを有効にするために、一部の AI モデルでは、システムまたはユーザー メッセージを介して JSON を生成するようにモデルに指示する必要がある場合もあります。 |
| ChatCompletionsResponseFormatText |
テキスト応答を出力するチャット完了の応答形式。 これは既定の応答形式です。 |
| ChatCompletionsToolCall |
AI モデルによって要求された関数ツール呼び出し。 |
| ChatCompletionsToolCallOutput |
AI モデルによって要求された関数ツール呼び出し。 |
| ChatCompletionsToolDefinition |
関数を呼び出すことができるチャット完了ツールの定義。 |
| ChatMessageAudioDataContentItem |
base64 でエンコードされたデータとして渡されるオーディオ コンテンツの構造化されたチャット コンテンツ項目。 |
| ChatMessageAudioUrlContentItem |
URL として渡されるオーディオ コンテンツの構造化されたチャット コンテンツ項目。 |
| ChatMessageContentItemParent |
チャット メッセージ内の構造化コンテンツアイテムの抽象表現。 |
| ChatMessageImageContentItem |
イメージ参照を含む構造化されたチャット コンテンツアイテム。 |
| ChatMessageImageUrl |
モデルがイメージを取得できるインターネット上の場所。 |
| ChatMessageInputAudio |
入力オーディオ データの詳細。 |
| ChatMessageInputAudioUrl |
オーディオ URL の詳細。 |
| ChatMessageTextContentItem |
プレーンテキストを含む構造化されたチャット コンテンツアイテム。 |
| ChatRequestAssistantMessage |
アシスタントからの応答またはアクションを表す要求チャット メッセージ。 |
| ChatRequestDeveloperMessage |
モデルがチャット完了応答を生成する方法に影響を与える開発者命令を含む要求チャット メッセージ。 一部の AI モデルでは、システム メッセージではなく開発者メッセージがサポートされています。 |
| ChatRequestMessageParent |
要求で指定されたチャット メッセージの抽象表現。 |
| ChatRequestSystemMessage |
モデルがチャット完了応答を生成する方法に影響を与えるシステム命令を含む要求チャット メッセージ。 |
| ChatRequestToolMessage |
構成されたツールからの要求された出力を表す要求チャット メッセージ。 |
| ChatRequestUserMessage |
アシスタントへのユーザー入力を表す要求チャット メッセージ。 |
| ChatResponseMessageOutput |
応答で受信したチャット メッセージの表現。 |
| CompletionsUsageOutput |
完了要求に対して処理されたトークン数の表現。 カウントでは、プロンプト、選択肢、選択肢の代替、best_of世代、およびその他のコンシューマー全体のすべてのトークンが考慮されます。 |
| EmbeddingItemOutput |
1 つの埋め込み関連度比較の表現。 |
| EmbeddingsResultOutput |
埋め込み要求からの応答データの表現。 埋め込みではテキスト文字列の関連性が測定され、検索、クラスタリング、推奨事項、その他の同様のシナリオでよく使用されます。 |
| EmbeddingsUsageOutput |
この要求と応答で使用されるトークンの量の測定。 |
| ErrorModel |
エラー オブジェクト。 |
| FunctionCall |
モデルによって生成される、呼び出す必要がある関数の名前と引数。 |
| FunctionCallOutput |
モデルによって生成される、呼び出す必要がある関数の名前と引数。 |
| FunctionDefinition |
一致するユーザー入力に応答してチャットの完了が呼び出される可能性がある呼び出し元指定関数の定義。 |
| GetChatCompletions | |
| GetChatCompletions200Response |
要求は成功しました。 |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
要求は成功しました。 |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
要求は成功しました。 |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
要求は成功しました。 |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
省略可能なテキストを含む画像を表します。 |
| ModelClientOptions |
クライアントの省略可能なパラメーター |
| ModelInfoOutput |
AI モデルに関するいくつかの基本情報を表します。 |
| Routes | |
型エイリアス
| AudioContentFormat |
AudioContentFormat のエイリアス |
| ChatCompletionsResponseFormat |
モデルが出力する必要がある形式を表します。 これを使用して、既定のテキスト モードではなく JSON モードを有効にします。 JSON モードを有効にするために、一部の AI モデルでは、システムまたはユーザー メッセージを介して JSON を生成するようにモデルに指示する必要がある場合もあります。 |
| ChatCompletionsToolChoicePreset |
ChatCompletionsToolChoicePreset のエイリアス |
| ChatMessageContentItem |
チャット メッセージ内の構造化コンテンツアイテムの抽象表現。 |
| ChatMessageImageDetailLevel |
ChatMessageImageDetailLevel のエイリアス |
| ChatRequestMessage |
要求で指定されたチャット メッセージの抽象表現。 |
| ChatRole |
ChatRole のエイリアス |
| ChatRoleOutput |
ChatRoleOutput のエイリアス |
| CompletionsFinishReasonOutput |
CompletionsFinishReasonOutput の別名 |
| EmbeddingEncodingFormat |
EmbeddingEncodingFormat のエイリアス |
| EmbeddingInputType |
EmbeddingInputType のエイリアス |
| ExtraParameters |
ExtraParameters のエイリアス |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
ModelTypeOutput のエイリアス |
関数
関数の詳細
default(string, TokenCredential | KeyCredential, ModelClientOptions)
ModelClient の新しいインスタンスを初期化する
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClientパラメーター
- endpointParam
-
string
パラメーター endpointParam
- credentials
クライアント資格情報を一意に識別する
- options
- ModelClientOptions
すべての省略可能なパラメーターのパラメーター
戻り値
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): responseパラメーター
戻り値
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): responseパラメーター
戻り値
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): responseパラメーター
戻り値
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): responseパラメーター
戻り値
response
