Question Answering Projects - List Projects

サービス:

Azure AI Services

API バージョン:

2021-10-01

ユーザーのすべてのプロジェクトを取得します。

GET {Endpoint}/language/query-knowledgebases/projects?api-version=2021-10-01

省略可能なパラメーターを含む:

GET {Endpoint}/language/query-knowledgebases/projects?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

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)	コレクションから返されるリソースの最大数。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

応答

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

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Successful query

要求のサンプル

HTTP

GET {Endpoint}/language/query-knowledgebases/projects?api-version=2021-10-01

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "projectName": "proj1",
      "description": "proj1 is a test project.",
      "language": "en",
      "multilingualResource": true,
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    },
    {
      "projectName": "proj2",
      "description": "proj2 is a test project.",
      "language": "fr",
      "multilingualResource": true,
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    }
  ]
}

定義

名前	説明
Error	エラー オブジェクト。
ErrorCode	人間が判読できるエラー コード。
ErrorResponse	エラー応答。
InnerErrorCode	人間が判読できるエラー コード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectMetadata	プロジェクトを表します。
ProjectSettings	プロジェクトの構成可能な設定。
ProjectsMetadata	プロジェクトメタデータとグローバル設定のコレクション。

Error

Object

エラー オブジェクト。

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

ErrorCode

列挙

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

値	説明
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

エラー応答。

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

InnerErrorCode

列挙

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

値	説明
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

エラーに関するより具体的な情報を含むオブジェクト。 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	エラーターゲット。

ProjectMetadata

Object

プロジェクトを表します。

名前	型	説明
createdDateTime	string (date-time)	プロジェクトの作成日時。
description	string	プロジェクトの説明。
language	string	テキスト レコードの言語。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en" を使用します。スペイン語などの "es"設定しない場合は、既定で英語に "en" を使用します。
lastDeployedDateTime	string (date-time)	プロジェクトの最後の配置日時を表します。
lastModifiedDateTime	string (date-time)	プロジェクトの最終変更日時を表します。
multilingualResource	boolean	プロジェクト間で複数の言語に対して有効になっているリソース。
projectName	string	プロジェクトの名前。
settings	ProjectSettings	プロジェクトの構成可能な設定。

ProjectSettings

Object

プロジェクトの構成可能な設定。

名前	型	説明
defaultAnswer	string	ナレッジ ベースに適切な一致が見つからない場合の既定の回答応答。

ProjectsMetadata

Object

プロジェクトメタデータとグローバル設定のコレクション。

名前	型	説明
nextLink	string
value	ProjectMetadata[]	プロジェクトを表します。