OpenAIClientOptionsWithAzureAgent interface

Пакет:

@azure/ai-projects

Расширенные опции клиента OpenAI с включением конфигурации конечных точек Azure Agent.

Extends

ClientOptions

Свойства

azureConfig

Azure Agent endpoint configuration.

Унаследованные свойства

adminAPIKey	По умолчанию process.env['OPENAI_ADMIN_KEY'].
apiKey	API-ключ, используемый для аутентификации. Принимает либо статическую строку, либо асинхронную функцию, которая разрешается в строку. По умолчанию process.env['OPENAI_API_KEY']. Когда функция предоставляется, она запускается перед каждым запросом, чтобы вы могли менять или обновлять учетные данные во время выполнения. Функция должна вернуть непустую строку; иначе бросается OpenAIError. Если функция срабатывает, ошибка оборачивается в OpenAIError с исходной ошибкой, доступной как cause. Взаимоисключающ с workloadIdentity.
baseURL	Переопределить базовый URL по умолчанию для API, например, "https://api.example.com/v2/" По умолчанию process.env['OPENAI_BASE_URL'].
dangerouslyAllowBrowser	По умолчанию использование этой библиотеки на стороне клиента запрещено, так как она рискует раскрыть ваши секретные учетные данные API злоумышленникам. Устанавливайте этот вариант true только если понимаете риски и имеете соответствующие меры снижения.
defaultHeaders	Заголовки по умолчанию для каждого запроса в API. Их можно удалить в отдельных запросах, явно установив заголовок как null в Request options.
defaultQuery	Параметры запроса по умолчанию для каждого запроса в API. Их можно удалить в отдельных запросах, явно установив параметр в undefined параметрах запроса.
fetch	Укажите реализацию пользовательской fetch функции. Если это не указано, мы ожидаем, что это fetch определено глобально.
fetchOptions	Дополнительные RequestInit опции для fetch звонков. Свойства будут переопределёны по fetchOptionsзапросу .
logger	Поставь лесоруб. По умолчанию установлен globalThis.console.
logLevel	Установите уровень бревна. По умолчанию отображается process.env['OPENAI_LOG'] или 'warn', если он не настроен.
maxRetries	Максимальное количество попыток клиента повторить запрос в случае временного отказа, например, сетевой ошибки или ошибки 5XX сервера.
organization	По умолчанию process.env['OPENAI_ORG_ID'].
project	По умолчанию работает process.env['OPENAI_PROJECT_ID'].
provider	Настройте этот клиент на использование стороннего API провайдера. Взаимоисключающийся с максимальной аутентификацией и baseURL опциями.
timeout	Максимальное время (в миллисекундах), которое клиент должен ожидать ответа от сервера перед тайм-аутом одного запроса. Обратите внимание, что тайм-ауты запросов повторяются по умолчанию, поэтому в худшем случае вы можете ждать гораздо дольше, пока обещание не сработает или не сработает.
webhookSecret	По умолчанию работает process.env['OPENAI_WEBHOOK_SECRET'].
workloadIdentity	Конфигурация идентификации рабочей нагрузки для аутентификации обмена токенами OAuth2. Взаимоисключающ с apiKey.

Сведения о свойстве

azureConfig

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Значение свойства

AzureAgentConfig

Сведения об унаследованном свойстве

adminAPIKey

По умолчанию process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: null | string

Значение свойства

null | string

Унаследованный от OpenAIClientOptions.adminAPIKey

apiKey

API-ключ, используемый для аутентификации.

• Принимает либо статическую строку, либо асинхронную функцию, которая разрешается в строку.
• По умолчанию process.env['OPENAI_API_KEY'].
• Когда функция предоставляется, она запускается перед каждым запросом, чтобы вы могли менять или обновлять учетные данные во время выполнения.
• Функция должна вернуть непустую строку; иначе бросается OpenAIError.
• Если функция срабатывает, ошибка оборачивается в OpenAIError с исходной ошибкой, доступной как cause.
• Взаимоисключающ с workloadIdentity.

