Text Analysis Authoring - List Projects

リファレンス

Service:: Cognitive Services - Language

API Version:: 2023-04-01

既存のプロジェクトをListsします。

GET {Endpoint}/language/authoring/analyze-text/projects?api-version=2023-04-01

With optional parameters:

GET {Endpoint}/language/authoring/analyze-text/projects?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
api-version	query	True	string	クライアント API バージョン。
maxpagesize	query		integer int32	1 つの応答に含めるリソースの最大数。
skip	query		integer int32	返される最初のリソースのコレクションへのオフセット。
top	query		integer int32	コレクションから返されるリソースの最大数。

応答

名前	型	説明
200 OK	TextAnalysisAuthoringProjectsMetadata	プロジェクトのメタデータ。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権 Azure Mapsを付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

Authorization URLは、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、一意の承認 URL と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

言語サービスリソースのサブスクリプションキー。

Type: apiKey
In: header

例

Successful List Projects

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "createdDateTime": "2022-04-18T13:53:03Z",
      "lastModifiedDateTime": "2022-04-18T13:53:03Z",
      "lastTrainedDateTime": "2022-04-18T14:14:28Z",
      "lastDeployedDateTime": "2022-04-18T14:49:01Z",
      "projectKind": "CustomEntityRecognition",
      "storageInputContainerName": "loanagreements",
      "projectName": "LoanAgreements",
      "multilingual": false,
      "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
      "language": "en"
    },
    {
      "createdDateTime": "2022-04-18T14:03:12Z",
      "lastModifiedDateTime": "2022-04-18T14:03:12Z",
      "projectKind": "CustomMultiLabelClassification",
      "storageInputContainerName": "loanagreements",
      "projectName": "MoviesSummary",
      "multilingual": false,
      "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".",
      "language": "en"
    }
  ],
  "nextLink": null
}

定義

名前	説明
Error	error オブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind	プロジェクトの種類。
TextAnalysisAuthoringProjectMetadata	プロジェクトのメタデータを表します。
TextAnalysisAuthoringProjectSettings	プロジェクトの動作を定義するために使用される設定を表します。
TextAnalysisAuthoringProjectsMetadata	取得したプロジェクトのメタデータの一覧を表します。

Error

error オブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義のエラーコードのセットの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorCode

人間が判読できるエラーコード。

名前	型	説明
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

エラー応答。

名前	型	説明
error	Error	error オブジェクト。

InnerErrorCode

人間が判読できるエラーコード。

名前	型	説明
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名前	型	説明
code	InnerErrorCode	サーバー定義のエラーコードのセットの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ProjectKind

プロジェクトの種類。

名前	型	説明
CustomEntityRecognition	string	独自のデータを使用してドメインカテゴリを識別する抽出モデルを構築する場合。
CustomMultiLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルには、1 つまたは複数のラベルを含めることができます。たとえば、ファイル 1 は A、B、C に分類され、ファイル 2 は B と C に分類されます。
CustomSingleLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルのラベルは 1 つだけです。たとえば、ファイル 1 は A として分類され、ファイル 2 は B として分類されます。

TextAnalysisAuthoringProjectMetadata

プロジェクトのメタデータを表します。

名前	型	説明
createdDateTime	string	プロジェクトの作成日時を表します。
description	string	プロジェクトの説明。
language	string	プロジェクト言語。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
lastDeployedDateTime	string	プロジェクトの最後のデプロイ日時を表します。
lastModifiedDateTime	string	プロジェクトの最終変更日時を表します。
lastTrainedDateTime	string	プロジェクトの最後のトレーニング日時を表します。
multilingual	boolean	プロジェクトを複数の言語に使用するかどうか。
projectKind	ProjectKind	プロジェクトの種類。
projectName	string	新しいプロジェクト名。
settings	TextAnalysisAuthoringProjectSettings	プロジェクトの設定。
storageInputContainerName	string	ストレージコンテナー名。

TextAnalysisAuthoringProjectSettings

プロジェクトの動作を定義するために使用される設定を表します。

名前	型	説明
confidenceThreshold	number	予測が自動的に "なし" に変更される、信頼度が最も高いクラスのしきい値。しきい値の値は、0 から 1 までの範囲である必要があります。

TextAnalysisAuthoringProjectsMetadata

取得したプロジェクトのメタデータの一覧を表します。

名前	型	説明
nextLink	string	次のページリンク。
value	TextAnalysisAuthoringProjectMetadata[]	プロジェクトの一覧。

Share via