Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

Meminta analisis teks atas kumpulan dokumen.

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

With optional parameters:

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
showStats	query		boolean	(Opsional) jika diatur ke true, respons akan berisi statistik tingkat permintaan dan dokumen.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Isi Permintaan

Isi permintaan dapat berupa salah satu hal berikut:

Nama	Deskripsi
AnalyzeTextEntityLinkingInput	Berisi teks analisis input penautan Entitas.
AnalyzeTextEntityRecognitionInput	Pengenalan entitas menganalisis permintaan tugas input teks.
AnalyzeTextKeyPhraseExtractionInput	Berisi teks analisis input tugas KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Berisi input tugas analisis dokumen deteksi bahasa.
AnalyzeTextPiiEntitiesRecognitionInput	Berisi teks analisis input tugas PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Berisi teks analisis input tugas SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Berisi teks analisis input penautan Entitas.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: EntityLinking	Jenis tugas yang harus dilakukan.
analysisInput		MultiLanguageAnalysisInput	Berisi input analisis yang akan ditangani oleh layanan.
parameters		EntityLinkingTaskParameters	Parameter tugas.

AnalyzeTextEntityRecognitionInput

Pengenalan entitas menganalisis permintaan tugas input teks.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: EntityRecognition	Jenis tugas yang harus dilakukan.
analysisInput		MultiLanguageAnalysisInput	Input yang akan dianalisis.
parameters		EntitiesTaskParameters	Parameter tugas.

AnalyzeTextKeyPhraseExtractionInput

Berisi teks analisis input tugas KeyPhraseExtraction.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: KeyPhraseExtraction	Jenis tugas yang harus dilakukan.
analysisInput		MultiLanguageAnalysisInput	Berisi dokumen input.
parameters		KeyPhraseTaskParameters	Parameter tugas ekstraksi frasa kunci.

AnalyzeTextLanguageDetectionInput

Berisi input tugas analisis dokumen deteksi bahasa.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: LanguageDetection	Jenis tugas yang harus dilakukan.
analysisInput		LanguageDetectionAnalysisInput	Dokumen yang akan dianalisis.
parameters		LanguageDetectionTaskParameters	parameter tugas.

AnalyzeTextPiiEntitiesRecognitionInput

Berisi teks analisis input tugas PIIEntityRecognition.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: PiiEntityRecognition	Jenis tugas yang harus dilakukan.
analysisInput		MultiLanguageAnalysisInput	Berisi dokumen input.
parameters		PiiTaskParameters	Parameter tugas Pii.

AnalyzeTextSentimentAnalysisInput

Berisi teks analisis input tugas SentimentAnalysis.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: SentimentAnalysis	Jenis tugas yang harus dilakukan.
analysisInput		MultiLanguageAnalysisInput	Berisi dokumen input.
parameters		SentimentAnalysisTaskParameters	Parameter tugas Analisis Sentimen.

Respons

Nama	Jenis	Deskripsi
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak terduga. Headers x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Contoh

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

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


{
  "kind": "EntityLinking",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "EntityLinkingResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Bill Gates",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.52,
                "length": 10,
                "offset": 25,
                "text": "Bill Gates"
              }
            ],
            "name": "Bill Gates",
            "url": "https://en.wikipedia.org/wiki/Bill_Gates"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Paul Allen",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.54,
                "length": 10,
                "offset": 40,
                "text": "Paul Allen"
              }
            ],
            "name": "Paul Allen",
            "url": "https://en.wikipedia.org/wiki/Paul_Allen"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Microsoft",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.49,
                "length": 9,
                "offset": 0,
                "text": "Microsoft"
              }
            ],
            "name": "Microsoft",
            "url": "https://en.wikipedia.org/wiki/Microsoft"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Pike Place Market",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.86,
                "length": 17,
                "offset": 0,
                "text": "Pike place market"
              }
            ],
            "name": "Pike Place Market",
            "url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Seattle",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.27,
                "length": 7,
                "offset": 33,
                "text": "Seattle"
              }
            ],
            "name": "Seattle",
            "url": "https://en.wikipedia.org/wiki/Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-02-01"
  }
}

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

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


{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "category": "Organization",
            "confidenceScore": 0.84,
            "length": 9,
            "offset": 0,
            "text": "Microsoft"
          },
          {
            "category": "Person",
            "confidenceScore": 0.85,
            "length": 10,
            "offset": 25,
            "text": "Bill Gates"
          },
          {
            "category": "Person",
            "confidenceScore": 0.9,
            "length": 10,
            "offset": 40,
            "text": "Paul Allen"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "category": "Location",
            "confidenceScore": 0.55,
            "length": 7,
            "offset": 33,
            "subcategory": "GPE",
            "text": "Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-04-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

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


{
  "kind": "KeyPhraseExtraction",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Text Analytics is one of the Azure Cognitive Services."
      },
      {
        "id": "3",
        "language": "en",
        "text": "My cat might need to see a veterinarian."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "KeyPhraseExtractionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "keyPhrases": [
          "Bill Gates",
          "Paul Allen",
          "Microsoft"
        ],
        "warnings": []
      },
      {
        "id": "2",
        "keyPhrases": [
          "Azure Cognitive Services",
          "Text Analytics"
        ],
        "warnings": []
      },
      {
        "id": "3",
        "keyPhrases": [
          "cat",
          "veterinarian"
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

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


{
  "kind": "LanguageDetection",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "text": "Hello world"
      },
      {
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "id": "3",
        "text": "Hola mundo"
      },
      {
        "id": "4",
        "text": "Tumhara naam kya hai?"
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "LanguageDetectionResults",
  "results": {
    "documents": [
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "en",
          "name": "English"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-05"
  }
}

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

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


{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987"
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025"
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68"
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

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


{
  "kind": "SentimentAnalysis",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "SentimentAnalysisResults",
  "results": {
    "documents": [
      {
        "confidenceScores": {
          "negative": 0,
          "neutral": 0,
          "positive": 1
        },
        "id": "1",
        "sentences": [
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "length": 10,
                "offset": 6,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/0/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "atmosphere"
              }
            ],
            "confidenceScores": {
              "negative": 0,
              "neutral": 0,
              "positive": 1
            },
            "length": 17,
            "offset": 0,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "isNegated": false,
                "length": 5,
                "offset": 0,
                "sentiment": "positive",
                "text": "great"
              }
            ],
            "sentiment": "positive",
            "text": "Great atmosphere."
          },
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 11,
                "offset": 37,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "restaurants"
              },
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 6,
                "offset": 50,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "hotels"
              }
            ],
            "confidenceScores": {
              "negative": 0.01,
              "neutral": 0.86,
              "positive": 0.13
            },
            "length": 52,
            "offset": 18,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "isNegated": false,
                "length": 15,
                "offset": 18,
                "sentiment": "positive",
                "text": "Close to plenty"
              }
            ],
            "sentiment": "neutral",
            "text": "Close to plenty of restaurants, hotels, and transit!"
          }
        ],
        "sentiment": "positive",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-10-01"
  }
}

