@azure-rest/ai-content-safety package

Interfaces

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response	La solicitud se ha realizado correctamente.
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions	Solicitud para agregar blocklistItems a una lista de bloques de texto.
AddOrUpdateTextBlocklistItemsResultOutput	Respuesta de agregar blocklistItems a la lista de bloques de texto.
AnalyzeImage
AnalyzeImage200Response	La solicitud se ha realizado correctamente.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions	Solicitud de análisis de imágenes.
AnalyzeImageOptionsOutput	Solicitud de análisis de imágenes.
AnalyzeImageResultOutput	Respuesta de análisis de imágenes.
AnalyzeText
AnalyzeText200Response	La solicitud se ha realizado correctamente.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions	Solicitud de análisis de texto.
AnalyzeTextOptionsOutput	Solicitud de análisis de texto.
AnalyzeTextResultOutput	Respuesta de análisis de texto.
CreateOrUpdateTextBlocklist200Response	La solicitud se ha realizado correctamente.
CreateOrUpdateTextBlocklist201Response	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response	No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response	La solicitud se ha realizado correctamente.
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response	La solicitud se ha realizado correctamente.
GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput	Resultado del análisis de imágenes.
ImageData	La imagen puede ser bytes codificados en base64 o una dirección URL de blob. Solo puede elegir una de estas opciones. Si se proporcionan ambos, se rechazará la solicitud. El tamaño máximo de la imagen es de 2048 x 2048 píxeles y no debe superar los 4 MB, mientras que el tamaño mínimo de la imagen es de 50 x 50 píxeles.
ImageDataOutput	La imagen puede ser bytes codificados en base64 o una dirección URL de blob. Solo puede elegir una de estas opciones. Si se proporcionan ambos, se rechazará la solicitud. El tamaño máximo de la imagen es de 2048 x 2048 píxeles y no debe superar los 4 MB, mientras que el tamaño mínimo de la imagen es de 50 x 50 píxeles.
ListTextBlocklistItems
ListTextBlocklistItems200Response	La solicitud se ha realizado correctamente.
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response	La solicitud se ha realizado correctamente.
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions	Opciones para el asistente de paginación
RemoveBlocklistItems
RemoveBlocklistItems204Response	No hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions	Solicitud para quitar blocklistItems de una lista de bloques de texto.
Routes
TextBlocklist	Lista de texto bloqueado.
TextBlocklistItem	Elemento de textBlocklist.
TextBlocklistItemOutput	Elemento de textBlocklist.
TextBlocklistMatchOutput	Resultado de la coincidencia de la lista de bloques.
TextBlocklistOutput	Lista de texto bloqueado.
TextCategoriesAnalysisOutput	Resultado del análisis de texto.

Alias de tipos

AddOrUpdateBlocklistItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType	Tipo auxiliar para extraer el tipo de una matriz
GetPage	Tipo de una función personalizada que define cómo obtener una página y un vínculo al siguiente si existe.
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PagedTextBlocklistItemOutput	Colección paginada de elementos TextBlocklistItem
PagedTextBlocklistOutput	Colección paginada de elementos TextBlocklist
PaginateReturn	Tipo auxiliar para deducir el tipo de elementos paginados del tipo de respuesta Este tipo se genera en función de la información de swagger para x-ms-pageable específicamente en la propiedad itemName que indica la propiedad de la respuesta donde se encuentran los elementos de página. El valor predeterminado es value. Este tipo nos permitirá proporcionar iterador fuertemente tipado en función de la respuesta que obtenemos como segundo parámetro.
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch	Instancia de recurso.

Funciones

default(string, TokenCredential | KeyCredential, ClientOptions)	Inicialización de una nueva instancia de ContentSafetyClient
isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
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>)	Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de la extensión Autorest x-ms-pageable

Detalles de la función

default(string, TokenCredential | KeyCredential, ClientOptions)

Inicialización de una nueva instancia de ContentSafetyClient

function default(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): ContentSafetyClient

Parámetros

endpoint

string

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

identificar de forma única las credenciales de cliente

options

ClientOptions

el parámetro para todos los parámetros opcionales

Devoluciones

ContentSafetyClient

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parámetros

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

Devoluciones

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parámetros

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

Devoluciones

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parámetros

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

Devoluciones

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parámetros

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

Devoluciones

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parámetros

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

Devoluciones

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parámetros

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

Devoluciones

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parámetros

response

AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse

Devoluciones

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parámetros

response

RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse

Devoluciones

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parámetros

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

Devoluciones

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parámetros

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

Devoluciones

response

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

Asistente para paginar los resultados de una respuesta inicial que sigue la especificación de la extensión Autorest x-ms-pageable

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

Parámetros

client

Client

Cliente que se va a usar para enviar las solicitudes de la página siguiente

initialResponse

TResponse

Respuesta inicial que contiene la página nextLink y la página actual de elementos

options

PagingOptions<TResponse>

Devoluciones

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator para iterar los elementos