Поделиться через

@azure-rest/ai-content-safety package

  • Ссылка

Интерфейсы

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

Запрос выполнен успешно.
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

Запрос на добавление blocklistItems в текстовый блок-список.
AddOrUpdateTextBlocklistItemsResultOutput

Ответ добавления blocklistItems в текстовый блок-список.
AnalyzeImage
AnalyzeImage200Response

Запрос выполнен успешно.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

Запрос на анализ изображений.
AnalyzeImageResultOutput

Ответ на анализ изображений.
AnalyzeText
AnalyzeText200Response

Запрос выполнен успешно.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

Запрос на анализ текста.
AnalyzeTextResultOutput

Ответ на анализ текста.
ContentSafetyClientOptions

Необязательные параметры для клиента
CreateOrUpdateTextBlocklist200Response

Запрос выполнен успешно.
CreateOrUpdateTextBlocklist201Response

Запрос успешно выполнен, и в результате был создан новый ресурс.
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Для этого запроса нет содержимого, но заголовки могут быть полезны.
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

Запрос выполнен успешно.
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

Запрос выполнен успешно.
GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput

Результат анализа изображений.
ImageData

Изображение может быть закодировано в кодировке Base64 или URL-адрес большого двоичного объекта. Вы можете выбрать только один из этих вариантов. Если оба указаны, запрос будет отклонен. Максимальный размер изображения составляет 2048 x 2048 пикселей и не должен превышать 4 МБ, а минимальный размер изображения составляет 50 x 50 пикселей.
ListTextBlocklistItems
ListTextBlocklistItems200Response

Запрос выполнен успешно.
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

Запрос выполнен успешно.
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PageSettings

Интерфейс, отслеживающий параметры для итерации страниц
PagedAsyncIterableIterator

Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.
PagedTextBlocklistItemOutput

Коллекция paged элементов TextBlocklistItem
PagedTextBlocklistOutput

Коллекция paged элементов TextBlocklist
PagingOptions

Параметры вспомогательного помощника по страницам
RemoveBlocklistItems
RemoveBlocklistItems204Response

Для этого запроса нет содержимого, но заголовки могут быть полезны.
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

Запрос на удаление blocklistItems из текстового блока.
Routes
TextBlocklist

Список блокировок текста.
TextBlocklistItem

Элемент в TextBlocklist.
TextBlocklistItemOutput

Элемент в TextBlocklist.
TextBlocklistMatchOutput

Результат сопоставления блок-списка.
TextBlocklistOutput

Список блокировок текста.
TextCategoriesAnalysisOutput

Результат анализа текста.

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

AddOrUpdateBlocklistItemsParameters
AnalyzeImageOutputType

Псевдоним для AnalyzeImageOutputType
AnalyzeImageParameters
AnalyzeTextOutputType

Псевдоним для AnalyzeTextOutputType
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Вспомогательный тип для извлечения типа массива
GetPage

Тип настраиваемой функции, которая определяет, как получить страницу и ссылку на следующую.
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ImageCategory

Псевдоним для ImageCategory
ImageCategoryOutput

Псевдоним для ImageCategoryOutput
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

Вспомогательный тип для вывода типа страничных элементов из типа ответа этот тип создается на основе сведений swagger для x-ms-pageable специально в свойстве itemName, которое указывает свойство ответа, в котором находятся элементы страницы. Значение по умолчанию — value. Этот тип позволяет предоставлять строго типизированный итератор на основе ответа, который мы получаем в качестве второго параметра.
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

Экземпляр ресурса.
TextCategory

Псевдоним для TextCategory
TextCategoryOutput

Псевдоним для TextCategoryOutput

Функции

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Инициализация нового экземпляра ContentSafetyClient
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)
isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)
isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)
isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)
isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)
isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)
isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)
isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)
isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Вспомогательный элемент для разбивки результатов из первоначального ответа, который соответствует спецификации расширения autorest x-ms-pageable

Сведения о функции

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Инициализация нового экземпляра ContentSafetyClient

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ContentSafetyClientOptions): ContentSafetyClient

Параметры

endpointParam

string

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

уникально идентификация учетных данных клиента

options
ContentSafetyClientOptions

параметр для всех необязательных параметров

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

ContentSafetyClient

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse) 

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Параметры

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

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

response

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse) 

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Параметры

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

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

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse) 

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Параметры

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

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

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse) 

function isUnexpected(response: CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse): response

Параметры

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

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

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse) 

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Параметры

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

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

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse) 

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Параметры

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

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

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse) 

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Параметры

response

AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse

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

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse) 

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Параметры

response

RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse

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

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse) 

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Параметры

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

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

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse) 

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Параметры

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

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

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Вспомогательный элемент для разбивки результатов из первоначального ответа, который соответствует спецификации расширения autorest x-ms-pageable

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Параметры

client
Client

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

initialResponse

TResponse

Начальный ответ, содержащий следующую ссылку и текущую страницу элементов

options

PagingOptions<TResponse>

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

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator для итерации элементов