Text Analysis Authoring - Import

Referensi

Layanan:: Azure AI Services

Versi API:: 2023-04-01

Memicu pekerjaan untuk mengimpor proyek. Jika proyek dengan nama yang sama sudah ada, data proyek tersebut akan diganti.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string url	Titik akhir Cognitive Services yang didukung (misalnya, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nama proyek yang akan digunakan.
api-version	query	True	string	Versi API yang akan digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
metadata	True	CreateProjectOptions	Mewakili metadata proyek.
projectFileVersion	True	string	Versi file yang diekspor.
stringIndexType	True	StringIndexType	Menentukan metode yang digunakan untuk menginterpretasikan offset string. Untuk informasi tambahan, lihat https://aka.ms/text-analytics-offsets.
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Mewakili aset proyek.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai. Header Operation-Location: string
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Nama

Jenis

Deskripsi

202 Accepted

Permintaan telah diterima untuk diproses, tetapi pemrosesan belum selesai.

Header

Operation-Location: string

Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

SuccessfulImportProject

Permintaan sampel

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
              }
            ]
          }
        ]
      }
    ]
  }
}

Respon sampel

Kode status:: 202

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

Definisi

Nama	Deskripsi
CreateProjectOptions	Mewakili opsi yang digunakan untuk membuat atau memperbarui proyek.
Error	Objek kesalahan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
ExportedProject	Mewakili proyek yang diekspor.
InnerErrorCode	Kode kesalahan yang dapat dibaca manusia.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	Mewakili pengaturan yang digunakan untuk menentukan perilaku proyek.
StringIndexType
TextAnalysisAuthoringExportedClass	Mewakili kelas proyek yang diekspor.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Mewakili dokumen yang diekspor untuk proyek pengenalan entitas kustom.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Mewakili aset yang diekspor untuk proyek pengenalan entitas.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Mewakili dokumen yang diekspor dari proyek klasifikasi multi-label kustom.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Mewakili aset yang diekspor untuk proyek klasifikasi multi-label kustom.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Mewakili dokumen yang diekspor untuk proyek klasifikasi label tunggal kustom.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Mewakili aset yang diekspor untuk proyek klasifikasi label tunggal.
TextAnalysisAuthoringExportedDocumentClass	Mewakili label klasifikasi untuk dokumen.
TextAnalysisAuthoringExportedDocumentEntityLabel	Mewakili label entitas untuk dokumen.
TextAnalysisAuthoringExportedDocumentEntityRegion	Mewakili wilayah dalam dokumen untuk pelabelan entitas.
TextAnalysisAuthoringExportedEntity	Mewakili entitas dalam proyek yang diekspor.

CreateProjectOptions

Mewakili opsi yang digunakan untuk membuat atau memperbarui proyek.

Nama	Jenis	Deskripsi
description	string	Deskripsi proyek.
language	string	Bahasa proyek. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll.
multilingual	boolean	Apakah proyek akan digunakan untuk beberapa bahasa atau tidak.
projectKind	ProjectKind	Jenis proyek.
projectName	string	Nama proyek baru.
settings	ProjectSettings	Pengaturan proyek.
storageInputContainerName	string	Nama kontainer penyimpanan.

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
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

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

ExportedProject

Mewakili proyek yang diekspor.

Nama	Jenis	Deskripsi
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Mewakili aset proyek.
metadata	CreateProjectOptions	Mewakili metadata proyek.
projectFileVersion	string	Versi file yang diekspor.
stringIndexType	StringIndexType	Menentukan metode yang digunakan untuk menginterpretasikan offset string. Untuk informasi tambahan, lihat https://aka.ms/text-analytics-offsets.

InnerErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
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

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nama	Jenis	Deskripsi
code	InnerErrorCode	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	object	Detail kesalahan.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ProjectKind

Nama	Jenis	Deskripsi
CustomEntityRecognition	string	Untuk membangun model ekstraksi guna mengidentifikasi kategori domain Anda menggunakan data Anda sendiri.
CustomMultiLabelClassification	string	Untuk membangun model klasifikasi untuk mengklasifikasikan teks menggunakan data Anda sendiri. Setiap file dapat memiliki satu atau banyak label. Misalnya, file 1 diklasifikasikan sebagai A, B, dan C dan file 2 diklasifikasikan sebagai B dan C.
CustomSingleLabelClassification	string	Untuk membangun model klasifikasi untuk mengklasifikasikan teks menggunakan data Anda sendiri. Setiap file hanya akan memiliki satu label. Misalnya, file 1 diklasifikasikan sebagai A dan file 2 diklasifikasikan sebagai B.

