共用方式為

@azure/openai package

  • 參考

類別

AzureKeyCredential

支援更新基礎金鑰值的靜態索引鍵型認證。
OpenAIClient

用來與 Azure OpenAI 互動的用戶端。

用戶端需要 OpenAI 資源的端點和驗證方法，例如 API 金鑰或令牌。 您可以在 OpenAI 資源頁面中找到 API 金鑰和端點。 它們會位於資源的 [金鑰和端點] 頁面中。

驗證的範例：

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

OpenAIKeyCredential 類別代表 OpenAI API 密鑰，並用來向 OpenAI 端點的 OpenAI 用戶端進行驗證。

介面

AudioResultSimpleJson

簡單的轉譯回應
AudioResultVerboseJson

轉譯回應。
AudioSegment

轉譯區段。
AzureChatEnhancementConfiguration

可用 Azure OpenAI 增強設定的表示法。
AzureChatEnhancements

表示 Azure 增強功能對聊天完成的輸出結果，如透過要求中提供的相符輸入所設定。
AzureChatExtensionConfiguration

單一 Azure OpenAI 聊天延伸模組的組態數據表示法。 這將會由聊天完成要求使用 Azure OpenAI 聊天延伸模組來增強響應行為。 使用此設定只與 Azure OpenAI 相容。
AzureChatExtensionDataSourceResponseCitation

當 Azure OpenAI 聊天延伸模組涉及產生對應的聊天完成回應時，其他內容資訊的單一實例。 只有在使用設定為使用比對延伸模組的 Azure OpenAI 要求時，才會填入此內容資訊。
AzureChatExtensionsMessageContext

當 Azure OpenAI 聊天延伸模組涉及產生對應的聊天完成回應時，可用的其他內容資訊表示法。 只有在使用設定為使用比對延伸模組的 Azure OpenAI 要求時，才會填入此內容資訊。
AzureChatGroundingEnhancementConfiguration

Azure OpenAI 基礎增強功能可用選項的表示法。
AzureChatOCREnhancementConfiguration

Azure OpenAI 光學字元辨識 (OCR) 增強的可用選項表示。
AzureCosmosDBChatExtensionConfiguration

使用 Azure Cosmos DB 作為 Azure OpenAI 聊天延伸模組時，可設定選項的特定表示法。
AzureCosmosDBFieldMappingOptions

選擇性設定，以控制使用已設定 Azure Cosmos DB 資源時字段的處理方式。
AzureExtensionsOptions

Azure OpenAI 聊天延伸模組的選項。
AzureGroundingEnhancement

基礎增強功能，會傳回影像中偵測到之物件的周框方塊。
AzureGroundingEnhancementCoordinatePoint

Azure 基礎增強功能所使用的單一多邊形點表示法。
AzureGroundingEnhancementLine

內容行物件，由相鄰的內容專案序列所組成，例如文字和選取標記。
AzureGroundingEnhancementLineSpan

範圍物件，表示偵測到的物件及其周框方塊資訊。
AzureMachineLearningIndexChatExtensionConfiguration

當使用 Azure OpenAI 聊天延伸模組時，Azure Machine Learning 向量索引的特定可設定選項表示法。
AzureSearchChatExtensionConfiguration

當使用 Azure OpenAI 聊天延伸模組時，Azure 搜尋 可設定選項的特定表示法。
AzureSearchIndexFieldMappingOptions

選擇性設定，以控制使用已設定的 Azure 搜尋 資源時，字段的處理方式。
ChatChoice

單一提示完成的表示法，做為整體聊天完成要求的一部分。 一般而言， n 每個提供的提示都會產生選項，預設值為1。 令牌限制和其他設定可能會限制產生的選擇數目。
ChatChoiceLogProbabilityInfo

選擇的記錄機率資訊，如透過 'logprobs' 和 'top_logprobs' 要求。
ChatCompletions

來自聊天完成要求的回應數據表示。 完成支持各種不同的工作，併產生從或「完成」提供的提示數據繼續的文字。
ChatCompletionsFunctionToolCall

評估已設定函式工具時由模型發出的函式工具呼叫，代表後續聊天完成要求解析所需的函式調用。
ChatCompletionsFunctionToolDefinition

聊天完成函式工具的定義資訊，可呼叫函式以回應工具呼叫。
ChatCompletionsFunctionToolSelection

特定具名函式工具的工具選取，將聊天完成限制為使用具名函式。
ChatCompletionsJsonResponseFormat

聊天完成的回應格式，可限制回應發出有效的 JSON 物件。
ChatCompletionsNamedFunctionToolSelection

特定具名函式工具的工具選取，將聊天完成限制為使用具名函式。
ChatCompletionsNamedToolSelection

明確具名工具選取專案的抽象表示法，用於聊天完成要求。
ChatCompletionsResponseFormat

聊天完成可使用之回應格式設定的抽象表示法。 可用來啟用 JSON 模式。
ChatCompletionsTextResponseFormat