Definisi

Nama	Deskripsi
AnalyzeTextEntityLinkingInput	Berisi teks analisis Input penautan Entitas.
AnalyzeTextEntityRecognitionInput	Pengenalan entitas menganalisis permintaan tugas input teks.
AnalyzeTextKeyPhraseExtractionInput	Berisi teks analisis input tugas KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Berisi input tugas analisis dokumen deteksi bahasa.
AnalyzeTextPiiEntitiesRecognitionInput	Berisi teks analisis input tugas PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Berisi teks analisis input tugas SentimentAnalysis.
AnalyzeTextTaskKind	Jenis tugas analisis teks yang didukung.
AnalyzeTextTaskResultsKind	Jenis objek respons yang dikembalikan oleh tugas analyze-text.
DetectedLanguage	Berisi detail bahasa yang terdeteksi untuk teks.
DocumentError	Berisi detail kesalahan yang ditemui selama eksekusi pekerjaan.
DocumentSentimentValue	Sentimen yang diprediksi untuk dokumen (Negatif, Netral, Positif, atau Campuran).
DocumentStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.
DocumentWarning	Berisi objek peringatan dengan peringatan yang ditemui untuk dokumen yang diproses.
EntitiesDocumentResult	Berisi hasil tugas pengenalan entitas untuk dokumen.
EntitiesResult	Berisi hasil tugas pengenalan entitas.
EntitiesTaskParameters	Parameter yang didukung untuk tugas Pengenalan Entitas.
EntitiesTaskResult	Berisi tugas entitas
Entity	Menentukan objek entitas yang terdeteksi yang berisi kategori entitas dan teks entitas yang terdeteksi, dll.
EntityLinkingResult	Hasil penautan entitas.
EntityLinkingTaskParameters	Parameter yang didukung untuk tugas Penautan Entitas.
EntityLinkingTaskResult	Berisi teks analisis hasil tugas penautan Entitas.
Error	Objek respons kesalahan dikembalikan ketika layanan mengalami beberapa kesalahan selama memproses permintaan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
InnerErrorCode	Kode kesalahan yang dapat dibaca manusia.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Berisi KeyPhraseResult.
KeyPhrasesDocumentResult	Berisi hasil ekstraksi Frasa kunci untuk dokumen.
KeyPhraseTaskParameters	Parameter yang didukung untuk tugas Ekstraksi Frasa Kunci.
KeyPhraseTaskResult	Berisi teks analisis hasil tugas KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Berisi input analisis dokumen deteksi bahasa.
LanguageDetectionDocumentResult	Berisi deteksi bahasa untuk dokumen.
LanguageDetectionResult	Berisi hasil deteksi bahasa untuk permintaan tersebut.
LanguageDetectionTaskParameters	Parameter yang didukung untuk tugas Deteksi Bahasa.
LanguageDetectionTaskResult	Berisi hasil tugas deteksi bahasa untuk permintaan tersebut.
LanguageInput	Berisi input deteksi bahasa.
LinkedEntitiesDocumentResult	Hasil dokumen penautan entitas.
LinkedEntity	Objek LinkedEntity yang berisi entitas yang terdeteksi dengan sumber/tautan terkait.
Match	Objek Cocokkan yang berisi teks entitas yang terdeteksi dengan offset dan panjangnya.
MultiLanguageAnalysisInput	Kumpulan dokumen input yang akan dianalisis oleh layanan.
MultiLanguageInput	Berisi dokumen input yang akan dianalisis oleh layanan.
PiiCategory	(Opsional) menjelaskan kategori PII yang akan dikembalikan
PiiDomain	Domain untuk tugas PII
PiiEntitiesDocumentResult	Berisi hasil PII.
PiiResult	Berisi PiiResult.
PiiTaskParameters	Parameter yang didukung untuk tugas Pengenalan Entitas PII.
PiiTaskResult	Berisi teks analisis tugas PIIEntityRecognition LRO.
RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.
SentenceAssessment	Mewakili penilaian kalimat dan penilaian atau objek target yang terkait dengannya.
SentenceSentiment	Sentimen kalimat dokumen.
SentenceSentimentValue	Sentimen yang diprediksi untuk kalimat tersebut.
SentenceTarget	Mewakili target kalimat dan penilaian atau objek target yang terkait dengannya.
SentimentAnalysisTaskParameters	Parameter yang didukung untuk tugas Analisis Sentimen.
SentimentConfidenceScores	Mewakili skor keyakinan antara 0 dan 1 di semua kelas sentimen: positif, netral, negatif.
SentimentDocumentResult	Objek yang mewakili hasil Analisis Sentimen bawaan dari setiap dokumen.
SentimentResponse	Hasil analisis sentimen untuk dokumen input.
SentimentTaskResult	Berisi teks analisis hasil tugas LRO SentimentAnalysis.
StringIndexType	Jenis indeks string
TargetConfidenceScoreLabel	Mewakili skor keyakinan di semua kelas sentimen: positif dan negatif.
TargetRelation	Mewakili hubungan antara penilaian dan/atau target.
TargetRelationType	Jenis yang terkait dengan target.
TokenSentimentValue	Sentimen yang diprediksi untuk kalimat tersebut.
WarningCodeValue	Menentukan daftar kode peringatan.

AnalyzeTextEntityLinkingInput

