ContentSafetyClient.GetTextBlocklistItemsAsync Método

Definición

Espacio de nombres:

Azure.AI.ContentSafety

Ensamblado:

Azure.AI.ContentSafety.dll

Paquete:

Azure.AI.ContentSafety v1.0.0-beta.1

Sobrecargas

GetTextBlocklistItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, CancellationToken)	Obtiene todos los objetos BlockItems por blocklistName.
GetTextBlocklistItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, RequestContext)	[Método Protocol] Obtener todos los objetos BlockItems por blocklistName Este método de protocolo permite la creación explícita de la solicitud y el procesamiento de la respuesta para escenarios avanzados. Pruebe primero la sobrecarga de comodidad más GetTextBlocklistItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, CancellationToken) sencilla con modelos fuertemente tipados.

GetTextBlocklistItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Obtiene todos los objetos BlockItems por blocklistName.

public virtual Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlockItem> GetTextBlocklistItemsAsync (string blocklistName, int? maxCount = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlockItem>
override this.GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlockItem>

Public Overridable Function GetTextBlocklistItemsAsync (blocklistName As String, Optional maxCount As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of TextBlockItem)

Parámetros

blocklistName

String

Nombre de la lista de bloques de texto.

maxCount

Nullable<Int32>

Número de elementos de resultado que se van a devolver.

skip

Nullable<Int32>

Número de elementos de resultado que se van a omitir.

maxpagesize

Nullable<Int32>

Número máximo de elementos de resultado por página.

cancellationToken

CancellationToken

Token de cancelación que se va a usar.

Devoluciones

AsyncPageable<TextBlockItem>

Excepciones

ArgumentNullException

blocklistName es null.

ArgumentException

blocklistName es una cadena vacía y se esperaba que no estuviera vacía.

Ejemplos

En este ejemplo se muestra cómo llamar a GetTextBlocklistItemsAsync con parámetros necesarios.

var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ContentSafetyClient(endpoint, credential);

await foreach (var item in client.GetTextBlocklistItemsAsync("<blocklistName>", 1234, 1234, 1234))
{
}

Comentarios

Obtiene todos los objetos blockItems en una lista de bloques de texto.

GetTextBlocklistItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, RequestContext)

[Método Protocol] Obtener todos los objetos BlockItems por blocklistName

• Este método de protocolo permite la creación explícita de la solicitud y el procesamiento de la respuesta para escenarios avanzados.
• Pruebe primero la sobrecarga de comodidad más GetTextBlocklistItemsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, CancellationToken) sencilla con modelos fuertemente tipados.

public virtual Azure.AsyncPageable<BinaryData> GetTextBlocklistItemsAsync (string blocklistName, int? maxCount, int? skip, int? maxpagesize, Azure.RequestContext context);

abstract member GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetTextBlocklistItemsAsync (blocklistName As String, maxCount As Nullable(Of Integer), skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)

Parámetros

blocklistName

String

Nombre de la lista de bloques de texto.

maxCount

Nullable<Int32>

Número de elementos de resultado que se van a devolver.

skip

Nullable<Int32>

Número de elementos de resultado que se van a omitir.

maxpagesize

Nullable<Int32>

Número máximo de elementos de resultado por página.

context

RequestContext

Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.

Devoluciones

AsyncPageable<BinaryData>

del AsyncPageable<T> servicio que contiene una lista de BinaryData objetos. Los detalles del esquema de cuerpo de cada elemento de la colección se encuentran en la sección Comentarios siguiente.

Excepciones

ArgumentNullException

blocklistName es null.

ArgumentException

blocklistName es una cadena vacía y se esperaba que no estuviera vacía.

RequestFailedException

El servicio devolvió un código de estado no correcto.

Ejemplos

En este ejemplo se muestra cómo llamar a GetTextBlocklistItemsAsync con los parámetros necesarios y analizar el resultado.

var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ContentSafetyClient(endpoint, credential);

await foreach (var item in client.GetTextBlocklistItemsAsync("<blocklistName>", 1234, 1234, 1234, new RequestContext()))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("blockItemId").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("text").ToString());
}