Text Analysis Authoring - Create Project

Başvuru

Hizmet:: Azure AI Services

API Sürümü:: 2023-04-01

Bir kaynağa uygulanan en temel işlem.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
Endpoint	path	True	string url	Desteklenen Bilişsel Hizmetler uç noktası (örneğin, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Yeni proje adı.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Media Types: "application/merge-patch+json"

Name	Gerekli	Tür	Description
language	True	string	Proje dili. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (UK) için "en-gb" , İspanyolca için "es" vb. kullanın.
projectKind	True	ProjectKind	Proje türü.
projectName	True	string	Yeni proje adı.
storageInputContainerName	True	string	Depolama kapsayıcısı adı.
description		string	Proje açıklaması.
multilingual		boolean	Projenin birden çok dil için kullanılıp kullanılmayacağı.
settings		ProjectSettings	Proje ayarları.

Yanıtlar

Name	Tür	Description
200 OK	TextAnalysisAuthoringProjectMetadata	İstek başarılı oldu.
201 Created	TextAnalysisAuthoringProjectMetadata	İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

Ocp-Apim-Subscription-Key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

Name	Description
https://cognitiveservices.azure.com/.default

Örnekler

Successful Create Project

Örnek isteği

HTTP

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

{
  "projectName": "LoanAgreements",
  "language": "en",
  "projectKind": "CustomEntityRecognition",
  "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.",
  "multilingual": false,
  "storageInputContainerName": "loanagreements"
}

Örnek yanıt

Durum kodu:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "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"
}

Durum kodu:: 200

{
  "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"
}

Tanımlar

Name	Description
CreateProjectOptions	Proje oluşturmak veya güncelleştirmek için kullanılan seçenekleri temsil eder.
Error	Hata nesnesi.
ErrorCode	İnsan tarafından okunabilen hata kodu.
ErrorResponse	Hata yanıtı.
InnerErrorCode	İnsan tarafından okunabilen hata kodu.
InnerErrorModel	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	Proje davranışını tanımlamak için kullanılan ayarları temsil eder.
TextAnalysisAuthoringProjectMetadata	Projenin meta verilerini temsil eder.

CreateProjectOptions

Proje oluşturmak veya güncelleştirmek için kullanılan seçenekleri temsil eder.

Name	Tür	Description
description	string	Proje açıklaması.
language	string	Proje dili. Bu, bir dilin BCP-47 gösterimidir. Örneğin, İngilizce için "en", İngilizce (UK) için "en-gb" , İspanyolca için "es" vb. kullanın.
multilingual	boolean	Projenin birden çok dil için kullanılıp kullanılmayacağı.
projectKind	ProjectKind	Proje türü.
projectName	string	Yeni proje adı.
settings	ProjectSettings	Proje ayarları.
storageInputContainerName	string	Depolama kapsayıcısı adı.

Error

Hata nesnesi.

Name	Tür	Description
code	ErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

ErrorCode

İnsan tarafından okunabilen hata kodu.

Name	Tür	Description
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

Hata yanıtı.

Name	Tür	Description
error	Error	Hata nesnesi.

InnerErrorCode