292 строки
29 KiB
YAML
292 строки
29 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.contentsafety.BlocklistClient"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient"
|
|
name: "BlocklistClient"
|
|
nameWithType: "BlocklistClient"
|
|
summary: "Initializes a new instance of the synchronous Blocklist<wbr>Client type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **BlocklistClient**"
|
|
methods:
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.addOrUpdateBlocklistItems(java.lang.String,com.azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.addOrUpdateBlocklistItems(String name, AddOrUpdateTextBlocklistItemsOptions options)"
|
|
name: "addOrUpdateBlocklistItems(String name, AddOrUpdateTextBlocklistItemsOptions options)"
|
|
nameWithType: "BlocklistClient.addOrUpdateBlocklistItems(String name, AddOrUpdateTextBlocklistItemsOptions options)"
|
|
summary: "Add or update Blocklist<wbr>Items To Text Blocklist Add or update blocklist<wbr>Items to a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Options for adding or updating blocklist items."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions?alt=com.azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsOptions&text=AddOrUpdateTextBlocklistItemsOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AddOrUpdateTextBlocklistItemsResult addOrUpdateBlocklistItems(String name, AddOrUpdateTextBlocklistItemsOptions options)"
|
|
desc: "Add or update BlocklistItems To Text Blocklist Add or update blocklistItems to a text blocklist. You can add or update at most 100 blocklistItems in one request."
|
|
returns:
|
|
description: "the response of adding blocklistItems to the text blocklist."
|
|
type: "<xref href=\"com.azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult?alt=com.azure.ai.contentsafety.models.AddOrUpdateTextBlocklistItemsResult&text=AddOrUpdateTextBlocklistItemsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.addOrUpdateBlocklistItemsWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.addOrUpdateBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
name: "addOrUpdateBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.addOrUpdateBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
summary: "Add or update Blocklist<wbr>Items To Text Blocklist Add or update blocklist<wbr>Items to a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Options for adding or updating blocklist items."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> addOrUpdateBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
desc: "Add or update BlocklistItems To Text Blocklist Add or update blocklistItems to a text blocklist. You can add or update at most 100 blocklistItems in one request.\n\n**Request Body Schema**\n\n```java\n{\n blocklistItems (Required): [\n (Required){\n blocklistItemId: String (Required)\n description: String (Optional)\n text: String (Required)\n }\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n blocklistItems (Required): [\n (Required){\n blocklistItemId: String (Required)\n description: String (Optional)\n text: String (Required)\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "the response of adding blocklistItems to the text blocklist along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.createOrUpdateTextBlocklistWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.createOrUpdateTextBlocklistWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
name: "createOrUpdateTextBlocklistWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.createOrUpdateTextBlocklistWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
summary: "Create Or Update Text Blocklist Updates a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The resource instance."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> createOrUpdateTextBlocklistWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
desc: "Create Or Update Text Blocklist Updates a text blocklist. If the blocklistName does not exist, a new blocklist will be created.\n\n**Request Body Schema**\n\n```java\n{\n blocklistName: String (Required)\n description: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n blocklistName: String (Required)\n description: String (Optional)\n }\n```"
|
|
returns:
|
|
description: "text Blocklist along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.deleteTextBlocklist(java.lang.String)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.deleteTextBlocklist(String name)"
|
|
name: "deleteTextBlocklist(String name)"
|
|
nameWithType: "BlocklistClient.deleteTextBlocklist(String name)"
|
|
summary: "Delete Text Blocklist By blocklist<wbr>Name Deletes a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public void deleteTextBlocklist(String name)"
|
|
desc: "Delete Text Blocklist By blocklistName Deletes a text blocklist."
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.deleteTextBlocklistWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.deleteTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
name: "deleteTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.deleteTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
summary: "Delete Text Blocklist By blocklist<wbr>Name Deletes a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
desc: "Delete Text Blocklist By blocklistName Deletes a text blocklist."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklist(java.lang.String)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklist(String name)"
|
|
name: "getTextBlocklist(String name)"
|
|
nameWithType: "BlocklistClient.getTextBlocklist(String name)"
|
|
summary: "Get Text Blocklist By blocklist<wbr>Name Returns text blocklist details."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public TextBlocklist getTextBlocklist(String name)"
|
|
desc: "Get Text Blocklist By blocklistName Returns text blocklist details."
|
|
returns:
|
|
description: "text Blocklist."
|
|
type: "<xref href=\"com.azure.ai.contentsafety.models.TextBlocklist?alt=com.azure.ai.contentsafety.models.TextBlocklist&text=TextBlocklist\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklistItem(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklistItem(String name, String blocklistItemId)"
|
|
name: "getTextBlocklistItem(String name, String blocklistItemId)"
|
|
nameWithType: "BlocklistClient.getTextBlocklistItem(String name, String blocklistItemId)"
|
|
summary: "Get Blocklist<wbr>Item By blocklist<wbr>Name And blocklist<wbr>Item<wbr>Id Get blocklist<wbr>Item by blocklist<wbr>Name and blocklist<wbr>Item<wbr>Id from a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The service will generate a BlocklistItemId, which will be a UUID."
|
|
name: "blocklistItemId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public TextBlocklistItem getTextBlocklistItem(String name, String blocklistItemId)"
|
|
desc: "Get BlocklistItem By blocklistName And blocklistItemId Get blocklistItem by blocklistName and blocklistItemId from a text blocklist."
|
|
returns:
|
|
description: "blocklistItem by blocklistName and blocklistItemId from a text blocklist."
|
|
type: "<xref href=\"com.azure.ai.contentsafety.models.TextBlocklistItem?alt=com.azure.ai.contentsafety.models.TextBlocklistItem&text=TextBlocklistItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklistItemWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklistItemWithResponse(String name, String blocklistItemId, RequestOptions requestOptions)"
|
|
name: "getTextBlocklistItemWithResponse(String name, String blocklistItemId, RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.getTextBlocklistItemWithResponse(String name, String blocklistItemId, RequestOptions requestOptions)"
|
|
summary: "Get Blocklist<wbr>Item By blocklist<wbr>Name And blocklist<wbr>Item<wbr>Id Get blocklist<wbr>Item by blocklist<wbr>Name and blocklist<wbr>Item<wbr>Id from a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The service will generate a BlocklistItemId, which will be a UUID."
|
|
name: "blocklistItemId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getTextBlocklistItemWithResponse(String name, String blocklistItemId, RequestOptions requestOptions)"
|
|
desc: "Get BlocklistItem By blocklistName And blocklistItemId Get blocklistItem by blocklistName and blocklistItemId from a text blocklist.\n\n**Response Body Schema**\n\n```java\n{\n blocklistItemId: String (Required)\n description: String (Optional)\n text: String (Required)\n }\n```"
|
|
returns:
|
|
description: "blocklistItem by blocklistName and blocklistItemId from a text blocklist along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklistWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.getTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
name: "getTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.getTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
summary: "Get Text Blocklist By blocklist<wbr>Name Returns text blocklist details."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getTextBlocklistWithResponse(String name, RequestOptions requestOptions)"
|
|
desc: "Get Text Blocklist By blocklistName Returns text blocklist details.\n\n**Response Body Schema**\n\n```java\n{\n blocklistName: String (Required)\n description: String (Optional)\n }\n```"
|
|
returns:
|
|
description: "text Blocklist along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklistItems(java.lang.String)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklistItems(String name)"
|
|
name: "listTextBlocklistItems(String name)"
|
|
nameWithType: "BlocklistClient.listTextBlocklistItems(String name)"
|
|
summary: "Get All Blocklist<wbr>Items By blocklist<wbr>Name Get all blocklist<wbr>Items in a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PagedIterable<TextBlocklistItem> listTextBlocklistItems(String name)"
|
|
desc: "Get All BlocklistItems By blocklistName Get all blocklistItems in a text blocklist."
|
|
returns:
|
|
description: "all blocklistItems in a text blocklist as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.contentsafety.models.TextBlocklistItem?alt=com.azure.ai.contentsafety.models.TextBlocklistItem&text=TextBlocklistItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklistItems(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklistItems(String name, RequestOptions requestOptions)"
|
|
name: "listTextBlocklistItems(String name, RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.listTextBlocklistItems(String name, RequestOptions requestOptions)"
|
|
summary: "Get All Blocklist<wbr>Items By blocklist<wbr>Name Get all blocklist<wbr>Items in a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedIterable<BinaryData> listTextBlocklistItems(String name, RequestOptions requestOptions)"
|
|
desc: "Get All BlocklistItems By blocklistName Get all blocklistItems in a text blocklist.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | -------------------------------------------- |\n | Name | Type | Required | Description |\n | top | Integer | No | The number of result items to return. |\n | skip | Integer | No | The number of result items to skip. |\n | maxpagesize | Integer | No | The maximum number of result items per page. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n{\n blocklistItemId: String (Required)\n description: String (Optional)\n text: String (Required)\n }\n```"
|
|
returns:
|
|
description: "all blocklistItems in a text blocklist as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklistItems(java.lang.String,java.lang.Integer,java.lang.Integer)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklistItems(String name, Integer top, Integer skip)"
|
|
name: "listTextBlocklistItems(String name, Integer top, Integer skip)"
|
|
nameWithType: "BlocklistClient.listTextBlocklistItems(String name, Integer top, Integer skip)"
|
|
summary: "Get All Blocklist<wbr>Items By blocklist<wbr>Name Get all blocklist<wbr>Items in a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The number of result items to return."
|
|
name: "top"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The number of result items to skip."
|
|
name: "skip"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public PagedIterable<TextBlocklistItem> listTextBlocklistItems(String name, Integer top, Integer skip)"
|
|
desc: "Get All BlocklistItems By blocklistName Get all blocklistItems in a text blocklist."
|
|
returns:
|
|
description: "all blocklistItems in a text blocklist as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.contentsafety.models.TextBlocklistItem?alt=com.azure.ai.contentsafety.models.TextBlocklistItem&text=TextBlocklistItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklists()"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklists()"
|
|
name: "listTextBlocklists()"
|
|
nameWithType: "BlocklistClient.listTextBlocklists()"
|
|
summary: "Get All Text Blocklists Get all text blocklists details."
|
|
syntax: "public PagedIterable<TextBlocklist> listTextBlocklists()"
|
|
desc: "Get All Text Blocklists Get all text blocklists details."
|
|
returns:
|
|
description: "all text blocklists details as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.contentsafety.models.TextBlocklist?alt=com.azure.ai.contentsafety.models.TextBlocklist&text=TextBlocklist\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklists(com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.listTextBlocklists(RequestOptions requestOptions)"
|
|
name: "listTextBlocklists(RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.listTextBlocklists(RequestOptions requestOptions)"
|
|
summary: "Get All Text Blocklists Get all text blocklists details."
|
|
parameters:
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedIterable<BinaryData> listTextBlocklists(RequestOptions requestOptions)"
|
|
desc: "Get All Text Blocklists Get all text blocklists details.\n\n**Response Body Schema**\n\n```java\n{\n blocklistName: String (Required)\n description: String (Optional)\n }\n```"
|
|
returns:
|
|
description: "all text blocklists details as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.removeBlocklistItems(java.lang.String,com.azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.removeBlocklistItems(String name, RemoveTextBlocklistItemsOptions options)"
|
|
name: "removeBlocklistItems(String name, RemoveTextBlocklistItemsOptions options)"
|
|
nameWithType: "BlocklistClient.removeBlocklistItems(String name, RemoveTextBlocklistItemsOptions options)"
|
|
summary: "Remove Blocklist<wbr>Items From Text Blocklist Remove blocklist<wbr>Items from a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Options for removing blocklist items."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions?alt=com.azure.ai.contentsafety.models.RemoveTextBlocklistItemsOptions&text=RemoveTextBlocklistItemsOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void removeBlocklistItems(String name, RemoveTextBlocklistItemsOptions options)"
|
|
desc: "Remove BlocklistItems From Text Blocklist Remove blocklistItems from a text blocklist. You can remove at most 100 BlocklistItems in one request."
|
|
- uid: "com.azure.ai.contentsafety.BlocklistClient.removeBlocklistItemsWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.ai.contentsafety.BlocklistClient.removeBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
name: "removeBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
nameWithType: "BlocklistClient.removeBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
summary: "Remove Blocklist<wbr>Items From Text Blocklist Remove blocklist<wbr>Items from a text blocklist."
|
|
parameters:
|
|
- description: "Text blocklist name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Options for removing blocklist items."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> removeBlocklistItemsWithResponse(String name, BinaryData options, RequestOptions requestOptions)"
|
|
desc: "Remove BlocklistItems From Text Blocklist Remove blocklistItems from a text blocklist. You can remove at most 100 BlocklistItems in one request.\n\n**Request Body Schema**\n\n```java\n{\n blocklistItemIds (Required): [\n String (Required)\n ]\n }\n```"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the synchronous BlocklistClient type."
|
|
metadata: {}
|
|
package: "com.azure.ai.contentsafety"
|
|
artifact: com.azure:azure-ai-contentsafety:1.0.6
|