Rai Blocklists - List

サービス:

Azure AI Services

API バージョン:

2024-04-01-preview

Azure OpenAI アカウントに関連付けられているカスタム ブロックリストを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiBlocklists?api-version=2024-04-01-preview

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Cognitive Services アカウントの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	RaiBlockListResult	ブロックリストを正常に取得しました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

ListBlocklists

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists?api-version=2024-04-01-preview

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "name": "raiBlocklistName",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/raiBlocklists/raiBlocklistName",
      "properties": {
        "description": "This is a sample blocklist"
      }
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
RaiBlocklist	Cognitive Services RaiBlocklist。
RaiBlocklistProperties	RAI カスタム ブロックリスト プロパティ。
RaiBlockListResult	コグニティブ サービス RAI ブロックリストの一覧。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

RaiBlocklist

Object

Cognitive Services RaiBlocklist。

名前	型	説明
etag	string	リソース Etag。
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	RaiBlocklistProperties	Cognitive Services RaiBlocklist のプロパティ。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

RaiBlocklistProperties

Object

RAI カスタム ブロックリスト プロパティ。

名前	型	説明
description	string	ブロック リストの説明。

RaiBlockListResult

Object

コグニティブ サービス RAI ブロックリストの一覧。

名前	型	説明
nextLink	string	RaiBlocklists の次のページを取得するために使用されるリンク。
value	RaiBlocklist[]	RaiBlocklist の一覧。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。