標準聊天完成回應格式，可自由產生文字，且不保證會產生符合特定架構的響應內容。
ChatCompletionsToolCall

工具呼叫的抽象表示法，必須在後續要求中解析，才能執行要求的聊天完成。
ChatCompletionsToolDefinition

模型可用來改善聊天完成回應之工具的抽象表示法。
ChatFinishDetails

結構化資訊的抽象表示法，說明聊天完成響應終止的原因。
ChatMessageContentItem

聊天訊息中結構化內容專案的抽象表示法。
ChatMessageImageContentItem

包含影像參考的結構化聊天內容專案。
ChatMessageImageUrl

模型可從中擷取影像的因特網位置。
ChatMessageTextContentItem

包含純文字的結構化聊天內容專案。
ChatRequestAssistantMessage

代表來自 助理 回應或動作的要求聊天訊息。
ChatRequestFunctionMessage

要求聊天訊息，表示已設定函式所要求的輸出。
ChatRequestMessage

要求中提供的聊天訊息抽象表示法。
ChatRequestSystemMessage

要求聊天訊息，其中包含影響模型如何產生聊天完成響應的系統指示。
ChatRequestToolMessage

要求聊天訊息，表示已設定工具所要求的輸出。
ChatRequestUserMessage

要求聊天訊息，表示使用者對 助理 的輸入。
ChatResponseMessage

回應中所收到的聊天訊息表示。
ChatTokenLogProbabilityInfo

單一訊息內容令牌之記錄機率資訊的表示法。
ChatTokenLogProbabilityResult

單一內容令牌的記錄機率資訊表示法，包括要求 『top_logprobs』 時最可能令牌的清單。
Choice

單一提示完成的表示法，做為整體完成要求的一部分。 一般而言， n 每個提供的提示都會產生選項，預設值為1。 令牌限制和其他設定可能會限制產生的選擇數目。
Completions

來自完成要求的回應數據表示。 完成支持各種不同的工作，併產生從或「完成」提供的提示數據繼續的文字。
CompletionsLogProbabilityModel

產生完成的記錄機率模型表示。
CompletionsUsage

表示針對完成要求處理的令牌計數。 計數會考慮跨提示、選擇、選擇替代專案、best_of層代和其他取用者的所有令牌。
ContentFilterBlocklistIdResult

代表根據內容篩選所執行之自定義封鎖清單的評估結果。
ContentFilterCitedDetectionResult

代表針對內容篩選所執行之受保護資源的偵測作業結果。
ContentFilterDetectionResult

表示內容篩選所執行偵測作業的結果。
ContentFilterErrorResults

內容篩選錯誤結果的相關信息。
ContentFilterResult

已篩選內容嚴重性層級的相關信息，如果已篩選，則為 。
ContentFilterResultsForPrompt

要求中單一提示的內容篩選結果。
ContentFilterSuccessResultDetailsForPrompt

內容篩選成功結果的相關信息。
ContentFilterSuccessResultsForChoice

針對產生的模型輸出評估的內容篩選相關信息。
ElasticsearchChatExtensionConfiguration

使用 Elasticsearch 作為 Azure OpenAI 聊天延伸模組時，Elasticsearch 可設定選項的特定表示法。
ElasticsearchIndexFieldMappingOptions

選擇性設定，以控制使用已設定 Elasticsearch® 資源時欄位的處理方式。
EmbeddingItem

單一內嵌相關比較的表示法。
Embeddings

來自內嵌要求的回應數據表示。 內嵌會測量文字字串的相關性，通常用於搜尋、叢集、建議和其他類似的案例。
EmbeddingsUsage

測量此要求和回應中使用的令牌數量。
EventStream

可擦寫且可處置的數據流。
FunctionCall

應該呼叫之函式的名稱和引數，如模型所產生。
FunctionDefinition

聊天完成可叫用的呼叫者指定函式定義，以回應相符的使用者輸入。
FunctionName

結構，指定處理聊天完成作業時要使用的特定要求提供的函式確切名稱。
GetAudioTranscriptionOptions

音訊轉譯要求的選項
GetAudioTranslationOptions

音訊翻譯要求的選項
GetChatCompletionsOptions

本課程模組包含我們想要與對應產生的模型並存的模型。 這適用於提供具有與所產生模型不同名稱/類型的面向客戶模型。
GetCompletionsOptions

完成要求的組態資訊。 完成支持各種不同的工作，併產生從或「完成」提供的提示數據繼續的文字。
GetEmbeddingsOptions

自訂內嵌要求的選項
GetImagesOptions

表示用來產生影像的要求數據。
ImageGenerationContentFilterResults

描述影像產生要求的內容篩選結果。
ImageGenerationData

單一產生的影像表示法，提供為base64編碼的數據，或做為可從中擷取影像的URL。
ImageGenerationPromptFilterResults

描述影像產生要求提示的內容篩選結果。
ImageGenerations