apiKey?: null | string | ApiKeySetter

Значение свойства

null | string | ApiKeySetter

Унаследованный от OpenAIClientOptions.apiKey

baseURL

Переопределить базовый URL по умолчанию для API, например, "https://api.example.com/v2/"

По умолчанию process.env['OPENAI_BASE_URL'].

baseURL?: null | string

Значение свойства

null | string

Унаследованный от OpenAIClientOptions.baseURL

dangerouslyAllowBrowser

По умолчанию использование этой библиотеки на стороне клиента запрещено, так как она рискует раскрыть ваши секретные учетные данные API злоумышленникам. Устанавливайте этот вариант true только если понимаете риски и имеете соответствующие меры снижения.

dangerouslyAllowBrowser?: boolean

Значение свойства

boolean

Унаследованный от OpenAIClientOptions.dangerouslyAllowBrowser

defaultHeaders

Заголовки по умолчанию для каждого запроса в API.

Их можно удалить в отдельных запросах, явно установив заголовок как null в Request options.

defaultHeaders?: HeadersLike

Значение свойства

HeadersLike

Унаследованный от OpenAIClientOptions.defaultHeaders

defaultQuery

Параметры запроса по умолчанию для каждого запроса в API.

Их можно удалить в отдельных запросах, явно установив параметр в undefined параметрах запроса.

defaultQuery?: Record<string, undefined | string>

Значение свойства

Record<string, undefined | string>

Унаследованный от OpenAIClientOptions.defaultQuery

fetch

Укажите реализацию пользовательской fetch функции.

Если это не указано, мы ожидаем, что это fetch определено глобально.

fetch?: Fetch

Значение свойства

Fetch

Унаследованный от OpenAIClientOptions.fetch

fetchOptions

Дополнительные RequestInit опции для fetch звонков. Свойства будут переопределёны по fetchOptionsзапросу .

fetchOptions?: MergedRequestInit

Значение свойства

MergedRequestInit

Унаследованный от OpenAIClientOptions.fetchOptions

logger

Поставь лесоруб.

По умолчанию установлен globalThis.console.

logger?: Logger

Значение свойства

Logger

Унаследованный от OpenAIClientOptions.logger

logLevel

Установите уровень бревна.

По умолчанию отображается process.env['OPENAI_LOG'] или 'warn', если он не настроен.

logLevel?: LogLevel

Значение свойства

LogLevel

Унаследованный от OpenAIClientOptions.logLevel

maxRetries

Максимальное количество попыток клиента повторить запрос в случае временного отказа, например, сетевой ошибки или ошибки 5XX сервера.

maxRetries?: number

Значение свойства

number

Унаследованный от OpenAIClientOptions.maxRetries

organization

По умолчанию process.env['OPENAI_ORG_ID'].

organization?: null | string

Значение свойства

null | string

Унаследованный от OpenAIClientOptions.organization

project

По умолчанию работает process.env['OPENAI_PROJECT_ID'].

project?: null | string

Значение свойства

null | string

Унаследованный от OpenAIClientOptions.project

provider

Настройте этот клиент на использование стороннего API провайдера. Взаимоисключающийся с максимальной аутентификацией и baseURL опциями.

provider?: Provider

Значение свойства

Provider

Унаследованный от OpenAIClientOptions.provider

timeout

Максимальное время (в миллисекундах), которое клиент должен ожидать ответа от сервера перед тайм-аутом одного запроса.

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

timeout?: number

Значение свойства

number

Унаследованный от OpenAIClientOptions.timeout

webhookSecret

По умолчанию работает process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: null | string

Значение свойства

null | string

Унаследованный от OpenAIClientOptions.webhookSecret

workloadIdentity

Конфигурация идентификации рабочей нагрузки для аутентификации обмена токенами OAuth2. Взаимоисключающ с apiKey.

workloadIdentity?: WorkloadIdentity

Значение свойства

WorkloadIdentity

Унаследованный от OpenAIClientOptions.workloadIdentity