Berisi teks analisis Input penautan Entitas.

Nama	Jenis	Deskripsi
analysisInput	MultiLanguageAnalysisInput	Berisi input analisis yang akan ditangani oleh layanan.
kind	string: EntityLinking	Jenis tugas yang harus dilakukan.
parameters	EntityLinkingTaskParameters	Parameter tugas.

AnalyzeTextEntityRecognitionInput

Pengenalan entitas menganalisis permintaan tugas input teks.

Nama	Jenis	Deskripsi
analysisInput	MultiLanguageAnalysisInput	Input yang akan dianalisis.
kind	string: EntityRecognition	Jenis tugas yang harus dilakukan.
parameters	EntitiesTaskParameters	Parameter tugas.

AnalyzeTextKeyPhraseExtractionInput

Berisi teks analisis input tugas KeyPhraseExtraction.

Nama	Jenis	Deskripsi
analysisInput	MultiLanguageAnalysisInput	Berisi dokumen input.
kind	string: KeyPhraseExtraction	Jenis tugas yang harus dilakukan.
parameters	KeyPhraseTaskParameters	Parameter tugas ekstraksi frasa kunci.

AnalyzeTextLanguageDetectionInput

Berisi input tugas analisis dokumen deteksi bahasa.

Nama	Jenis	Deskripsi
analysisInput	LanguageDetectionAnalysisInput	Dokumen yang akan dianalisis.
kind	string: LanguageDetection	Jenis tugas yang harus dilakukan.
parameters	LanguageDetectionTaskParameters	parameter tugas.

AnalyzeTextPiiEntitiesRecognitionInput

Berisi teks analisis input tugas PIIEntityRecognition.

Nama	Jenis	Deskripsi
analysisInput	MultiLanguageAnalysisInput	Berisi dokumen input.
kind	string: PiiEntityRecognition	Jenis tugas yang harus dilakukan.
parameters	PiiTaskParameters	Parameter tugas Pii.

AnalyzeTextSentimentAnalysisInput

Berisi teks analisis input tugas SentimentAnalysis.

Nama	Jenis	Deskripsi
analysisInput	MultiLanguageAnalysisInput	Berisi dokumen input.
kind	string: SentimentAnalysis	Jenis tugas yang harus dilakukan.
parameters	SentimentAnalysisTaskParameters	Parameter tugas Analisis Sentimen.

AnalyzeTextTaskKind

Jenis tugas analisis teks yang didukung.

Nama	Jenis	Deskripsi
EntityLinking	string	Tugas penautan entitas
EntityRecognition	string	Tugas pengenalan entitas
KeyPhraseExtraction	string	Tugas ekstraksi frasa kunci
LanguageDetection	string	Tugas deteksi bahasa
PiiEntityRecognition	string	Tugas pengenalan entitas PII
SentimentAnalysis	string	Tugas analisis sentimen

AnalyzeTextTaskResultsKind

Jenis objek respons yang dikembalikan oleh tugas analyze-text.

Nama	Jenis	Deskripsi
EntityLinkingResults	string	Hasil penautan entitas
EntityRecognitionResults	string	Hasil pengenalan entitas
KeyPhraseExtractionResults	string	Hasil ekstraksi frasa kunci
LanguageDetectionResults	string	Hasil deteksi bahasa
PiiEntityRecognitionResults	string	Hasil pengenalan entitas PII
SentimentAnalysisResults	string	Hasil analisis sentimen

DetectedLanguage

Berisi detail bahasa yang terdeteksi untuk teks.

Nama	Jenis	Deskripsi
confidenceScore	number	Skor keyakinan antara 0 dan 1. Skor mendekati 1 menunjukkan kepastian 100% bahwa bahasa yang diidentifikasi itu benar.
iso6391Name	string	Representasi dua huruf dari bahasa yang terdeteksi sesuai dengan standar ISO 639-1 (misalnya en, fr).
name	string	Nama panjang bahasa yang terdeteksi (misalnya Bahasa Inggris, Bahasa Prancis).

DocumentError

Berisi detail kesalahan yang ditemui selama eksekusi pekerjaan.

Nama	Jenis	Deskripsi
error	Error	Terjadi kesalahan.
id	string	ID dokumen input.

DocumentSentimentValue

Sentimen yang diprediksi untuk dokumen (Negatif, Netral, Positif, atau Campuran).

Nama	Jenis	Deskripsi
mixed	string	Pernyataan campuran
negative	string	Pernyataan negatif
neutral	string	Pernyataan netral
positive	string	Pernyataan positif

DocumentStatistics

jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.

Nama	Jenis	Deskripsi
charactersCount	integer	Jumlah elemen teks yang dikenali dalam dokumen.
transactionsCount	integer	Jumlah transaksi untuk dokumen.

DocumentWarning

Berisi objek peringatan dengan peringatan yang ditemui untuk dokumen yang diproses.

Nama	Jenis	Deskripsi
code	WarningCodeValue	Kode peringatan.
message	string	Pesan peringatan.
targetRef	string	Referensi pointer JSON yang menunjukkan objek target.

EntitiesDocumentResult

Berisi hasil tugas pengenalan entitas untuk dokumen.

Nama	Jenis	Deskripsi
entities	Entity[]	Entitas yang dikenali dalam dokumen.
id	string	Pengidentifikasi dokumen unik dan tidak kosong.
statistics	DocumentStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.
warnings	DocumentWarning[]	Peringatan ditemui saat memproses dokumen.

EntitiesResult

Berisi hasil tugas pengenalan entitas.

Nama	Jenis	Deskripsi
documents	EntitiesDocumentResult[]	Respons menurut dokumen
errors	DocumentError[]	Kesalahan menurut id dokumen.
modelVersion	string	Bidang ini menunjukkan model mana yang digunakan untuk penilaian.
statistics	RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

EntitiesTaskParameters

Parameter yang didukung untuk tugas Pengenalan Entitas.

Nama	Jenis	Nilai Default	Deskripsi
loggingOptOut	boolean	False	penolakan pengelogan
modelVersion	string	latest	versi model
stringIndexType	StringIndexType	TextElements_v8	Parameter (Opsional) untuk menyediakan jenis indeks string yang digunakan untuk menginterpretasikan offset string. Default ke TextElements (Graphemes).