ProjectSettings

Mewakili pengaturan yang digunakan untuk menentukan perilaku proyek.

Nama	Jenis	Deskripsi
confidenceThreshold	number	Ambang kelas dengan keyakinan tertinggi, di mana prediksi akan secara otomatis diubah menjadi "Tidak Ada". Nilai ambang batas harus antara 0 dan 1 inklusif.

StringIndexType

Nama	Jenis	Deskripsi
Utf16CodeUnit	string	Nilai offset dan panjang akan sesuai dengan unit kode UTF-16. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Java, JavaScript.

TextAnalysisAuthoringExportedClass

Mewakili kelas proyek yang diekspor.

Nama	Jenis	Deskripsi
category	string	Kategori kelas.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Mewakili dokumen yang diekspor untuk proyek pengenalan entitas kustom.

Nama	Jenis	Deskripsi
dataset	string	Himpunan data untuk dokumen ini. Nilai yang diizinkan adalah 'Latih' dan 'Uji'.
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	Daftar label entitas milik dokumen.
language	string	Mewakili bahasa dokumen. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll.
location	string	Lokasi dokumen dalam penyimpanan.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Mewakili aset yang diekspor untuk proyek pengenalan entitas.

Nama	Jenis	Deskripsi
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Daftar dokumen milik proyek.
entities	TextAnalysisAuthoringExportedEntity[]	Daftar entitas milik proyek.
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Mewakili dokumen yang diekspor dari proyek klasifikasi multi-label kustom.

Nama	Jenis	Deskripsi
classes	TextAnalysisAuthoringExportedDocumentClass[]	Kelas dokumen.
dataset	string	Himpunan data untuk dokumen ini. Nilai yang diizinkan adalah 'Latih' dan 'Uji'.
language	string	Mewakili bahasa dokumen. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll.
location	string	Lokasi dokumen dalam penyimpanan.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Mewakili aset yang diekspor untuk proyek klasifikasi multi-label kustom.

Nama	Jenis	Deskripsi
classes	TextAnalysisAuthoringExportedClass[]	Daftar kelas dalam proyek.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Daftar dokumen dalam proyek.
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Mewakili dokumen yang diekspor untuk proyek klasifikasi label tunggal kustom.

Nama	Jenis	Deskripsi
class	TextAnalysisAuthoringExportedDocumentClass	Kelas dokumen.
dataset	string	Himpunan data untuk dokumen ini. Nilai yang diizinkan adalah 'Latih' dan 'Uji'.
language	string	Mewakili bahasa dokumen. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris, "en-gb" untuk bahasa Inggris (Inggris), "es" untuk bahasa Spanyol dll.
location	string	Lokasi dokumen dalam penyimpanan.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Mewakili aset yang diekspor untuk proyek klasifikasi label tunggal.

Nama	Jenis	Deskripsi
classes	TextAnalysisAuthoringExportedClass[]	Daftar kelas milik proyek ini.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Daftar dokumen milik proyek ini.
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Mewakili label klasifikasi untuk dokumen.

Nama	Jenis	Deskripsi
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

Mewakili label entitas untuk dokumen.

Nama	Jenis	Deskripsi
category	string	Kategori entitas.
length	integer	Panjang untuk teks entitas.
offset	integer	Posisi mulai untuk teks entitas.

TextAnalysisAuthoringExportedDocumentEntityRegion

Mewakili wilayah dalam dokumen untuk pelabelan entitas.

Nama	Jenis	Deskripsi
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Daftar label entitas milik wilayah ini.
regionLength	integer	Panjang untuk teks wilayah.
regionOffset	integer	Posisi mulai untuk wilayah tersebut.

TextAnalysisAuthoringExportedEntity

Mewakili entitas dalam proyek yang diekspor.

Nama	Jenis	Deskripsi
category	string	Kategori entitas.

Bagikan melalui

Text Analysis Authoring - Import

Parameter URI

Isi Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

OAuth2Auth

Cakupan

Contoh

SuccessfulImportProject

Permintaan sampel

Respon sampel

Definisi

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Sumber Daya Tambahan: