Text Analysis Authoring - List Trained Models

リファレンス

Service:: Cognitive Services - Language

API Version:: 2023-04-01

プロジェクトに属するトレーニング済みモデルをListsします。

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

With optional parameters:

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

URI パラメーター

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

応答

名前	型	説明
200 OK	TextAnalysisAuthoringProjectTrainedModels	すべてのトレーニング済みモデルの一覧。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

AADToken

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

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の 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 Models

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "label": "model1",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49Z",
      "lastTrainingDurationInSeconds": 186,
      "modelExpirationDate": "2022-10-28",
      "modelTrainingConfigVersion": "2022-05-01",
      "hasSnapshot": true
    },
    {
      "label": "model2",
      "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99",
      "lastTrainedDateTime": "2022-04-18T17:25:22Z",
      "lastTrainingDurationInSeconds": 192,
      "modelExpirationDate": "2022-10-28",
      "modelTrainingConfigVersion": "2022-05-01",
      "hasSnapshot": true
    }
  ],
  "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。
TextAnalysisAuthoringProjectTrainedModel	トレーニング済みモデルを表します。
TextAnalysisAuthoringProjectTrainedModels	取得したトレーニング済みモデルの一覧を表します。

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	エラーターゲット。

TextAnalysisAuthoringProjectTrainedModel

トレーニング済みモデルを表します。

名前	型	説明
hasSnapshot	boolean	トレーニング済みモデルにスナップショット準備ができているかどうかを示すフラグ。
label	string	トレーニング済みのモデルラベル。
lastTrainedDateTime	string	モデルの最後のトレーニング日時。
lastTrainingDurationInSeconds	integer	モデルの最後のトレーニング要求の期間 (秒単位)。
modelExpirationDate	string	モデルの有効期限。
modelId	string	モデル ID。
modelTrainingConfigVersion	string	モデルトレーニング構成バージョン。

TextAnalysisAuthoringProjectTrainedModels

取得したトレーニング済みモデルの一覧を表します。

名前	型	説明
nextLink	string	次のページリンク。
value	TextAnalysisAuthoringProjectTrainedModel[]	取得されたジョブの一覧。

次の方法で共有