Question Answering Projects - Create Project

サービス:

Azure AI Services

API バージョン:

2023-04-01

プロジェクトを作成または更新します。

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}?api-version=2023-04-01

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string (uri)	サポートされている Cognitive Services エンドポイント (https://<resource-name>.api.cognitiveservices.azure.com など)。
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	プロジェクトの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

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

応答

名前	型	説明
200 OK	QuestionAnsweringProjectMetadata	要求は成功しました。
201 Created	QuestionAnsweringProjectMetadata	要求が成功し、結果として新しいリソースが作成されました。
Other Status Codes	ErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

例

Successful query

要求のサンプル

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1?api-version=2023-04-01

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

応答のサンプル

状態コード:

200

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

状態コード:

201

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

定義

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

Error

Object

エラー オブジェクト。

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

ErrorCode

列挙

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

値	説明
InvalidRequest	要求エラーが無効です
InvalidArgument	無効な引数エラー
Unauthorized	未承認のアクセス エラー
Forbidden	許可されていないアクセス エラー
NotFound	見つからないエラー
ProjectNotFound	プロジェクトが見つかりませんエラー
OperationNotFound	操作が見つかりませんエラー
AzureCognitiveSearchNotFound	Azure Cognitive Search が見つかりませんエラー
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search インデックスが見つかりませんエラー
TooManyRequests	要求が多すぎますエラー
AzureCognitiveSearchThrottling	Azure Cognitive Search の調整エラー
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search インデックスの制限に達しましたエラー
InternalServerError	内部サーバー エラー
ServiceUnavailable	サービス利用不可エラー
Timeout	タイムアウト エラー
QuotaExceeded	クォータ超過エラー
Conflict	競合エラー
Warning	警告エラー

ErrorResponse

Object

エラー応答。

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

InnerErrorCode

列挙

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

値	説明
InvalidRequest	要求エラーが無効です
InvalidParameterValue	パラメーター値のエラーが無効です
KnowledgeBaseNotFound	ナレッジ ベースが見つかりませんエラー
AzureCognitiveSearchNotFound	Azure Cognitive Search が見つかりませんエラー
AzureCognitiveSearchThrottling	Azure Cognitive Search の調整エラー
ExtractionFailure	抽出エラー エラー
InvalidRequestBodyFormat	要求本文の形式エラーが無効です
EmptyRequest	空の要求エラー
MissingInputDocuments	入力ドキュメントが見つからないエラー
InvalidDocument	無効なドキュメント エラー
ModelVersionIncorrect	モデル のバージョンが正しくないエラー
InvalidDocumentBatch	無効なドキュメント バッチ エラー
UnsupportedLanguageCode	サポートされていない言語コード エラー
InvalidCountryHint	無効な国ヒント エラー

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

ProjectSettings

Object

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

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

QuestionAnsweringProjectMetadata

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 maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	プロジェクトの名前。
settings	ProjectSettings	プロジェクトの構成可能な設定。

QuestionAnsweringProjectMetadataCreateOrUpdate

Object

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

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