Text Analysis Authoring - Import

Başvuru

Hizmet:: Azure AI Services

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

Projeyi içeri aktarmak için bir işi tetikler. Aynı ada sahip bir proje zaten varsa, o projenin verileri değiştirilir.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?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	Kullanılacak projenin adı.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
metadata	True	CreateProjectOptions	Proje meta verilerini temsil eder.
projectFileVersion	True	string	Dışarı aktarılan dosyanın sürümü.
stringIndexType	True	StringIndexType	Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz. https://aka.ms/text-analytics-offsets.
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Proje varlıklarını temsil eder.

Yanıtlar

Name	Tür	Description
202 Accepted		İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı. Üst Bilgiler Operation-Location: string
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Name

Tür

Description

202 Accepted

İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı.

Üst Bilgiler

Operation-Location: string

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

SuccessfulImportProject

Örnek isteği

HTTP

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

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "CustomEntityRecognition",
    "storageInputContainerName": "loanagreements",
    "settings": {},
    "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"
  },
  "assets": {
    "projectKind": "CustomEntityRecognition",
    "entities": [
      {
        "category": "Date"
      },
      {
        "category": "LenderName"
      },
      {
        "category": "LenderAddress"
      }
    ],
    "documents": [
      {
        "location": "01.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1793,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              }
            ]
          }
        ]
      },
      {
        "location": "02.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1804,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 10
              },
              {
                "category": "LenderName",
                "offset": 284,
                "length": 10
              },
              {
                "category": "LenderAddress",
                "offset": 321,
                "length": 20
              }
            ]
          }
        ]
      }
    ]
  }
}

Örnek yanıt

Durum kodu:: 202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

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ı.
ExportedProject	Dışarı aktarılan bir projeyi temsil eder.
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.
StringIndexType
TextAnalysisAuthoringExportedClass	Dışarı aktarılan bir projenin sınıfını temsil eder.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Özel varlık tanıma projesi için dışarı aktarılan bir belgeyi temsil eder.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Varlık tanıma projesi için dışarı aktarılan varlıkları temsil eder.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Özel bir çok etiketli sınıflandırma projesinin dışarı aktarılan belgesini temsil eder.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Özel çok etiketli sınıflandırma projesi için dışarı aktarılan varlıkları temsil eder.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Özel tek etiketli sınıflandırma projesi için dışarı aktarılan bir belgeyi temsil eder.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Tek etiketli sınıflandırma projesi için dışarı aktarılan varlıkları temsil eder.
TextAnalysisAuthoringExportedDocumentClass	Belgenin sınıflandırma etiketini temsil eder.
TextAnalysisAuthoringExportedDocumentEntityLabel	Belgenin varlık etiketini temsil eder.
TextAnalysisAuthoringExportedDocumentEntityRegion	Varlık etiketlemesi için belgedeki bir bölgeyi temsil eder.
TextAnalysisAuthoringExportedEntity	Dışarı aktarılan projedeki bir varlığı 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.

ExportedProject

Dışarı aktarılan bir projeyi temsil eder.

Name	Tür	Description
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Proje varlıklarını temsil eder.
metadata	CreateProjectOptions	Proje meta verilerini temsil eder.
projectFileVersion	string	Dışarı aktarılan dosyanın sürümü.
stringIndexType	StringIndexType	Dize uzaklıklarını yorumlamak için kullanılan yöntemi belirtir. Ek bilgi için bkz. https://aka.ms/text-analytics-offsets.

InnerErrorCode

İnsan tarafından okunabilen hata kodu.

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

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.

Name	Tür	Description
code	InnerErrorCode	Sunucu tanımlı hata kodları kümesinden biri.
details	object	Hata ayrıntıları.
innererror	InnerErrorModel	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hata mesajı.
target	string	Hata hedefi.

ProjectKind

Name	Tür	Description
CustomEntityRecognition	string	Kendi verilerinizi kullanarak etki alanı kategorilerinizi tanımlamak üzere bir ayıklama modeli oluşturmak için.
CustomMultiLabelClassification	string	Kendi verilerinizi kullanarak metni sınıflandırmak için sınıflandırma modeli oluşturmak için. Her dosyada bir veya birden çok etiket olabilir. Örneğin, 1 dosyası A, B ve C, 2 dosyası ise B ve C olarak sınıflandırılır.
CustomSingleLabelClassification	string	Kendi verilerinizi kullanarak metni sınıflandırmak için sınıflandırma modeli oluşturmak için. Her dosyada yalnızca bir etiket bulunur. Örneğin, dosya 1 A olarak sınıflandırılır ve 2 dosyası B olarak sınıflandırılır.