成功產生映像作業的結果。
MaxTokensFinishDetails

表示停止原因的結構化表示法，表示在模型可以自然完成之前達到令牌限制。
OnYourDataAccessTokenAuthenticationOptions

使用存取令牌時，Azure OpenAI On Your Data 的驗證選項。
OnYourDataApiKeyAuthenticationOptions

使用 API 金鑰時，Azure OpenAI On Your Data 的驗證選項。
OnYourDataAuthenticationOptions

Azure OpenAI On Your Data 的驗證選項。
OnYourDataConnectionStringAuthenticationOptions

使用 連接字串 時，Azure OpenAI On Your Data 的驗證選項。
OnYourDataDeploymentNameVectorizationSource

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源詳細數據，這是以相同 Azure OpenAI 資源中的內部內嵌模型部署名稱為基礎。
OnYourDataEncodedApiKeyAuthenticationOptions

使用 Elasticsearch 編碼 API 金鑰時，Azure OpenAI On Data 的驗證選項。
OnYourDataEndpointVectorizationSource

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源詳細數據，這是根據公用 Azure OpenAI 端點呼叫進行內嵌。
OnYourDataKeyAndKeyIdAuthenticationOptions

使用 Elasticsearch 金鑰和金鑰標識碼組時，Azure OpenAI On Data 的驗證選項。
OnYourDataModelIdVectorizationSource

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源詳細數據，這是以搜尋服務模型標識碼為基礎的。 目前只有 Elasticsearch® 支援。
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions

使用系統指派的受控識別時，Azure OpenAI On Your Data 的驗證選項。
OnYourDataUserAssignedManagedIdentityAuthenticationOptions

使用使用者指派的受控識別時，Azure OpenAI On Your Data 的驗證選項。
OnYourDataVectorizationSource

Azure OpenAI On Your Data 的向量搜尋的向量化來源抽象表示法。
OpenAIClientOptions
PineconeChatExtensionConfiguration

當以 Azure OpenAI 聊天延伸模組的形式使用其時，為一個可設定選項的特定表示法。
PineconeFieldMappingOptions

選擇性設定，以控制使用已設定的一般資源時，欄位的處理方式。
StopFinishDetails

表示模型自然終止之停止原因的結構化表示法。

類型別名

AudioResult

根據要求回應格式的轉譯結果類型
AudioResultFormat

音訊工作的結果格式
AudioTranscriptionTask

“transcribe”、“translate”
AzureChatExtensionConfigurationUnion

AzureChatExtensionConfigurationUnion 的別名
AzureChatExtensionType

“azure_search”、“azure_ml_index”、“azure_cosmos_db”、“elasticsearch”、“cone”
AzureSearchQueryType

“simple”、“semantic”、“vector”、“vector_simple_hybrid”、“vector_semantic_hybrid”
ChatCompletionsNamedToolSelectionUnion

ChatCompletionsNamedToolSelectionUnion 的別名
ChatCompletionsResponseFormatUnion

ChatCompletionsResponseFormatUnion 的別名
ChatCompletionsToolCallUnion

ChatCompletionsToolCallUnion 的別名
ChatCompletionsToolDefinitionUnion

ChatCompletionsToolDefinitionUnion 的別名
ChatCompletionsToolSelectionPreset

“auto”、“none”
ChatFinishDetailsUnion

ChatFinishDetailsUnion 的別名
ChatMessageContentItemUnion

ChatMessageContentItemUnion 的別名
ChatMessageImageDetailLevel

“auto”、“low”、“high”
ChatRequestMessageUnion

ChatRequestMessageUnion 的別名
ChatRole

“system”、“助理”、“user”、“function”、“tool”
CompletionsFinishReason

“stop”、“length”、“content_filter”、“function_call”、“tool_calls”
ContentFilterResultDetailsForPrompt

如果偵測到內容篩選類別的相關信息， 則為 。
ContentFilterResultsForChoice

如果偵測到內容篩選結果的相關信息，
ContentFilterSeverity

“safe”、“low”、“medium”、“high”
ElasticsearchQueryType

“simple”、“vector”
FunctionCallPreset

“auto”、“none”
ImageGenerationQuality

“standard”、“hd”
ImageGenerationResponseFormat

“url”、“b64_json”
ImageGenerationStyle

“natural”、“world”
ImageSize

“256x256”、“512x512”、“1024x1024”、“1792x1024”、“1024x1792”
OnYourDataAuthenticationOptionsUnion

OnYourDataAuthenticationOptionsUnion 的別名
OnYourDataAuthenticationType

“api_key”、“connection_string”、“key_and_key_id”、“encoded_api_key”、“access_token”、“system_assigned_managed_identity”、“user_assigned_managed_identity”
OnYourDataVectorizationSourceType

“endpoint”、“deployment_name”、“model_id”
OnYourDataVectorizationSourceUnion

OnYourDataVectorizationSourceUnion 的別名