Azure OpenAI

Простая интеграция Azure передовых возможностей искусственного интеллекта OpenAI в рабочие процессы

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     - Azure для государственных организаций регионы
     - Azure регионы Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (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 на собственных корпоративных данных, не требуя обучения или точной настройки моделей. Вы можете общаться поверх и анализировать данные с большей точностью. Вы также можете указать источники для поддержки ответов модели на основе последних сведений, доступных в указанных источниках данных, или опустить источник данных для вызова модели Azure OpenAI без приземления данных.

Необходимые условия

Подсказка

Если вы впервые используете Azure OpenAI On Your Data, попробуйте quickstart, чтобы приступить к работе со службой.

Получите ваши учетные данные

Для проверки подлинности запросов API вам потребуется ключ и конечная точка для Azure ресурсов OpenAI и Поиск с использованием ИИ Azure.

Для ресурса OpenAI Azure:

  1. Перейдите к ресурсу на портале Azure.
  2. На странице ресурса выберите ключи и конечную точку в меню навигации слева. Запишите учетные данные. Вы будете использовать один из ключей и конечной точки.

Для ресурса Поиск с использованием ИИ Azure:

  1. Перейдите к ресурсу на портале Azure.
  2. На странице обзора ресурса запишите URL-адрес.
  3. Выберите клавиши в меню навигации слева. Вы будете использовать один из ключей администратора.

Известные проблемы и ограничения

  • Только Поиск с использованием ИИ Azure поддерживается в качестве источника данных для использования Azure OpenAI в данных с этим соединителем Power Platform.
  • Вызов функции не поддерживается.
  • Изображения не поддерживаются в содержимом сообщения.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

Ключ API Укажите Azure имя ресурса OpenAI и ключ API для доступа к Azure OpenAI, на котором размещена модель ИИ. Все регионы Доступный для общего пользования
Управляемая идентичность Создание подключения с помощью управляемого удостоверения Только LOGICAPPS Доступный для общего пользования
По умолчанию [не рекомендуется] Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. Все регионы Недоступен для совместного использования

Ключ API

Идентификатор проверки подлинности: keyBasedAuth

Применимо: все регионы

Укажите Azure имя ресурса OpenAI и ключ API для доступа к Azure OpenAI, на котором размещена модель ИИ.

Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре Connectors для приложений холста — Power Apps | Документация Майкрософт

Имя Тип Description Обязательно
Azure имя ресурса OpenAI струна Имя ресурса Azure OpenAI, на котором размещена модель ИИ True
ключ API OpenAI Azure securestring Ключ API для доступа к ресурсу OpenAI Azure, на котором размещена модель ИИ. True
URL-адрес конечной точки Когнитивный поиск Azure струна URL-адрес конечной точки Когнитивный поиск Azure индексирования данных
ключ API Когнитивный поиск Azure securestring Ключ API для доступа к Когнитивный поиск Azure конечной точке индексирования данных

Управляемая идентичность

Идентификатор проверки подлинности: managedIdentityAuth

Применимо: только LOGICAPPS

Создание подключения с помощью управляемого удостоверения

Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре Connectors для приложений холста — Power Apps | Документация Майкрософт

Имя Тип Description Обязательно
Управляемая идентичность управляемая идентичность Вход с помощью управляемого удостоверения True
Azure имя ресурса OpenAI струна Имя ресурса Azure OpenAI, на котором размещена модель ИИ True

По умолчанию [не рекомендуется]

Применимо: все регионы

Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Azure имя ресурса OpenAI струна Имя ресурса Azure OpenAI, на котором размещена модель ИИ True
ключ API OpenAI Azure securestring Ключ API для доступа к ресурсу OpenAI Azure, на котором размещена модель ИИ. True
URL-адрес конечной точки Когнитивный поиск Azure струна URL-адрес конечной точки Когнитивный поиск Azure индексирования данных
ключ API Когнитивный поиск Azure securestring Ключ API для доступа к Когнитивный поиск Azure конечной точке индексирования данных

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 1000 60 секунд

Действия

Использование расширений для создания завершения для сообщений чата

Использование расширений для создания завершения для сообщений чата

Получение внедрения

Получение векторного представления заданных входных данных, которые можно легко использовать моделями и алгоритмами машинного обучения.

Получение нескольких внедренных элементов

Получение векторных представлений заданного массива входных данных, которые можно легко использовать моделями и алгоритмами машинного обучения.

Создает завершение для сообщения чата

Создает завершение для сообщения чата

Использование расширений для создания завершения для сообщений чата

Использование расширений для создания завершения для сообщений чата

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор развертывания развернутой модели
deployment-id True string

Идентификатор развертывания развернутой модели

Подтверждение идентификатора развертывания развернутой модели
deploymentId True string

Подтверждение идентификатора развертывания развернутой модели

Версия API
api-version True string

Версия API

index
index integer

Индекс сообщения в беседе.

роль
role True string

Роль автора этого сообщения.

получатель;
recipient string

Получатель сообщения в формате <пространства> имен.<операция>. При наличии и только в том случае, если получатель является инструментом.

содержимое
content True string

Содержимое сообщения

end_turn
end_turn boolean

Заканчивается ли сообщение поворотом.

type
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 number

Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.

штраф за частоту
frequency_penalty number

Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.

логит_биас
logit_bias object

Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.

Пользователь
user string

Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI для мониторинга и обнаружения злоупотреблений.

Возвращаемое значение

Ответ завершения чата расширений.

Получение внедрения

Получение векторного представления заданных входных данных, которые можно легко использовать моделями и алгоритмами машинного обучения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор развертывания развернутой модели
deployment-id True string

Идентификатор развертывания развернутой модели

Версия API
api-version True string

Версия API

ввод
input True string

Входной текст для получения внедренных значений, закодированных в виде строки. Входная строка не должна превышать 2048 маркеров длиной

Пользователь
user string

Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI для мониторинга и обнаружения злоупотреблений.

тип ввода
input_type string

Тип входных данных для использования поиска внедрения.

Возвращаемое значение

Получение нескольких внедренных элементов

Получение векторных представлений заданного массива входных данных, которые можно легко использовать моделями и алгоритмами машинного обучения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор развертывания развернутой модели
deployment-id True string

Идентификатор развертывания развернутой модели

Версия API
api-version True string

Версия API

ввод
input True array of string

Массив входных текстов для получения внедренных значений, закодированных в виде строки. Длина каждой входной строки не должна превышать 2048 токенов

Пользователь
user string

Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI для мониторинга и обнаружения злоупотреблений.

тип ввода
input_type string

Тип входных данных для использования поиска внедрения.

Возвращаемое значение

Создает завершение для сообщения чата

Создает завершение для сообщения чата

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор развертывания развернутой модели
deployment-id True string

Идентификатор развертывания развернутой модели

Версия 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

До 4 последовательностей, в которых API перестанет создавать дополнительные маркеры. Возвращенный текст не будет содержать последовательность остановки.

макс_токены
max_tokens integer

Максимальное количество маркеров, разрешенных для созданного ответа. По умолчанию число маркеров, возвращаемых моделью, будет (4096 — маркеры запроса).

штраф за присутствие
presence_penalty number

Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры в зависимости от того, появляются ли они в тексте до сих пор, что повышает вероятность того, что модель будет говорить о новых темах.

штраф за частоту
frequency_penalty number

Число от -2.0 до 2.0. Положительные значения наказывают новые маркеры на основе их существующей частоты в тексте до сих пор, уменьшая вероятность повторения модели той же строки дословно.

логит_биас
logit_bias object

Изменяет вероятность появления указанных маркеров в завершении. Принимает объект JSON, который сопоставляет маркеры (указанные идентификатором маркера в токенизаторе) со связанным значением предвзятости от -100 до 100. С математической точки зрения смещение добавляется к логитам, созданным моделью до выборки. Точный эффект зависит от модели, но значения от –1 до 1 должны уменьшать или увеличивать вероятность выбора; такие значения, как –100 или 100, должны приводить к запрету или эксклюзивному выбору соответствующего маркера.

Пользователь
user string

Уникальный идентификатор, представляющий пользователя, который может помочь Azure OpenAI для мониторинга и обнаружения злоупотреблений.

роль
role True string

Роль автора сообщений.

содержимое
content True string

Массив частей контента с определенным типом, каждый из них может быть типом text.

type
type True string

Представление данных конфигурации для одного расширения чата OpenAI Azure. Это будет использоваться запросом завершения чата, который должен использовать Azure расширения чата OpenAI для расширения поведения ответа. Использование этой конфигурации совместимо только с Azure OpenAI.

топ_n_документы
top_n_documents integer

Настроено первое число документов для функции настроенного запроса.

в пределах области
in_scope boolean

Следует ли ограничить запросы использованием индексированных данных.

strictness
strictness integer

Настроенная строгость фильтрации релевантности поиска. Чем выше строгость, тем выше точность, но более низкий отзыв ответа.

информация_о_роли
role_information string

Дайте модели инструкции о том, как он должен вести себя и какой-либо контекст, на который он должен ссылаться при создании ответа. Вы можете описать личность помощника и рассказать о том, как отформатировать ответы. Существует ограничение на 100 маркеров, и он учитывается в отношении общего ограничения маркера.

имя_индекса
index_name True string

Имя индекса, используемого как доступное в ресурсе поиска Azure.

поле_название
title_field string

Имя поля индекса, используемого в качестве заголовка.

поле_ссылки
url_field string

Имя поля индекса, используемого в качестве URL-адреса.

поле_пути_к_файлу
filepath_field string

Имя поля индекса, используемого в качестве файлового пути.

поля_контента
content_fields array of string

Имена полей индекса, которые следует рассматривать как содержимое.

разделитель полей содержания
content_fields_separator string

Шаблон разделителя, который должны использовать поля содержимого.

векторные поля
vector_fields array of string

Имена полей, представляющих векторные данные.

тип_запроса
query_type string

Тип запроса Azure поиска, который должен выполняться при использовании в Azure качестве расширения чата OpenAI.

семантическая конфигурация
semantic_configuration string

Дополнительная семантическая конфигурация для запроса.

фильтр
filter string

Фильтр поиска.

type
type string

Представляет доступные источники, Azure OpenAI On Your Data можно использовать для настройки векторизации данных для использования с векторным поиском.

имя_развертывания
deployment_name True string

Указывает имя развертывания модели, используемого для векторизации. Это развертывание модели должно находиться в том же Azure ресурсе OpenAI, но при использовании этого развертывания модели с помощью внутреннего вызова, а не общедоступного, что позволяет выполнять поиск векторов даже в частных сетях.

н
n integer

Сколько вариантов завершения чата для каждого входного сообщения.

seed
seed integer

Если задано, наша система будет предпринять лучшие усилия для выборки детерминированного, таким образом, что повторяющиеся запросы с одинаковыми и теми же параметрами должны возвращать тот же seed результат. Детерминированность не гарантируется, и вы должны ссылаться на system_fingerprint параметр ответа для отслеживания изменений в серверной части.

logprobs
logprobs boolean

Следует ли возвращать вероятности журналов выходных маркеров или нет. Если значение true, возвращает вероятности журнала каждого выходного маркера, возвращаемого в параметре contentmessage. Этот параметр в настоящее время недоступен в gpt-4-vision-preview модели.

top_logprobs
top_logprobs integer

Целое число от 0 до 5, указывающее число наиболее вероятных маркеров, возвращаемых по каждой позиции маркера, каждый из которых имеет связанную вероятность журнала. logprobs Необходимо задать значение true , если этот параметр используется.

type
type string

Параметр включения json_object режима JSON. Это гарантирует, что сообщение, которое создает модель, является допустимым JSON.

Возвращаемое значение

Определения

Message

Сообщение чата.

Имя Путь Тип Описание
index
index integer

Индекс сообщения в беседе.

роль
role string

Роль автора этого сообщения.

получатель;
recipient string

Получатель сообщения в формате <пространства> имен.<операция>. При наличии и только в том случае, если получатель является инструментом.

содержимое
content string

Содержимое сообщения

end_turn
end_turn boolean

Заканчивается ли сообщение поворотом.

ExtensionsChatCompletionsResponse

Ответ завершения чата расширений.

Имя Путь Тип Описание
id
id string
объект
object string
создано
created integer
model
model string
результаты_фильтрации_запросов
prompt_filter_results promptFilterResults

Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.

подсказывающие токены
usage.prompt_tokens integer
токены завершения
usage.completion_tokens integer
общее количество токенов
usage.total_tokens integer
choices
choices array of ExtensionsChatCompletionChoice

ExtensionsChatCompletionChoice

Имя Путь Тип Описание
index
index integer
причина окончания
finish_reason string
результаты фильтрации контента
content_filter_results contentFilterResults

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет.

messages
messages array of Message

Список сообщений, возвращаемых службой.

contentFilterResult

Имя Путь Тип Описание
severity
severity string
filtered
filtered boolean

contentFilterResults

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет.

Имя Путь Тип Описание
sexual
sexual contentFilterResult
violence
violence contentFilterResult
hate
hate contentFilterResult
самоповреждение
self_harm contentFilterResult
ошибка
error errorBase

результат фильтрации запроса

Результаты фильтрации содержимого для одного запроса.

Имя Путь Тип Описание
индекс_подсказки
prompt_index integer
результаты фильтрации контента
content_filter_results contentFilterResults

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет.

фильтрация результатов

Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.

Имя Путь Тип Описание
Товары
promptFilterResult

Результаты фильтрации содержимого для одного запроса.

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

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.

Имя Путь Тип Описание
sexual
sexual contentFilterSeverityResult_2024Feb15Preview
violence
violence contentFilterSeverityResult_2024Feb15Preview
hate
hate contentFilterSeverityResult_2024Feb15Preview
самоповреждение
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

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о стороннем тексте и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.

Имя Путь Тип Описание
sexual
sexual contentFilterSeverityResult_2024Feb15Preview
violence
violence contentFilterSeverityResult_2024Feb15Preview
hate
hate contentFilterSeverityResult_2024Feb15Preview
самоповреждение
self_harm contentFilterSeverityResult_2024Feb15Preview
profanity
profanity contentFilterDetectedResult_2024Feb15Preview
custom_blocklists
custom_blocklists array of contentFilterIdResult_2024Feb15Preview
ошибка
error errorBase_2024Feb15Preview
защищённый_текст_материала
protected_material_text contentFilterDetectedResult_2024Feb15Preview
код_защищённого_материала
protected_material_code contentFilterDetectedWithCitationResult_2024Feb15Preview

promptFilterResult_2024Feb15Preview

Результаты фильтрации содержимого для одного запроса.

Имя Путь Тип Описание
индекс_подсказки
prompt_index integer
результаты фильтрации контента
content_filter_results contentFilterPromptResults_2024Feb15Preview

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о содержимом и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.

promptFilterResults_2024Feb15Preview

Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.

Имя Путь Тип Описание
Товары
promptFilterResult_2024Feb15Preview

Результаты фильтрации содержимого для одного запроса.

azureChatExtensionsMessageContext_2024Feb15Preview

Представление дополнительных сведений о контексте, доступных при Azure расширениях чата OpenAI, участвует в создании соответствующего ответа на завершение чата. Эти сведения контекста заполняются только при использовании запроса OpenAI Azure, настроенного для использования соответствующего расширения.

Имя Путь Тип Описание
citations
citations array of citation_2024Feb15Preview

Результат извлечения источника данных, используемый для создания сообщения помощника в ответе.

намерение
intent string

Обнаруженное намерение из журнала чата, используемое для передачи в следующий поворот для переноса контекста.

citation_2024Feb15Preview

сведения о ссылке для сообщения ответа о завершении чата.

Имя Путь Тип Описание
содержимое
content string

Содержимое ссылки.

title
title string

Заголовок ссылки.

URL-адрес
url string

URL-адрес ссылки.

путь к файлу
filepath string

Путь к файлу ссылки.

идентификатор_блока
chunk_id string

Идентификатор фрагмента ссылки.

createChatCompletionResponse_2024Feb15Preview

Имя Путь Тип Описание
id
id string

Уникальный идентификатор завершения чата.

объект
object chatCompletionResponseObject_2024Feb15Preview

Тип объекта.

создано
created integer

Метка времени Unix (в секундах) при создании завершения чата.

model
model string

Модель, используемая для завершения чата.

использование
usage completionUsage_2024Feb15Preview

Статистика использования для запроса завершения.

системный отпечаток
system_fingerprint string

Можно использовать в сочетании с параметром seed запроса, чтобы понять, когда внутренние изменения были внесены, что может повлиять на детерминированность.

результаты_фильтрации_запросов
prompt_filter_results promptFilterResults_2024Feb15Preview

Результаты фильтрации содержимого для нуля или более запросов в запросе. В запросе потоковой передачи результаты для различных запросов могут поступать в разное время или в разных заказах.

choices
choices array of object
index
choices.index integer
причина окончания
choices.finish_reason string
сообщение
choices.message chatCompletionResponseMessage_2024Feb15Preview

Сообщение о завершении чата, созданное моделью.

результаты фильтрации контента
choices.content_filter_results contentFilterChoiceResults_2024Feb15Preview

Сведения о категории фильтрации содержимого (ненавидимая, сексуальность, насилие, self_harm), если она обнаружена, а также уровень серьезности (very_low, низкий, средний, высокомасштабируемый, определяющий интенсивность и уровень риска вредного содержимого) и если он был отфильтрован или нет. Сведения о стороннем тексте и ненормативной лексике, если он обнаружен, и если он был отфильтрован или нет. И сведения о списке блокировок клиента, если он был отфильтрован и его идентификатор.

logprobs
choices.logprobs chatCompletionChoiceLogProbs_2024Feb15Preview

Сведения о вероятности журнала для выбора.

chatCompletionChoiceLogProbs_2024Feb15Preview

Сведения о вероятности журнала для выбора.

Имя Путь Тип Описание
содержимое
content array of chatCompletionTokenLogprob_2024Feb15Preview

Список маркеров содержимого сообщения с информацией о вероятности журнала.

chatCompletionTokenLogprob_2024Feb15Preview

Имя Путь Тип Описание
token
token string

Маркер.

logprob
logprob number

Вероятность этого токена в журнале.

байт
bytes array of integer

Список целых чисел, представляющих представление маркера UTF-8 байт. Полезно в случаях, когда символы представлены несколькими токенами, а их байтовые представления должны объединяться для создания правильного текстового представления. Может быть null , если для маркера нет представления байтов.

top_logprobs
top_logprobs array of object

Список наиболее вероятных маркеров и их вероятности журналов в этой позиции маркера. В редких случаях количество запрошенных top_logprobs возвращаемых данных может быть меньше.

token
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
context azureChatExtensionsMessageContext_2024Feb15Preview

Представление дополнительных сведений о контексте, доступных при Azure расширениях чата OpenAI, участвует в создании соответствующего ответа на завершение чата. Эти сведения контекста заполняются только при использовании запроса OpenAI Azure, настроенного для использования соответствующего расширения.

chatCompletionResponseMessageRole_2024Feb15Preview

Роль автора сообщения ответа.

Роль автора сообщения ответа.

chatCompletionResponseObject_2024Feb15Preview

Тип объекта.

Тип объекта.

completionUsage_2024Feb15Preview

Статистика использования для запроса завершения.

Имя Путь Тип Описание
подсказывающие токены
prompt_tokens integer

Количество маркеров в запросе.

токены завершения
completion_tokens integer

Количество маркеров в созданном завершении.

общее количество токенов
total_tokens integer

Общее количество маркеров, используемых в запросе (запрос + завершение).

getSingleEmbeddingsResponse_2024Feb15Preview

Имя Путь Тип Описание
объект
object string

Сведения о типе объекта ответа

model
model string

имя модели;

внедрение
embedding array of number

Массив с плавающей запятой, представляющий вычисляемые внедрения для заданных входных данных

подсказывающие токены
usage.prompt_tokens integer

Количество маркеров, используемых во входных данных

общее количество токенов
usage.total_tokens integer

Общие маркеры, используемые

getMultipleEmbeddingsResponse_2024Feb15Preview

Имя Путь Тип Описание
объект
object string

Сведения о типе объекта ответа

model
model string

имя модели;

embeddings
embeddings array of array

Массив с массивами с плавающей запятой, представляющий вычисляемую внедренную коллекцию входных строк

items
embeddings array of number
подсказывающие токены
usage.prompt_tokens integer

Количество маркеров, используемых во входных данных

общее количество токенов
usage.total_tokens integer

Общие маркеры, используемые