EntitiesTaskResult

Berisi tugas entitas

Nama	Jenis	Deskripsi
kind	string: EntityRecognitionResults	Jenis hasil tugas.
results	EntitiesResult	Hasil untuk pengenalan entitas.

Entity

Menentukan objek entitas yang terdeteksi yang berisi kategori entitas dan teks entitas yang terdeteksi, dll.

Nama	Jenis	Deskripsi
category	string	Jenis entitas.
confidenceScore	number	Skor keyakinan antara 0 dan 1 dari entitas yang diekstrak.
length	integer	Panjang untuk teks entitas. Penggunaan nilai 'stringIndexType' yang berbeda dapat memengaruhi panjang yang dikembalikan.
offset	integer	Posisi mulai untuk teks entitas. Penggunaan nilai 'stringIndexType' yang berbeda dapat memengaruhi offset yang dikembalikan.
subcategory	string	(Opsional) Subjenis entitas.
text	string	Teks entitas seperti yang muncul dalam permintaan.

EntityLinkingResult

Hasil penautan entitas.

Nama	Jenis	Deskripsi
documents	LinkedEntitiesDocumentResult[]	Respons menurut dokumen
errors	DocumentError[]	Kesalahan menurut id dokumen.
modelVersion	string	Bidang ini menunjukkan model mana yang digunakan untuk penilaian.
statistics	RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

EntityLinkingTaskParameters

Parameter yang didukung untuk tugas Penautan Entitas.

Nama	Jenis	Nilai Default	Deskripsi
loggingOptOut	boolean	False	penolakan pengelogan
modelVersion	string	latest	versi model
stringIndexType	StringIndexType	TextElements_v8	Parameter opsional untuk menyediakan jenis indeks string yang digunakan untuk menginterpretasikan offset string. Default ke TextElements (Graphemes).

EntityLinkingTaskResult

Berisi teks analisis hasil tugas penautan Entitas.

Nama	Jenis	Deskripsi
kind	string: EntityLinkingResults	Jenis hasil tugas.
results	EntityLinkingResult	Hasil penautan entitas.

Error

Objek respons kesalahan dikembalikan ketika layanan mengalami beberapa kesalahan selama memproses permintaan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu set 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	kesalahan batas indeks Azure Cognitive Search tercapai
AzureCognitiveSearchIndexNotFound	string	kesalahan indeks Azure Cognitive Search tidak ditemukan
AzureCognitiveSearchNotFound	string	Azure Cognitive Search tidak ditemukan kesalahan
AzureCognitiveSearchThrottling	string	Azure Cognitive Search kesalahan pembatasan
Conflict	string	Kesalahan konflik
Forbidden	string	Kesalahan akses terlarang
InternalServerError	string	Kesalahan server internal
InvalidArgument	string	Kesalahan argumen tidak valid
InvalidRequest	string	Kesalahan permintaan tidak valid
NotFound	string	Kesalahan tidak ditemukan
OperationNotFound	string	Operasi tidak menemukan kesalahan
ProjectNotFound	string	Kesalahan proyek tidak ditemukan
QuotaExceeded	string	Kesalahan melebihi kuota
ServiceUnavailable	string	Kesalahan layanan tidak tersedia
Timeout	string	Kesalahan waktu habis
TooManyRequests	string	Terlalu banyak kesalahan permintaan
Unauthorized	string	Kesalahan akses tidak sah
Warning	string	Kesalahan peringatan

ErrorResponse

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
AzureCognitiveSearchNotFound	string	Azure Cognitive Search tidak ditemukan kesalahan
AzureCognitiveSearchThrottling	string	Azure Cognitive Search kesalahan pembatasan
EmptyRequest	string	Kesalahan permintaan kosong
ExtractionFailure	string	Kesalahan kegagalan ekstraksi
InvalidCountryHint	string	Kesalahan petunjuk negara tidak valid
InvalidDocument	string	Kesalahan dokumen tidak valid
InvalidDocumentBatch	string	Kesalahan batch dokumen tidak valid
InvalidParameterValue	string	Kesalahan nilai parameter tidak valid
InvalidRequest	string	Kesalahan permintaan tidak valid
InvalidRequestBodyFormat	string	Kesalahan format isi permintaan tidak valid
KnowledgeBaseNotFound	string	Kesalahan pangkalan pengetahuan tidak ditemukan
MissingInputDocuments	string	Kesalahan dokumen input yang hilang
ModelVersionIncorrect	string	Kesalahan versi model salah
UnsupportedLanguageCode	string	Kesalahan kode bahasa yang tidak didukung

InnerErrorModel

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. 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 set 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.

KeyPhraseResult

Berisi KeyPhraseResult.

Nama	Jenis	Deskripsi
documents	KeyPhrasesDocumentResult[]	Respons menurut dokumen
errors	DocumentError[]	Kesalahan menurut id dokumen.
modelVersion	string	Bidang ini menunjukkan model mana yang digunakan untuk penilaian.
statistics	RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

KeyPhrasesDocumentResult

Berisi hasil ekstraksi Frasa kunci untuk dokumen.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi dokumen unik dan tidak kosong.
keyPhrases	string[]	Daftar kata atau frasa perwakilan. Jumlah frasa kunci yang dikembalikan sebanding dengan jumlah kata dalam dokumen input.
statistics	DocumentStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.
warnings	DocumentWarning[]	Peringatan ditemui saat memproses dokumen.

KeyPhraseTaskParameters

Parameter yang didukung untuk tugas Ekstraksi Frasa Kunci.

Nama	Jenis	Nilai Default	Deskripsi
loggingOptOut	boolean	False	penolakan pengelogan
modelVersion	string	latest	versi model

KeyPhraseTaskResult

Berisi teks analisis hasil tugas KeyPhraseExtraction.

Nama	Jenis	Deskripsi
kind	string: KeyPhraseExtractionResults	Jenis hasil tugas.
results	KeyPhraseResult	Daftar hasil ekstraksi frasa kunci

LanguageDetectionAnalysisInput

