@azure/openai package

Классы

AzureKeyCredential	Учетные данные на основе статического ключа, поддерживающие обновление значения базового ключа.
OpenAIClient	Клиент для взаимодействия с 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	Класс OpenAIKeyCredential представляет ключ API OpenAI и используется для проверки подлинности в клиенте 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	Представление доступных параметров для расширения оптического распознавания символов (OCR) Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Конкретное представление настраиваемых параметров для Azure Cosmos DB при использовании его в качестве расширения чата Azure OpenAI.
AzureCosmosDBFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Azure Cosmos DB.
AzureExtensionsOptions	Параметры расширений чата Azure OpenAI.
AzureGroundingEnhancement	Расширение заземления, которое возвращает ограничивающий прямоугольник объектов, обнаруженных на изображении.
AzureGroundingEnhancementCoordinatePoint	Представление точки одного многоугольника, используемого в усовершенствовании заземления Azure.
AzureGroundingEnhancementLine	Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и метки выделения.
AzureGroundingEnhancementLineSpan	Объект span, представляющий обнаруженный объект и сведения о его ограничивающем поле.
AzureMachineLearningIndexChatExtensionConfiguration	Конкретное представление настраиваемых параметров для векторного индекса Машинного обучения Azure при его использовании в качестве расширения чата Azure OpenAI.
AzureSearchChatExtensionConfiguration	Конкретное представление настраиваемых параметров для Azure Поиск при использовании его в качестве расширения чата Azure OpenAI.
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.
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	Параметры проверки подлинности для Azure OpenAI в ваших данных при использовании ключа API.
OnYourDataAuthenticationOptions	Варианты проверки подлинности для Azure OpenAI в ваших данных.
OnYourDataConnectionStringAuthenticationOptions	Параметры проверки подлинности для Azure OpenAI в ваших данных при использовании строка подключения.
OnYourDataDeploymentNameVectorizationSource	Сведения об источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанном на имени внутреннего развертывания модели внедрения в том же ресурсе Azure OpenAI.
OnYourDataEncodedApiKeyAuthenticationOptions	Варианты проверки подлинности для Azure OpenAI On Your Data при использовании ключа API в кодировке Elasticsearch.
OnYourDataEndpointVectorizationSource	Сведения об источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска, основанном на вызове общедоступной конечной точки Azure OpenAI для внедрения.
OnYourDataKeyAndKeyIdAuthenticationOptions	Параметры проверки подлинности для Azure OpenAI On Your Data при использовании пары "ключ и идентификатор ключа Elasticsearch".
OnYourDataModelIdVectorizationSource	Сведения об источнике векторизации, используемом Azure OpenAI On Your Data при применении векторного поиска на основе идентификатора модели службы поиска. В настоящее время поддерживается только Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	Варианты проверки подлинности для Azure OpenAI в ваших данных при использовании управляемого удостоверения, назначаемого системой.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	Варианты проверки подлинности для Azure OpenAI в ваших данных при использовании управляемого удостоверения, назначаемого пользователем.
OnYourDataVectorizationSource	Абстрактное представление источника векторизации для Azure OpenAI On Your Data с векторным поиском.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Конкретное представление настраиваемых параметров для Pinecone при использовании в качестве расширения чата Azure OpenAI.
PineconeFieldMappingOptions	Необязательные параметры для управления обработкой полей при использовании настроенного ресурса Pinecone.
StopFinishDetails	Структурированное представление причины остановки, которая означает естественное завершение моделью.

Псевдонимы типа

AudioResult	Тип результата транскрибирования на основе запрошенного формата ответа
AudioResultFormat	Формат результата звуковой задачи
AudioTranscriptionTask	"transcribe", "translate"
AzureChatExtensionConfigurationUnion	Псевдоним для AzureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
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	"естественный", "яркий"
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