ProjectSettings

Proje davranışını tanımlamak için kullanılan ayarları temsil eder.

Name	Tür	Description
confidenceThreshold	number	Tahminin otomatik olarak "Hiçbiri" olarak değiştirileceği en yüksek güvene sahip sınıfın eşiği. Eşiğin değeri 0 ile 1 (dahil) arasında olmalıdır.

StringIndexType

Name	Tür	Description
Utf16CodeUnit	string	Uzaklık ve uzunluk değerleri UTF-16 kod birimlerine karşılık gelir. Uygulamanız Java, JavaScript gibi Unicode'u destekleyen bir dilde yazılmışsa bu seçeneği kullanın.

TextAnalysisAuthoringExportedClass

Dışarı aktarılan bir projenin sınıfını temsil eder.

Name	Tür	Description
category	string	Sınıf kategorisi.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Özel varlık tanıma projesi için dışarı aktarılan bir belgeyi temsil eder.

Name	Tür	Description
dataset	string	Bu belgenin veri kümesi. İzin verilen değerler 'Eğit' ve 'Test' değerleridir.
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	Belgeye ait varlık etiketlerinin listesi.
language	string	Belge dilini temsil eder. 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.
location	string	Belgenin depolamadaki konumu.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Varlık tanıma projesi için dışarı aktarılan varlıkları temsil eder.

Name	Tür	Description
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Projeye ait belgelerin listesi.
entities	TextAnalysisAuthoringExportedEntity[]	Projeye ait varlıkların listesi.
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Özel bir çok etiketli sınıflandırma projesinin dışarı aktarılan belgesini temsil eder.

Name	Tür	Description
classes	TextAnalysisAuthoringExportedDocumentClass[]	Belge sınıfları.
dataset	string	Bu belgenin veri kümesi. İzin verilen değerler 'Eğit' ve 'Test' değerleridir.
language	string	Belge dilini temsil eder. 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.
location	string	Belgenin depolamadaki konumu.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Özel çok etiketli sınıflandırma projesi için dışarı aktarılan varlıkları temsil eder.

Name	Tür	Description
classes	TextAnalysisAuthoringExportedClass[]	Projedeki sınıfların listesi.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Projedeki belgelerin listesi.
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Özel tek etiketli sınıflandırma projesi için dışarı aktarılan bir belgeyi temsil eder.

Name	Tür	Description
class	TextAnalysisAuthoringExportedDocumentClass	Belgelerin sınıfı.
dataset	string	Bu belgenin veri kümesi. İzin verilen değerler 'Eğit' ve 'Test' değerleridir.
language	string	Belge dilini temsil eder. 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.
location	string	Belgenin depolamadaki konumu.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Tek etiketli sınıflandırma projesi için dışarı aktarılan varlıkları temsil eder.

Name	Tür	Description
classes	TextAnalysisAuthoringExportedClass[]	Bu projeye ait sınıfların listesi.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Bu projeye ait belgelerin listesi.
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Belgenin sınıflandırma etiketini temsil eder.

Name	Tür	Description
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Belgenin varlık etiketini temsil eder.

Name	Tür	Description
category	string	Varlık kategorisi.
length	integer	Varlık metninin uzunluğu.
offset	integer	Varlık metni için başlangıç konumu.

TextAnalysisAuthoringExportedDocumentEntityRegion

Varlık etiketlemesi için belgedeki bir bölgeyi temsil eder.

Name	Tür	Description
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Bu bölgeye ait varlık etiketlerinin listesi.
regionLength	integer	Bölge metninin uzunluğu.
regionOffset	integer	Bölge için başlangıç konumu.

TextAnalysisAuthoringExportedEntity

Dışarı aktarılan projedeki bir varlığı temsil eder.

Name	Tür	Description
category	string	Varlık kategorisi.

Aracılığıyla paylaş

Text Analysis Authoring - Import

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

Ocp-Apim-Subscription-Key

OAuth2Auth

Kapsamlar

Örnekler

SuccessfulImportProject

Örnek isteği

Örnek yanıt

Tanımlar

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Ek kaynaklar