Berisi input analisis dokumen deteksi bahasa.

Nama	Jenis	Deskripsi
documents	LanguageInput[]	Daftar dokumen yang akan dianalisis.

LanguageDetectionDocumentResult

Berisi deteksi bahasa untuk dokumen.

Nama	Jenis	Deskripsi
detectedLanguage	DetectedLanguage	Bahasa yang Terdeteksi.
id	string	Pengidentifikasi dokumen unik dan tidak kosong.
statistics	DocumentStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.
warnings	DocumentWarning[]	Peringatan ditemui saat memproses dokumen.

LanguageDetectionResult

Berisi hasil deteksi bahasa untuk permintaan tersebut.

Nama	Jenis	Deskripsi
documents	LanguageDetectionDocumentResult[]	Enumerasi hasil deteksi bahasa untuk setiap dokumen input.
errors	DocumentError[]	Kesalahan menurut id dokumen.
modelVersion	string	Bidang ini menunjukkan model mana yang digunakan untuk penilaian.
statistics	RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

LanguageDetectionTaskParameters

Parameter yang didukung untuk tugas Deteksi Bahasa.

Nama	Jenis	Nilai Default	Deskripsi
loggingOptOut	boolean	False	penolakan pengelogan
modelVersion	string	latest	versi model

LanguageDetectionTaskResult

Berisi hasil tugas deteksi bahasa untuk permintaan tersebut.

Nama	Jenis	Deskripsi
kind	string: LanguageDetectionResults	Jenis hasil tugas.
results	LanguageDetectionResult	Berisi hasil deteksi bahasa.

LanguageInput

Berisi input deteksi bahasa.

Nama	Jenis	Deskripsi
countryHint	string	Petunjuk negara untuk membantu deteksi bahasa teks.
id	string	Pengidentifikasi dokumen unik yang tidak kosong.
text	string	Teks input untuk diproses.

LinkedEntitiesDocumentResult

Hasil dokumen penautan entitas.

Nama	Jenis	Deskripsi
entities	LinkedEntity[]	Mengenali entitas terkenal dalam dokumen.
id	string	Pengidentifikasi dokumen unik dan tidak kosong.
statistics	DocumentStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.
warnings	DocumentWarning[]	Peringatan ditemui saat memproses dokumen.

LinkedEntity

Objek LinkedEntity yang berisi entitas yang terdeteksi dengan sumber/tautan terkait.

Nama	Jenis	Deskripsi
bingId	string	Pengidentifikasi unik Bing Entity Search API dari entitas yang dikenali.
dataSource	string	Sumber data yang digunakan untuk mengekstrak penautan entitas, seperti Wiki/Bing, dll.
id	string	Pengidentifikasi unik entitas yang dikenali dari sumber data.
language	string	Bahasa yang digunakan dalam sumber data.
matches	Match[]	Daftar instans entitas ini muncul dalam teks.
name	string	Nama formal Penautan Entitas.
url	string	URL untuk halaman entitas dari sumber data.

Match

Objek Cocokkan yang berisi teks entitas yang terdeteksi dengan offset dan panjangnya.

Nama	Jenis	Deskripsi
confidenceScore	number	Jika item terkenal dikenali, angka desimal yang menunjukkan tingkat keyakinan antara 0 dan 1 akan dikembalikan.
length	integer	Panjang untuk teks pencocokan entitas.
offset	integer	Posisi mulai untuk teks pencocokan entitas.
text	string	Teks entitas seperti yang muncul dalam permintaan.

MultiLanguageAnalysisInput

Kumpulan dokumen input yang akan dianalisis oleh layanan.

Nama	Jenis	Deskripsi
documents	MultiLanguageInput[]	Dokumen input yang akan dianalisis.

MultiLanguageInput

Berisi dokumen input yang akan dianalisis oleh layanan.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi dokumen unik yang tidak kosong.
language	string	(Opsional) Ini adalah representasi 2 huruf ISO 639-1 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris; "es" untuk bahasa Spanyol dll. Jika tidak diatur, gunakan "en" untuk bahasa Inggris sebagai default. (Hanya berlaku untuk pratinjau 2023-04-15 ke atas) Untuk Deteksi Bahasa Otomatis, gunakan "otomatis". Jika tidak diatur, gunakan "en" untuk bahasa Inggris sebagai default.
text	string	Teks input untuk diproses.

PiiCategory

(Opsional) menjelaskan kategori PII yang akan dikembalikan

