@azure-rest/ai-content-safety package
Интерфейсы
| AddBlockItems | |
| AddBlockItems200Response |
Запрос выполнен успешно. |
| AddBlockItemsBodyParam | |
| AddBlockItemsDefaultHeaders | |
| AddBlockItemsDefaultResponse | |
| AddBlockItemsOptions |
Запрос на добавление blockItems в текстовый список блокировок. |
| AddBlockItemsResultOutput |
Ответ на добавление blockItems в текстовый список блокировок. |
| AnalyzeImage | |
| AnalyzeImage200Response |
Запрос выполнен успешно. |
| AnalyzeImageBodyParam | |
| AnalyzeImageDefaultHeaders | |
| AnalyzeImageDefaultResponse | |
| AnalyzeImageOptions |
Запрос на анализ изображения. |
| AnalyzeImageOptionsOutput |
Запрос на анализ изображения. |
| AnalyzeImageResultOutput |
Ответ на анализ изображения. |
| AnalyzeText | |
| AnalyzeText200Response |
Запрос выполнен успешно. |
| AnalyzeTextBodyParam | |
| AnalyzeTextDefaultHeaders | |
| AnalyzeTextDefaultResponse | |
| AnalyzeTextOptions |
Запрос на анализ текста. |
| AnalyzeTextOptionsOutput |
Запрос на анализ текста. |
| AnalyzeTextResultOutput |
Ответ на анализ текста |
| CreateOrUpdateTextBlocklist200Response |
Запрос выполнен успешно. |
| CreateOrUpdateTextBlocklist201Response |
Запрос выполнен успешно, и в результате был создан новый ресурс. |
| CreateOrUpdateTextBlocklistBodyParam | |
| CreateOrUpdateTextBlocklistDefaultHeaders | |
| CreateOrUpdateTextBlocklistDefaultResponse | |
| CreateOrUpdateTextBlocklistMediaTypesParam | |
| DeleteTextBlocklist204Response |
Содержимое для этого запроса не отправляется, но заголовки могут оказаться полезными. |
| DeleteTextBlocklistDefaultHeaders | |
| DeleteTextBlocklistDefaultResponse | |
| GetTextBlocklist | |
| GetTextBlocklist200Response |
Запрос выполнен успешно. |
| GetTextBlocklistDefaultHeaders | |
| GetTextBlocklistDefaultResponse | |
| GetTextBlocklistItem | |
| GetTextBlocklistItem200Response |
Запрос выполнен успешно. |
| GetTextBlocklistItemDefaultHeaders | |
| GetTextBlocklistItemDefaultResponse | |
| ImageAnalyzeSeverityResultOutput |
Результат анализа изображений. |
| ImageData |
Содержимое или URL-адрес большого двоичного объекта изображения может быть байтами в кодировке Base64 или URL-адресом большого двоичного объекта. Если предоставлено оба варианта, запрос будет отклонен. Максимальный размер изображения составляет 2048 пикселей * 2048 пикселей, но не более 4 МБ одновременно. Минимальный размер изображения составляет 50 пикселей * 50 пикселей. |
| ImageDataOutput |
Содержимое или URL-адрес большого двоичного объекта изображения может быть байтами в кодировке Base64 или URL-адресом большого двоичного объекта. Если предоставлено оба варианта, запрос будет отклонен. Максимальный размер изображения составляет 2048 пикселей * 2048 пикселей, но не более 4 МБ одновременно. Минимальный размер изображения составляет 50 пикселей * 50 пикселей. |
| ListTextBlocklistItems | |
| ListTextBlocklistItems200Response |
Запрос выполнен успешно. |
| ListTextBlocklistItemsDefaultHeaders | |
| ListTextBlocklistItemsDefaultResponse | |
| ListTextBlocklistItemsQueryParam | |
| ListTextBlocklistItemsQueryParamProperties | |
| ListTextBlocklists | |
| ListTextBlocklists200Response |
Запрос выполнен успешно. |
| ListTextBlocklistsDefaultHeaders | |
| ListTextBlocklistsDefaultResponse | |
| PagingOptions |
Параметры вспомогательного средства подкачки |
| RemoveBlockItems | |
| RemoveBlockItems204Response |
Содержимое для этого запроса не отправляется, но заголовки могут оказаться полезными. |
| RemoveBlockItemsBodyParam | |
| RemoveBlockItemsDefaultHeaders | |
| RemoveBlockItemsDefaultResponse | |
| RemoveBlockItemsOptions |
Запрос на удаление blockItems из текстового списка блокировок. |
| Routes | |
| TextAnalyzeSeverityResultOutput |
Результат анализа текста. |
| TextBlockItemInfo |
Блокировать сведения об элементе в текстовом списке блокировок. |
| TextBlockItemOutput |
Элемент в TextBlocklist. |
| TextBlocklist |
Список блокировок текста. |
| TextBlocklistMatchResultOutput |
Результат сопоставления списка блокировок. |
| TextBlocklistOutput |
Список блокировок текста. |
Псевдонимы типа
| AddBlockItemsParameters | |
| AnalyzeImageParameters | |
| AnalyzeTextParameters | |
| ContentSafetyClient | |
| CreateOrUpdateTextBlocklistParameters | |
| DeleteTextBlocklistParameters | |
| GetArrayType |
Вспомогательный тип для извлечения типа массива |
| GetPage |
Тип пользовательской функции, определяющей способ получения страницы и ссылки на следующую, если она есть. |
| GetTextBlocklistItemParameters | |
| GetTextBlocklistParameters | |
| ListTextBlocklistItemsParameters | |
| ListTextBlocklistsParameters | |
| PaginateReturn |
Вспомогательный тип для вывода типа выгружаемых элементов из типа ответа Этот тип создается на основе сведений swagger для x-ms-pageable, в частности, в свойстве itemName, которое указывает свойство ответа, в котором находятся элементы страницы. Значение по умолчанию — |
| RemoveBlockItemsParameters | |
| TextBlockItemListOutput |
Постраничной коллекции элементов TextBlockItem |
| TextBlocklistListOutput |
Постраничной коллекции элементов TextBlocklist |
| TextBlocklistResourceMergeAndPatch |
Экземпляр ресурса. |
Функции
Сведения о функции
default(string, KeyCredential, ClientOptions)
Инициализация нового экземпляра ContentSafetyClient
function default(endpoint: string, credentials: KeyCredential, options?: ClientOptions): ContentSafetyClientПараметры
- endpoint
-
string
Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например: https://.cognitiveservices.azure.com).
- credentials
- KeyCredential
уникальные учетные данные клиента
- options
- ClientOptions
параметр для всех необязательных параметров
Возвращаемое значение
isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)
function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): responseПараметры
- response
Возвращаемое значение
response
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)
function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)
function isUnexpected(response: CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)
function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)
function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(AddBlockItems200Response | AddBlockItemsDefaultResponse)
function isUnexpected(response: AddBlockItems200Response | AddBlockItemsDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse)
function isUnexpected(response: RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)
function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): responseПараметры
Возвращаемое значение
response
isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)
function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): responseПараметры
Возвращаемое значение
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
Начальный ответ, содержащий nextLink и текущую страницу элементов
- options
-
PagingOptions<TResponse>
Возвращаемое значение
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator для итерации элементов
Azure SDK for JavaScript