Nama	Jenis	Deskripsi
ABARoutingNumber	string	Nomor Perutean ABA
ARNationalIdentityNumber	string	Nomor Identitas Nasional AR
ATIdentityCard	string	Kartu Identitas AT
ATTaxIdentificationNumber	string	Nomor Identifikasi Pajak AT
ATValueAddedTaxNumber	string	Nomor Pajak Pertambahan Nilai AT
AUBankAccountNumber	string	Kartu Identitas AT
AUBusinessNumber	string	Nomor Bisnis AU
AUCompanyNumber	string	Nomor Perusahaan AU
AUDriversLicenseNumber	string	Nomor SIM AU
AUMedicalAccountNumber	string	Nomor Akun Medis AU
AUPassportNumber	string	Nomor Paspor AU
AUTaxFileNumber	string	Nomor File Pajak AU
Address	string	Alamat
Age	string	Usia
All	string	Semua kategori PII.
AzureDocumentDBAuthKey	string	Kunci Autentikasi DB Dokumen Azure
AzureIAASDatabaseConnectionAndSQLString	string	Koneksi Azure IAAS Database dan string SQL
AzureIoTConnectionString	string	String Koneksi Azure IoT
AzurePublishSettingPassword	string	Kata Sandi Pengaturan Penerbitan Azure
AzureRedisCacheString	string	Azure Redis Cache String
AzureSAS	string	Azure SAS
AzureServiceBusString	string	String Azure Service Bus
AzureStorageAccountGeneric	string	Generik Akun Azure Storage
AzureStorageAccountKey	string	Kunci Akun Microsoft Azure Storage
BENationalNumber	string	NOMOR NASIONAL BE
BENationalNumberV2	string	BE Nomor Nasional V2
BEValueAddedTaxNumber	string	Nomor Pajak Pertambahan Nilai BE
BGUniformCivilNumber	string	Nomor Sipil Seragam BG
BRCPFNumber	string	Nomor CPF BR
BRLegalEntityNumber	string	Nomor Badan Hukum BR
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	Nomor Rekening Bank CA
CADriversLicenseNumber	string	Nomor SIM CA
CAHealthServiceNumber	string	Nomor Layanan Kesehatan CA
CAPassportNumber	string	Nomor Paspor CA
CAPersonalHealthIdentification	string	Identifikasi Kesehatan Pribadi CA
CASocialInsuranceNumber	string	Nomor Asuransi Sosial CA
CHSocialSecurityNumber	string	Nomor Jaminan Sosial CH
CLIdentityCardNumber	string	Nomor Kartu Identitas CL
CNResidentIdentityCardNumber	string	Nomor Kartu Identitas Penduduk CN
CYIdentityCard	string	Kartu Identitas CY
CYTaxIdentificationNumber	string	Nomor Identifikasi Pajak CY
CZPersonalIdentityNumber	string	Nomor Identitas Pribadi CZ
CZPersonalIdentityV2	string	Identitas Pribadi CZ V2
CreditCardNumber	string	Nomor Kartu Kredit
DEDriversLicenseNumber	string	Nomor SIM DE
DEIdentityCardNumber	string	Nomor Kartu Identitas DE
DEPassportNumber	string	Nomor Paspor DE
DETaxIdentificationNumber	string	NOMOR Identifikasi Pajak DE
DEValueAddedNumber	string	Nomor Tambah Nilai DE
DKPersonalIdentificationNumber	string	Nomor Identifikasi Pribadi DK
DKPersonalIdentificationV2	string	Identifikasi Pribadi DK V2
Date	string	Tanggal
Default	string	Kategori PII default untuk bahasa.
DrugEnforcementAgencyNumber	string	Nomor Badan Penegakan Narkoba
EEPersonalIdentificationCode	string	Kode Identifikasi Pribadi EE
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Nomor Jaminan Sosial ES
ESTaxIdentificationNumber	string	Nomor Identifikasi Pajak ES
EUDebitCardNumber	string	Nomor Kartu Debit Eropa
EUDriversLicenseNumber	string	Nomor SIM Eropa
EUGPSCoordinates	string	Koordinat GPS Eropa
EUNationalIdentificationNumber	string	Nomor Identifikasi Nasional Eropa
EUPassportNumber	string	Nomor Paspor Eropa
EUSocialSecurityNumber	string	Nomor Jaminan Sosial Eropa
EUTaxIdentificationNumber	string	Nomor Identifikasi Pajak Eropa
Email	string	Email
FIEuropeanHealthNumber	string	Nomor Kesehatan FI Eropa
FINationalID	string	ID Nasional FI
FINationalIDV2	string	ID Nasional FI V2
FIPassportNumber	string	Nomor Paspor FI
FRDriversLicenseNumber	string	Nomor SIM FR
FRHealthInsuranceNumber	string	Nomor Asuransi Kesehatan FR
FRNationalID	string	ID Nasional FR
FRPassportNumber	string	Nomor Paspor FR
FRSocialSecurityNumber	string	Nomor Jaminan Sosial FR
FRTaxIdentificationNumber	string	Nomor Identifikasi Pajak FR
FRValueAddedTaxNumber	string	Nomor Pajak Pertambahan Nilai FR
GRNationalIDCard	string	Kartu ID Nasional GR
GRNationalIDV2	string	GR National ID V2
GRTaxIdentificationNumber	string	Nomor Identifikasi Pajak GR
HKIdentityCardNumber	string	Nomor Kartu Identitas HK
HRIdentityCardNumber	string	Nomor Kartu Identitas SDM
HRNationalIDNumber	string	Nomor ID Nasional SDM
HRPersonalIdentificationNumber	string	Nomor Identifikasi Pribadi SDM
HRPersonalIdentificationOIBNumberV2	string	HR Personal Identification OIB Number V2
HUPersonalIdentificationNumber	string	Nomor Identifikasi Pribadi HU
HUTaxIdentificationNumber	string	Nomor Identifikasi Pajak HU
HUValueAddedNumber	string	Nomor Tambah Nilai HU
IDIdentityCardNumber	string	Nomor KTP
IEPersonalPublicServiceNumber	string	Nomor Layanan Publik Pribadi IE
IEPersonalPublicServiceNumberV2	string	Nomor Layanan Publik Pribadi IE V2
ILBankAccountNumber	string	Nomor Rekening Bank IL
ILNationalID	string	ID Nasional IL
INPermanentAccount	string	AKUN Permanen IN
INUniqueIdentificationNumber	string	IN Nomor Identifikasi Unik
IPAddress	string	Alamat IP
ITDriversLicenseNumber	string	Nomor SIM IT
ITFiscalCode	string	Kode Fiskal IT
ITValueAddedTaxNumber	string	Nomor Pajak Pertambahan Nilai IT
InternationalBankingAccountNumber	string	Nomor Rekening Perbankan Internasional
JPBankAccountNumber	string	Nomor Rekening Bank JP
JPDriversLicenseNumber	string	Nomor SIM JP
JPMyNumberCorporate	string	JP Perusahaan Nomor Saya
JPMyNumberPersonal	string	JP Nomor Pribadi Saya
JPPassportNumber	string	Nomor Paspor JP
JPResidenceCardNumber	string	Nomor Kartu Kependudukan JP
JPResidentRegistrationNumber	string	Nomor Registrasi Penduduk JP
JPSocialInsuranceNumber	string	Nomor Asuransi Sosial JP
KRResidentRegistrationNumber	string	Nomor Registrasi Penduduk KR
LTPersonalCode	string	Kode Pribadi LT
LUNationalIdentificationNumberNatural	string	Nomor Identifikasi Nasional LU Alami
LUNationalIdentificationNumberNonNatural	string	Nomor Identifikasi Nasional LU Non Alami
LVPersonalCode	string	Kode Pribadi LV
MTIdentityCardNumber	string	Nomor Kartu Identitas MT
MTTaxIDNumber	string	Nomor ID Pajak MT
MYIdentityCardNumber	string	Nomor Kartu Identitas SAYA
NLCitizensServiceNumber	string	Nomor Layanan Warga Negara NL
NLCitizensServiceNumberV2	string	Nomor Layanan Warga Negara NL V2
NLTaxIdentificationNumber	string	Nomor Identifikasi Pajak NL
NLValueAddedTaxNumber	string	Nomor Pajak Pertambahan Nilai NL
NOIdentityNumber	string	TIDAK ADA Nomor Identitas
NZBankAccountNumber	string	Nomor Rekening Bank NZ
NZDriversLicenseNumber	string	Nomor SIM NZ
NZInlandRevenueNumber	string	Nomor Pendapatan Pedalaman NZ
NZMinistryOfHealthNumber	string	Nomor Kementerian Kesehatan NZ
NZSocialWelfareNumber	string	Nomor Kesejahteraan Sosial NZ
Organization	string	Organisasi
PHUnifiedMultiPurposeIDNumber	string	Nomor ID Multi-Tujuan Terpadu PH
PLIdentityCard	string	Kartu Identitas PL
PLNationalID	string	ID Nasional PL
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	Nomor Paspor PL
PLREGONNumber	string	Nomor PL REGON
PLTaxIdentificationNumber	string	Nomor Identifikasi Pajak PL
PTCitizenCardNumber	string	Nomor Kartu Warga Negara PT
PTCitizenCardNumberV2	string	Kartu Warga NEGARA PT Nomor V2
PTTaxIdentificationNumber	string	Nomor Identifikasi Pajak PT
Person	string	Orang
PhoneNumber	string	Nomor Telepon
ROPersonalNumericalCode	string	Kode Numerik Pribadi RO
RUPassportNumberDomestic	string	Nomor Paspor RU Domestik
RUPassportNumberInternational	string	Nomor Paspor RU Internasional
SANationalID	string	ID Nasional SA
SENationalID	string	ID Nasional SE
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Nomor Paspor SE
SETaxIdentificationNumber	string	Nomor Identifikasi Pajak SE
SGNationalRegistrationIdentityCardNumber	string	Nomor Kartu Identitas Pendaftaran Nasional SG
SITaxIdentificationNumber	string	Nomor Identifikasi Pajak SI
SIUniqueMasterCitizenNumber	string	Nomor Warga Negara Master Unik SI
SKPersonalNumber	string	Nomor Pribadi SK
SQLServerConnectionString	string	String koneksi Microsoft SQL Server
SWIFTCode	string	Kode SWIFT
THPopulationIdentificationCode	string	Kode Identifikasi Populasi TH
TRNationalIdentificationNumber	string	Nomor Identifikasi Nasional TR
TWNationalID	string	ID Nasional TW
TWPassportNumber	string	Nomor Paspor TW
TWResidentCertificate	string	Sertifikat Penduduk TW
UAPassportNumberDomestic	string	Nomor Paspor UA Domestik
UAPassportNumberInternational	string	Nomor Paspor UA Internasional
UKDriversLicenseNumber	string	Nomor SIM Inggris
UKElectoralRollNumber	string	Nomor Gulung Pemilih Inggris
UKNationalHealthNumber	string	Nomor Kesehatan Nasional Inggris
UKNationalInsuranceNumber	string	Nomor Asuransi Nasional Inggris
UKUniqueTaxpayerNumber	string	Nomor Wajib Pajak Unik Inggris
URL	string	URL
USBankAccountNumber	string	Nomor Rekening Bank AS
USDriversLicenseNumber	string	Nomor SIM AS
USIndividualTaxpayerIdentification	string	Identifikasi Wajib Pajak Individu AS
USSocialSecurityNumber	string	Nomor Jaminan Sosial AS
USUKPassportNumber	string	Nomor Paspor AS UK
ZAIdentificationNumber	string	Nomor Identifikasi ZA

PiiDomain

Domain untuk tugas PII

Nama	Jenis	Deskripsi
none	string	Menunjukkan bahwa tidak ada domain yang ditentukan.
phi	string	Menunjukkan bahwa entitas di domain Informasi Kesehatan Pribadi harus diredaksi.

PiiEntitiesDocumentResult

Berisi hasil PII.

Nama	Jenis	Deskripsi
entities	Entity[]	Entitas yang dikenali dalam dokumen.
id	string	Pengidentifikasi dokumen unik dan tidak kosong.
redactedText	string	Mengembalikan teks yang diredaksi.
statistics	DocumentStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.
warnings	DocumentWarning[]	Peringatan ditemui saat memproses dokumen.

PiiResult

Berisi PiiResult.

Nama	Jenis	Deskripsi
documents	PiiEntitiesDocumentResult[]	Respons menurut dokumen
errors	DocumentError[]	Kesalahan menurut id dokumen.
modelVersion	string	Bidang ini menunjukkan model mana yang digunakan untuk penilaian.
statistics	RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

PiiTaskParameters

Parameter yang didukung untuk tugas Pengenalan Entitas PII.

Nama	Jenis	Nilai Default	Deskripsi
domain	PiiDomain	none	Domain untuk tugas PII
loggingOptOut	boolean	False	penolakan pengelogan
modelVersion	string	latest	versi model
piiCategories	PiiCategory[]		Enumerasi kategori PII yang akan dikembalikan dalam respons.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType yang akan digunakan untuk analisis.

PiiTaskResult

Berisi teks analisis tugas PIIEntityRecognition LRO.

Nama	Jenis	Deskripsi
kind	string: PiiEntityRecognitionResults	Jenis hasil tugas.
results	PiiResult	Daftar hasil pii

RequestStatistics

jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

Nama	Jenis	Deskripsi
documentsCount	integer	Jumlah dokumen yang dikirimkan dalam permintaan.
erroneousDocumentsCount	integer	Jumlah dokumen yang tidak valid. Ini termasuk dokumen bahasa yang kosong, terlalu besar, atau tidak didukung.
transactionsCount	integer	Jumlah transaksi untuk permintaan tersebut.
validDocumentsCount	integer	Jumlah dokumen yang valid. Ini mengecualikan dokumen bahasa yang kosong, terlalu besar, atau tidak didukung.

SentenceAssessment

Mewakili penilaian kalimat dan penilaian atau objek target yang terkait dengannya.

Nama	Jenis	Deskripsi
confidenceScores	TargetConfidenceScoreLabel	Mewakili skor keyakinan di semua kelas sentimen: positif dan negatif.
isNegated	boolean	Indikator yang menunjukkan apakah penilaian dinegasikan.
length	integer	Panjang target.
offset	integer	Offset target dari awal kalimat.
sentiment	TokenSentimentValue	Sentimen kalimat.
text	string	Teks target terdeteksi.

SentenceSentiment

Sentimen kalimat dokumen.

Nama	Jenis	Deskripsi
assessments	SentenceAssessment[]	Array penilaian untuk kalimat.
confidenceScores	SentimentConfidenceScores	Skor keyakinan sentimen antara 0 dan 1 untuk kalimat untuk semua kelas.
length	integer	Panjang target.
offset	integer	Offset target dari awal kalimat.
sentiment	SentenceSentimentValue	Sentimen yang diprediksi untuk kalimat tersebut.
targets	SentenceTarget[]	Array kalimat menargetkan kalimat.
text	string	Teks kalimat.

SentenceSentimentValue

Sentimen yang diprediksi untuk kalimat tersebut.

Nama	Jenis	Deskripsi
negative	string	Sentimen negatif
neutral	string	Sentimen netral
positive	string	Sentimen positif

SentenceTarget

Mewakili target kalimat dan penilaian atau objek target yang terkait dengannya.

Nama	Jenis	Deskripsi
confidenceScores	TargetConfidenceScoreLabel	Mewakili skor keyakinan di semua kelas sentimen: positif dan negatif.
length	integer	Panjang target.
offset	integer	Offset target dari awal kalimat.
relations	TargetRelation[]	Array penilaian atau objek target yang terkait dengan target.
sentiment	TokenSentimentValue	Sentimen kalimat.
text	string	Teks target terdeteksi.

SentimentAnalysisTaskParameters

Parameter yang didukung untuk tugas Analisis Sentimen.

Nama	Jenis	Nilai Default	Deskripsi
loggingOptOut	boolean	False	penolakan pengelogan
modelVersion	string	latest	versi model
opinionMining	boolean	False	Apakah akan menggunakan penggalian opini dalam permintaan atau tidak.
stringIndexType	StringIndexType	TextElements_v8	Menentukan metode yang digunakan untuk menginterpretasikan offset string.

SentimentConfidenceScores

Mewakili skor keyakinan antara 0 dan 1 di semua kelas sentimen: positif, netral, negatif.

Nama	Jenis	Deskripsi
negative	number	Skor keyakinan untuk sentimen negatif
neutral	number	Skor keyakinan untuk sentimen netral
positive	number	Skor keyakinan untuk sentimen positif

SentimentDocumentResult

Objek yang mewakili hasil Analisis Sentimen bawaan dari setiap dokumen.

Nama	Jenis	Deskripsi
confidenceScores	SentimentConfidenceScores	Skor keyakinan sentimen antara 0 dan 1 untuk kalimat untuk semua kelas.
id	string	Pengidentifikasi dokumen unik dan tidak kosong.
sentences	SentenceSentiment[]	Kalimat dokumen sentimen.
sentiment	DocumentSentimentValue	Sentimen yang diprediksi untuk dokumen (Negatif, Netral, Positif, atau Campuran).
statistics	DocumentStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload dokumen.
warnings	DocumentWarning[]	Peringatan ditemui saat memproses dokumen.

SentimentResponse

Hasil analisis sentimen untuk dokumen input.

Nama	Jenis	Deskripsi
documents	SentimentDocumentResult[]	Hasil analisis sentimen untuk setiap dokumen dalam input.
errors	DocumentError[]	Kesalahan menurut id dokumen.
modelVersion	string	Bidang ini menunjukkan model mana yang digunakan untuk penilaian.
statistics	RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.

SentimentTaskResult

Berisi teks analisis hasil tugas LRO SentimentAnalysis.

Nama	Jenis	Deskripsi
kind	string: SentimentAnalysisResults	Jenis hasil tugas.
results	SentimentResponse	Hasil analisis sentimen

StringIndexType

Jenis indeks string

Nama	Jenis	Deskripsi
TextElements_v8	string	Nilai offset dan panjang yang dikembalikan akan sesuai dengan TextElements (kluster Graphemes dan Grapheme) yang mengonfirmasi ke standar Unicode 8.0.0. Gunakan opsi ini jika aplikasi Anda ditulis dalam .Net Framework atau .Net Core dan Anda akan menggunakan StringInfo.
UnicodeCodePoint	string	Nilai offset dan panjang yang dikembalikan akan sesuai dengan titik kode Unicode. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Python.
Utf16CodeUnit	string	Nilai offset dan panjang yang dikembalikan akan sesuai dengan unit kode UTF-16. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Java, JavaScript.

TargetConfidenceScoreLabel

Mewakili skor keyakinan di semua kelas sentimen: positif dan negatif.

Nama	Jenis	Deskripsi
negative	number	Skor keyakinan untuk sentimen negatif
positive	number	Skor keyakinan untuk sentimen positif

TargetRelation

Mewakili hubungan antara penilaian dan/atau target.

Nama	Jenis	Deskripsi
ref	string	Penunjuk JSON menunjukkan objek yang ditautkan.
relationType	TargetRelationType	Jenis yang terkait dengan target.

TargetRelationType

Jenis yang terkait dengan target.

Nama	Jenis	Deskripsi
assessment	string	Hubungan penilaian.
target	string	Hubungan target.

TokenSentimentValue

Sentimen yang diprediksi untuk kalimat tersebut.

Nama	Jenis	Deskripsi
mixed	string	Sentimen campuran
negative	string	Sentimen negatif
positive	string	Sentimen positif

WarningCodeValue

Menentukan daftar kode peringatan.

Nama	Jenis	Deskripsi
DocumentTruncated	string	Peringatan terpotok dokumen
LongWordsInDocument	string	Kata-kata panjang dalam peringatan dokumen