Text Analysis Runtime - Analyze Text

Layanan:

Azure AI Services

Versi API:

2024-11-01

Meminta analisis teks atas kumpulan dokumen.

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

Dengan parameter opsional:

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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 minLength: 1	Versi API yang akan digunakan untuk operasi ini.
showStats	query		boolean	(Opsional) jika diatur ke true, respons akan berisi statistik tingkat permintaan dan dokumen.

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 tak terduga. Header x-ms-error-code: string

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

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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."
      }
    ]
  }
}

Respon sampel

Kode status:

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

SuccessfulEntityRecognitionExclusionRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Respon sampel

Kode status:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Respon sampel

Kode status:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Respon sampel

Kode status:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Respon sampel

Kode status:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Respon sampel

Kode status:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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."
      }
    ]
  }
}

Respon sampel

Kode status:

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

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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?"
      }
    ]
  }
}

Respon sampel

Kode status:

200

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

SuccessfulPiiEntityRecognitionRequest

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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?"
      }
    ]
  }
}

Respon sampel

Kode status:

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

Permintaan sampel

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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."
      }
    ]
  }
}

Respon sampel

Kode status:

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
AgeMetadata	Mewakili model Metadata entitas Usia.
AgeUnit	Unit Usia pengukuran
AllowOverlapEntityPolicyType	Mewakili kebijakan izinkan tumpang tindih. Tidak akan menerapkan logika pemrosesan pasca untuk entitas. Apa pun yang diprediksi model adalah apa yang akan dikembalikan kepada pengguna. Ini memungkinkan pengguna untuk mendapatkan tampilan penuh dari setiap nilai model yang mungkin dan menerapkan logika kustom mereka sendiri pada pemilihan entitas
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.
AreaMetadata	Mewakili model Metadata entitas Area.
AreaUnit	Unit pengukuran area.
CurrencyMetadata	Mewakili model Metadata entitas Mata Uang ) .
DateMetadata	Metadata untuk instans entitas tanggal.
DateTimeMetadata	Metadata untuk instans entitas tanggalwaktu.
DateValue	Mewakili nilai tanggal.
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.
EntitiesDocumentResultWithMetadata	Hasil dokumen entitas dengan metadata.
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.
EntityCategory	Berisi semua kategori entitas yang terdeteksi oleh pengenalan entitas.
EntityInferenceOptions	Kelas yang menampung opsi inferensi yang diizinkan untuk pengenalan entitas bernama.
EntityLinkingResult	Hasil penautan entitas.
EntityLinkingTaskParameters	Parameter yang didukung untuk tugas Penautan Entitas.
EntityLinkingTaskResult	Berisi teks analisis hasil tugas penautan Entitas.
EntityTag	Objek tag entitas yang berisi nama tag yang tidak memiliki skor keyakinan terkait. Tag Entitas digunakan untuk mengekspresikan beberapa kesamaan/afinitas antar entitas.
EntityWithMetadata	Objek entitas dengan tag dan metadata.
Error	Objek respons kesalahan dikembalikan ketika layanan mengalami beberapa kesalahan selama memproses permintaan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
InformationMetadata	Mewakili model Metadata entitas Informasi (data).
InformationUnit	Satuan pengukuran informasi (data).
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.
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.
LanguageDetectionTaskParameters	Parameter yang didukung untuk tugas Deteksi Bahasa.
LanguageDetectionTaskResult	Berisi hasil tugas deteksi bahasa untuk permintaan tersebut.
LanguageInput	Berisi input deteksi bahasa.
LengthMetadata	Mewakili model Metadata entitas Panjang.
LengthUnit	Unit panjang pengukuran.
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.
MatchLongestEntityPolicyType	Mewakili kebijakan Tumpang tindih terpanjang Cocokkan. Tidak ada entitas yang tumpang tindih sejauh mungkin. 1. Jika ada entitas yang tumpang tindih, entitas terpanjang akan dikembalikan. 2. Jika sekumpulan karakter yang diprediksi untuk 2 entitas atau lebih sama persis, pilih entitas yang memiliki skor keyakinan yang lebih tinggi.3. Jika skor entitas identik, kembalikan semua entitas yang masih ada setelah menerapkan aturan sebelumnya. 3 Jika ada tumpang tindih parsial (seperti di Hello Text Analytics) ikuti langkah-langkah di atas mulai dari 1.
MetadataKind	Jenis objek Metadata entitas.
MultiLanguageAnalysisInput	Kumpulan dokumen input yang akan dianalisis oleh layanan.
MultiLanguageInput	Berisi dokumen input yang akan dianalisis oleh layanan.
NumberKind	Jenis entitas angka yang diekstrak.
NumberMetadata	Metadata untuk instans entitas numerik.
NumericRangeMetadata	mewakili Metadata interval numerik.
OrdinalMetadata	Metadata untuk instans entitas numerik.
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.
RangeInclusivity	Inklusifitas rentang properti ini.
RangeKind	Jenis entitas rentang angka.
RelativeTo	Titik referensi yang ditunjukkan oleh angka ordinal.
RequestStatistics	jika showStats=true ditentukan dalam permintaan, bidang ini akan berisi informasi tentang payload permintaan.
ScriptCode	Mengidentifikasi skrip dokumen input. Memetakan ke kode skrip standar ISO 15924.
ScriptKind	Mengidentifikasi skrip dokumen input. Memetakan ke nama formal standar ISO 15924.
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.
SpeedMetadata	Mewakili model Metadata entitas Kecepatan.
SpeedUnit	Unit kecepatan pengukuran
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.
TemperatureMetadata	Mewakili model Metadata entitas Informasi.
TemperatureUnit	Satuan pengukuran suhu.
TemporalModifier	Pengubah opsional instans tanggal/waktu.
TemporalSetMetadata	Metadata untuk instans entitas set temporal.
TemporalSpanMetadata	mewakili Metadata rentang tanggal dan/atau waktu.
TemporalSpanValues	Objek rentang temporal.
TimeMetadata	Metadata untuk instans entitas waktu.
TokenSentimentValue	Sentimen yang diprediksi untuk kalimat tersebut.
VolumeMetadata	Mewakili model Metadata entitas volume.
VolumeUnit	Unit Volume pengukuran
WarningCodeValue	Menentukan daftar kode peringatan.
WeightMetadata	Mewakili model Metadata entitas Bobot).
WeightUnit	Unit pengukuran berat.

AgeMetadata

Objek

Mewakili model Metadata entitas Usia.

Nama	Jenis	Deskripsi
metadataKind	string: AgeMetadata	Jenis objek Metadata entitas.
unit	AgeUnit	Satuan ukuran untuk usia.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

AgeUnit

Enumeration

Unit Usia pengukuran

Nilai	Deskripsi
Day	Periode waktu sehari
Month	Periode waktu sebulan
Unspecified	Periode waktu yang tidak ditentukan
Week	Periode waktu seminggu
Year	Periode waktu setahun

AllowOverlapEntityPolicyType

Objek

Mewakili kebijakan izinkan tumpang tindih. Tidak akan menerapkan logika pemrosesan pasca untuk entitas. Apa pun yang diprediksi model adalah apa yang akan dikembalikan kepada pengguna. Ini memungkinkan pengguna untuk mendapatkan tampilan penuh dari setiap nilai model yang mungkin dan menerapkan logika kustom mereka sendiri pada pemilihan entitas

Nama	Jenis	Nilai default	Deskripsi
policyKind	string: allowOverlap	matchLongest	Jenis objek OverlapPolicy entitas.

AnalyzeTextEntityLinkingInput

Objek

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

Objek

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

Objek

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

Objek

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

Objek

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

Objek

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

Enumeration

Jenis tugas analisis-teks yang didukung.

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

AnalyzeTextTaskResultsKind

Enumeration

Jenis objek respons yang dikembalikan oleh tugas analyze-text.

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

AreaMetadata

Objek

Mewakili model Metadata entitas Area.

Nama	Jenis	Deskripsi
metadataKind	string: AreaMetadata	Jenis objek Metadata entitas.
unit	AreaUnit	Satuan ukuran untuk area.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

AreaUnit

Enumeration

Unit pengukuran area.

Nilai	Deskripsi
Acre	Unit area dalam hektar
SquareCentimeter	Unit area dalam sentimeter persegi
SquareDecameter	Unit area dalam dekademetri persegi
SquareDecimeter	Unit area dalam desimal persegi
SquareFoot	Unit area dalam kaki persegi
SquareHectometer	Unit area dalam hektometer persegi
SquareInch	Unit area dalam inci persegi
SquareKilometer	Unit area dalam kilometer persegi
SquareMeter	Unit area dalam meter persegi
SquareMile	Unit area dalam mil persegi
SquareMillimeter	Unit area dalam milimeter persegi
SquareYard	Unit area dalam meter persegi
Unspecified	Unit area yang tidak ditentukan

CurrencyMetadata

Objek

Mewakili model Metadata entitas Mata Uang ) .

Nama	Jenis	Deskripsi
iso4217	string	Kode alfabet berdasarkan standar ISO lain, ISO 3166, yang mencantumkan kode untuk nama negara. Dua huruf pertama dari kode tiga huruf ISO 4217 sama dengan kode untuk nama negara, dan, jika memungkinkan, huruf ketiga sesuai dengan huruf pertama nama mata uang.
metadataKind	string: CurrencyMetadata	Jenis objek Metadata entitas.
unit	string	Unit mata uang.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

DateMetadata

Objek

Metadata untuk instans entitas tanggal.

Nama	Jenis	Deskripsi
dateValues	DateValue[]	Daftar nilai tanggal.
metadataKind	string: DateMetadata	Jenis objek Metadata entitas.

DateTimeMetadata

Objek

Metadata untuk instans entitas tanggalwaktu.

Nama	Jenis	Deskripsi
dateValues	DateValue[]	Daftar nilai tanggal.
metadataKind	string: DateTimeMetadata	Jenis objek Metadata entitas.

DateValue

Objek

Mewakili nilai tanggal.

Nama	Jenis	Deskripsi
modifier	TemporalModifier	Pengubah untuk tanggalwaktu untuk menunjukkan titik referensi seperti sebelumnya, setelah dll.
timex	string	Representasi tanggal/waktu ISO 8601 yang diperpanjang seperti yang dijelaskan dalam (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Waktu aktual yang diekstrak menunjukkan teks.

DetectedLanguage

Objek

Berisi detail bahasa yang terdeteksi untuk teks.

Nama	Jenis	Deskripsi
confidenceScore	number (double)	Skor keyakinan antara 0 dan 1. Skor mendekati 1 menunjukkan 100% kepastian bahwa bahasa yang diidentifikasi 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, Prancis).
scriptIso15924Code	ScriptCode	Mengidentifikasi kode skrip dokumen input sesuai dengan standar ISO 15924.
scriptName	ScriptKind	Mengidentifikasi nama skrip dokumen input sesuai dengan standar ISO 15924.

DocumentError

Objek

Berisi detail kesalahan yang ditemui selama eksekusi pekerjaan.

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

DocumentSentimentValue

Enumeration

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

Nilai	Deskripsi
mixed	Pernyataan campuran
negative	Pernyataan negatif
neutral	Pernyataan netral
positive	Pernyataan positif

DocumentStatistics

Objek

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

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

DocumentWarning

Objek

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.

EntitiesDocumentResultWithMetadata

Objek

Hasil dokumen entitas dengan metadata.

Nama	Jenis	Deskripsi
entities	EntityWithMetadata[]	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

Objek

Berisi hasil tugas pengenalan entitas.

Nama	Jenis	Deskripsi
documents	EntitiesDocumentResultWithMetadata[]	Respons berdasarkan 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

Objek

Parameter yang didukung untuk tugas Pengenalan Entitas.

Nama	Jenis	Nilai default	Deskripsi
exclusionList	EntityCategory[]		(Opsional) parameter permintaan yang memfilter entitas apa pun yang disertakan dalam excludeList. Saat pengguna menentukan excludeList, mereka tidak bisa mendapatkan prediksi yang dikembalikan dengan entitas dalam daftar tersebut. Kami akan menerapkan inclusionList sebelum exclusionList
inclusionList	EntityCategory[]		(Opsional) parameter permintaan yang membatasi output ke jenis entitas yang diminta yang disertakan dalam daftar ini. Kami akan menerapkan inclusionList sebelum exclusionList
inferenceOptions	EntityInferenceOptions		(Opsional) parameter permintaan yang memungkinkan pengguna menyediakan pengaturan untuk menjalankan inferensi.
loggingOptOut	boolean	False	penolakan pengelogan
modelVersion	string	latest	versi model
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Opsional) menjelaskan jenis kebijakan tumpang tindih untuk diterapkan ke output ner.
stringIndexType	StringIndexType	TextElements_v8	Parameter (Opsional) untuk menyediakan jenis indeks string yang digunakan untuk menginterpretasikan offset string. Default ke TextElements (Graphemes).

EntitiesTaskResult

Objek

Berisi tugas entitas

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

Entity

Objek

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

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

EntityCategory

Enumeration

Berisi semua kategori entitas yang terdeteksi oleh pengenalan entitas.

Nilai	Deskripsi
Address	Penyebutan lokasi tingkat jalan tertentu: nomor rumah/bangunan, jalan, jalan, jalan raya, persimpangan yang dirujuk berdasarkan nama.
Age	Nilai terkait usia.
Airport	Bandara.
Area	Area objek.
City	Nilai terkait kota.
ComputingProduct	Produk komputasi.
Continent	Nilai terkait benua.
CountryRegion	Nilai terkait negara atau wilayah.
CulturalEvent	Nilai terkait peristiwa budaya.
Currency	Nilai terkait mata uang.
Date	Tanggal kalender.
DateRange	Rentang tanggal.
DateTime	Tanggal kalender dengan waktu.
DateTimeRange	Rentang tanggal dan waktu.
Dimension	Dimensi pengukuran
Duration	Durasi waktu.
Email	Alamat email.
Event	Sosial, olahraga, bisnis, politik, pendidikan, alam, historis, kriminal, kekerasan, hukum, peristiwa militer dengan periode waktu yang ditentukan.
GPE	Kota, negara/wilayah, negara bagian.
Geological	Fitur geografis dan alam seperti sungai, lautan, dan gurun.
Height	Tinggi objek.
IP	alamat IP jaringan.
Information	Satuan ukuran untuk informasi digital.
Length	Panjang objek.
Location	Titik atau tempat tertentu di ruang fisik.
NaturalEvent	Nilai terkait peristiwa alami.
Number	Angka tanpa unit
NumberRange	Rentang Angka
Numeric	Nilai numerik, termasuk digit dan kata angka.
Ordinal	Nomor urut.
Organization	Perusahaan, lembaga, dan kelompok orang lain yang ditentukan oleh beberapa struktur organisasi yang mapan. Label ini dapat mencakup perusahaan, partai/gerakan politik, band musik, klub olahraga, badan pemerintah, dan organisasi publik. Kebangsaan atau agama bukan ORGANISASI.
OrganizationMedical	Perusahaan dan grup medis.
OrganizationSports	Organisasi terkait olahraga.
OrganizationStockExchange	Grup bursa saham.
Percentage	Nilai terkait persentase.
Person	Nama depan, belakang, dan tengah, nama karakter fiktif, dan alias. Judul, seperti 'Mr.' atau 'Presiden', tidak dianggap sebagai bagian dari entitas bernama.
PersonType	Peran manusia diklasifikasikan oleh keanggotaan grup.
PhoneNumber	Nomor telepon (hanya nomor telepon AS dan UE).
Product	Satu atau sekelompok objek komersial, dapat dikonsumsi, elektronik, kendaraan, kelompok makanan.
SetTemporal	Kumpulan nilai terkait waktu.
Skill	Kemampuan, keterampilan, atau keahlian.
Speed	Kecepatan objek.
SportsEvent	Nilai terkait acara olahraga.
State	Nilai terkait status.
Structural	Struktur buatan manusia.
Temperature	Nilai terkait suhu.
Temporal	Item yang berkaitan dengan waktu.
Time	Waktu dalam sehari.
TimeRange	Rentang waktu.
URL	URL ke situs web.
Volume	Volume objek.
Weight	Berat objek.

EntityInferenceOptions

Objek

Kelas yang menampung opsi inferensi yang diizinkan untuk pengenalan entitas bernama.

Nama	Jenis	Nilai default	Deskripsi
excludeNormalizedValues	boolean	False	Opsi untuk menyertakan/mengecualikan nilai entitas yang terdeteksi untuk dinormalisasi dan disertakan dalam metadata. Jenis entitas numerik dan temporal mendukung normalisasi nilai.

EntityLinkingResult

Objek

Hasil penautan entitas.

Nama	Jenis	Deskripsi
documents	LinkedEntitiesDocumentResult[]	Respons berdasarkan 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

Objek

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

Objek

Berisi teks analisis hasil tugas penautan Entitas.

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

EntityTag

Objek

Objek tag entitas yang berisi nama tag yang tidak memiliki skor keyakinan terkait. Tag Entitas digunakan untuk mengekspresikan beberapa kesamaan/afinitas antar entitas.

Nama	Jenis	Deskripsi
confidenceScore	number (double)	Skor deteksi antara 0 dan 1 entitas yang diekstrak.
name	string	Nama tag. Nama Tag Entitas akan unik secara global.

EntityWithMetadata

Objek

Objek entitas dengan tag dan metadata.

Nama	Jenis	Deskripsi
category	string	Jenis entitas.
confidenceScore	number (double)	Skor keyakinan antara 0 dan 1 entitas yang diekstrak.
length	integer (int32)	Panjang untuk teks entitas. Penggunaan nilai 'stringIndexType' yang berbeda dapat memengaruhi panjang yang dikembalikan.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Objek metadata entitas.
offset	integer (int32)	Posisi mulai untuk teks entitas. Penggunaan nilai 'stringIndexType' yang berbeda dapat memengaruhi offset yang dikembalikan.
subcategory	string	(Opsional) Sub jenis entitas.
tags	EntityTag[]	Daftar tag entitas. Tag adalah untuk mengekspresikan beberapa kesamaan/afinitas antar entitas.
text	string	Teks entitas seperti yang muncul dalam permintaan.
type	string	Jenis entitas adalah granularitas terendah (atau terbaik) di mana entitas telah terdeteksi. Jenis memetakan ke atribut metadata tertentu yang terkait dengan entitas yang terdeteksi.

Error

Objek

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

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

Enumeration

Kode kesalahan yang dapat dibaca manusia.

Nilai	Deskripsi
AzureCognitiveSearchIndexLimitReached	Kesalahan tercapainya batas indeks Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Kesalahan indeks Azure Cognitive Search tidak ditemukan
AzureCognitiveSearchNotFound	Kesalahan Azure Cognitive Search tidak ditemukan
AzureCognitiveSearchThrottling	Kesalahan pembatasan Azure Cognitive Search
Conflict	Kesalahan konflik
Forbidden	Kesalahan akses terlarang
InternalServerError	Kesalahan server internal
InvalidArgument	Kesalahan argumen tidak valid
InvalidRequest	Kesalahan permintaan tidak valid
NotFound	Kesalahan tidak ditemukan
OperationNotFound	Operasi tidak ditemukan kesalahan
ProjectNotFound	Kesalahan proyek tidak ditemukan
QuotaExceeded	Kesalahan kuota terlampaui
ServiceUnavailable	Kesalahan layanan tidak tersedia
Timeout	Kesalahan waktu habis
TooManyRequests	Terlalu banyak kesalahan permintaan
Unauthorized	Kesalahan akses tidak sah
Warning	Kesalahan peringatan

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InformationMetadata

Objek

Mewakili model Metadata entitas Informasi (data).

Nama	Jenis	Deskripsi
metadataKind	string: InformationMetadata	Jenis objek Metadata entitas.
unit	InformationUnit	Satuan ukuran untuk informasi.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

InformationUnit

Enumeration

Satuan pengukuran informasi (data).

Nilai	Deskripsi
Bit	Unit ukuran data dalam bit
Byte	Unit ukuran data dalam byte
Gigabit	Unit ukuran data dalam gigabit
Gigabyte	Unit ukuran data dalam gigabyte
Kilobit	Unit ukuran data dalam kilobit
Kilobyte	Unit ukuran data dalam kilobyte
Megabit	Unit ukuran data dalam megabit
Megabyte	Unit ukuran data dalam megabyte
Petabit	Unit ukuran data dalam petabit
Petabyte	Unit ukuran data dalam petabyte
Terabit	Unit ukuran data dalam terabit
Terabyte	Unit ukuran data dalam terabyte
Unspecified	Unit ukuran data yang tidak ditentukan

InnerErrorCode

Enumeration

Kode kesalahan yang dapat dibaca manusia.

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

InnerErrorModel

Objek

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.

KeyPhraseResult

Objek

Berisi KeyPhraseResult.

Nama	Jenis	Deskripsi
documents	KeyPhrasesDocumentResult[]	Respons berdasarkan 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

Objek

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

Objek

Parameter yang didukung untuk tugas Ekstraksi Frasa Kunci.

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

KeyPhraseTaskResult

Objek

Berisi teks analisis hasil tugas KeyPhraseExtraction.

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

LanguageDetectionAnalysisInput

Objek

Berisi input analisis dokumen deteksi bahasa.

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

LanguageDetectionDocumentResult

Objek

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

Objek

Berisi hasil deteksi bahasa untuk permintaan.

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

Objek

Parameter yang didukung untuk tugas Deteksi Bahasa.

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

LanguageDetectionTaskResult

Objek

Berisi hasil tugas deteksi bahasa untuk permintaan tersebut.

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

LanguageInput

Objek

Berisi input deteksi bahasa.

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

LengthMetadata

Objek

Mewakili model Metadata entitas Panjang.

Nama	Jenis	Deskripsi
metadataKind	string: LengthMetadata	Jenis objek Metadata entitas.
unit	LengthUnit	Satuan ukuran untuk panjangnya.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

LengthUnit

Enumeration

Unit panjang pengukuran.

Nilai	Deskripsi
Centimeter	Unit panjang dalam sentimeter.
Decameter	Unit panjang dalam dekadeter.
Decimeter	Unit panjang dalam desimal.
Foot	Unit panjang di kaki.
Hectometer	Unit panjang dalam hektometer.
Inch	Unit panjang dalam inci.
Kilometer	Unit panjang dalam kilometer.
LightYear	Unit panjang dalam tahun cahaya.
Meter	Unit panjang dalam meter.
Micrometer	Unit panjang dalam mikrometer.
Mile	Unit panjang dalam mil.
Millimeter	Unit panjang dalam milimeter.
Nanometer	Unit panjang dalam nanometer.
Picometer	Unit panjang dalam picometers.
Point	Unit panjang dalam titik.
Unspecified	Unit panjang yang tidak ditentukan.
Yard	Unit panjang dalam halaman.

LinkedEntitiesDocumentResult

Objek

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

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

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

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

MatchLongestEntityPolicyType

Objek

Mewakili kebijakan Tumpang tindih terpanjang Cocokkan. Tidak ada entitas yang tumpang tindih sejauh mungkin. 1. Jika ada entitas yang tumpang tindih, entitas terpanjang akan dikembalikan. 2. Jika sekumpulan karakter yang diprediksi untuk 2 entitas atau lebih sama persis, pilih entitas yang memiliki skor keyakinan yang lebih tinggi.3. Jika skor entitas identik, kembalikan semua entitas yang masih ada setelah menerapkan aturan sebelumnya. 3 Jika ada tumpang tindih parsial (seperti di Hello Text Analytics) ikuti langkah-langkah di atas mulai dari 1.

Nama	Jenis	Nilai default	Deskripsi
policyKind	string: matchLongest	matchLongest	Jenis objek OverlapPolicy entitas.

MetadataKind

Enumeration

Jenis objek Metadata entitas.

Nilai	Deskripsi
AgeMetadata	Metadata untuk nilai terkait usia.
AreaMetadata	Metadata untuk nilai terkait area.
CurrencyMetadata	Metadata untuk nilai terkait mata uang.
DateMetadata	Metadata untuk nilai terkait tanggal.
DateTimeMetadata	Metadata untuk nilai tanggal dan waktu terkait.
InformationMetadata	Metadata untuk nilai terkait informasi.
LengthMetadata	Metadata untuk nilai terkait panjang.
NumberMetadata	Metadata untuk nilai numerik.
NumericRangeMetadata	Metadata untuk nilai rentang numerik.
OrdinalMetadata	Metadata untuk angka ordinal.
SpeedMetadata	Metadata untuk nilai terkait kecepatan.
TemperatureMetadata	Metadata untuk nilai terkait suhu.
TemporalSetMetadata	Metadata untuk sekumpulan nilai terkait waktu.
TemporalSpanMetadata	Metadata untuk nilai rentang temporal.
TimeMetadata	Metadata untuk nilai terkait waktu.
VolumeMetadata	Metadata untuk nilai terkait volume.
WeightMetadata	Metadata untuk nilai terkait bobot.

MultiLanguageAnalysisInput

Objek

Kumpulan dokumen input yang akan dianalisis oleh layanan.

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

MultiLanguageInput

Objek

Berisi dokumen input yang akan dianalisis oleh layanan.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi dokumen unik dan 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. (Mengikuti 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.

NumberKind

Enumeration

Jenis entitas angka yang diekstrak.

Nilai	Deskripsi
Decimal	Angka desimal
Fraction	Nomor pecahan
Integer	Nomor bilangan bulat
Percent	Angka persen
Power	Nomor daya
Unspecified	Jenis nomor yang tidak ditentukan

NumberMetadata

Objek

Metadata untuk instans entitas numerik.

Nama	Jenis	Deskripsi
metadataKind	string: NumberMetadata	Jenis objek Metadata entitas.
numberKind	NumberKind	Jenis jenis angka.
value	number (double)	Representasi numerik dari apa yang diekstrak teks menunjukkan.

NumericRangeMetadata

Objek

mewakili Metadata interval numerik.

Nama	Jenis	Deskripsi
maximum	number (double)	Nilai akhir interval.
metadataKind	string: NumericRangeMetadata	Jenis objek Metadata entitas.
minimum	number (double)	Nilai awal interval.
rangeInclusivity	RangeInclusivity	Inklusifnya rentang ini.
rangeKind	RangeKind	Jenis rentang numerik yang didukung - seperti Angka, Kecepatan, dll.

OrdinalMetadata

Objek

Metadata untuk instans entitas numerik.

Nama	Jenis	Deskripsi
metadataKind	string: OrdinalMetadata	Jenis objek Metadata entitas.
offset	string	Offset sehubungan dengan referensi (misalnya, offset = -1 menunjukkan yang kedua hingga terakhir)
relativeTo	RelativeTo	Titik referensi yang ditunjukkan oleh angka ordinal.
value	string	Ekspresi aritmatika sederhana yang dilambangkan oleh ordinal.

PiiCategory

Enumeration

(Opsional) menjelaskan kategori PII yang akan dikembalikan

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

PiiDomain

Enumeration

Domain untuk tugas PII

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

PiiEntitiesDocumentResult

Objek

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

Objek

Berisi PiiResult.

Nama	Jenis	Deskripsi
documents	PiiEntitiesDocumentResult[]	Respons berdasarkan 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

Objek

Parameter yang didukung untuk tugas Pengenalan Entitas PII.

Nama	Jenis	Nilai default	Deskripsi
domain	PiiDomain	none	Domain untuk tugas PII
loggingOptOut	boolean	True	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

Objek

Berisi teks analisis tugas PIIEntityRecognition LRO.

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

RangeInclusivity

Enumeration

Inklusifitas rentang properti ini.

Nilai	Deskripsi
LeftInclusive	Sisi kiri inklusif
LeftRightInclusive	Kedua sisi inklusif
NoneInclusive	Tidak ada inklusivitas
RightInclusive	Sisi kanan inklusif

RangeKind

Enumeration

Jenis entitas rentang angka.

Nilai	Deskripsi
Age	Rentang usia
Area	Rentang area
Currency	Rentang mata uang
Information	Rentang informasi
Length	Rentang panjang
Number	Rentang angka
Speed	Rentang kecepatan
Temperature	Rentang suhu
Volume	Rentang volume
Weight	Rentang berat

RelativeTo

Enumeration

Titik referensi yang ditunjukkan oleh angka ordinal.

Nilai	Deskripsi
Current	Status atau posisi saat ini
End	Status akhir atau posisi
Start	Mulai status atau posisi

RequestStatistics

Objek

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

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

ScriptCode

Enumeration

Mengidentifikasi skrip dokumen input. Memetakan ke kode skrip standar ISO 15924.

Nilai	Deskripsi
Arab	Kode skrip untuk skrip Arab.
Armn	Kode skrip untuk skrip Armenia.
Beng	Kode skrip untuk skrip Bangla.
Cans	Kode skrip untuk skrip UnifiedCanadianAboriginalSyllabics.
Cyrl	Kode skrip untuk skrip Sirilik.
Deva	Kode skrip untuk skrip Devanagari.
Ethi	Kode skrip untuk skrip Ethiopic.
Geor	Kode skrip untuk skrip Georgian.
Grek	Kode skrip untuk skrip Yunani.
Gujr	Kode skrip untuk skrip Gujarati.
Guru	Kode skrip untuk skrip Gurmukhi.
Hang	Kode skrip untuk skrip Hangul.
Hani	Kode skrip untuk skrip HanLiteral.
Hans	Kode skrip untuk skrip HanSimplified.
Hant	Kode skrip untuk skrip HanTraditional.
Hebr	Kode skrip untuk skrip Ibrani.
Jpan	Kode skrip untuk skrip Jepang.
Khmr	Kode skrip untuk skrip Khmer.
Knda	Kode skrip untuk skrip Kannada.
Laoo	Kode skrip untuk skrip Lao.
Latn	Kode skrip untuk skrip Latin.
Mlym	Kode skrip untuk skrip Malayalam.
Mong	Kode skrip untuk skrip Mongolia.
Mtei	Kode skrip untuk skrip Meitei.
Mymr	Kode skrip untuk skrip Myanmar.
Olck	Kode skrip untuk skrip Santali.
Orya	Kode skrip untuk skrip Odia.
Shrd	Kode skrip untuk skrip Sharada.
Sinh	Kode skrip untuk skrip Sinhala.
Taml	Kode skrip untuk skrip Tamil.
Telu	Kode skrip untuk skrip Telugu.
Thaa	Kode skrip untuk skrip Thaana.
Thai	Kode skrip untuk skrip Thailand.
Tibt	Kode skrip untuk skrip Tibet.

ScriptKind

Enumeration

Mengidentifikasi skrip dokumen input. Memetakan ke nama formal standar ISO 15924.

Nilai	Deskripsi
Arabic	Nama skrip untuk skrip Arab.
Armenian	Nama skrip untuk skrip Armenia.
Bangla	Nama skrip untuk skrip Bangla.
Cyrillic	Nama skrip untuk skrip Sirilik.
Devanagari	Nama skrip untuk skrip Devanagari.
Ethiopic	Nama skrip untuk skrip Ethiopic.
Georgian	Nama skrip untuk skrip Georgian.
Greek	Nama skrip untuk skrip Yunani.
Gujarati	Nama skrip untuk skrip Gujarati.
Gurmukhi	Nama skrip untuk skrip Gurmukhi.
HanLiteral	Nama skrip untuk skrip HanLiteral.
HanSimplified	Nama skrip untuk skrip HanSimplified.
HanTraditional	Nama skrip untuk skrip HanTraditional.
Hangul	Nama skrip untuk skrip Hangul.
Hebrew	Nama skrip untuk skrip Ibrani.
Japanese	Nama skrip untuk skrip Jepang.
Kannada	Nama skrip untuk skrip Kannada.
Khmer	Nama skrip untuk skrip Khmer.
Lao	Nama skrip untuk skrip Lao.
Latin	Nama skrip untuk skrip Latin.
Malayalam	Nama skrip untuk skrip Malayalam.
Meitei	Nama skrip untuk skrip Meitei.
Mongolian	Nama skrip untuk skrip Mongolia.
Myanmar	Nama skrip untuk skrip Myanmar.
Odia	Nama skrip untuk skrip Odia.
Santali	Nama skrip untuk skrip Santali.
Sharada	Nama skrip untuk skrip Sharada.
Sinhala	Nama skrip untuk skrip Sinhala.
Tamil	Nama skrip untuk skrip Tamil.
Telugu	Nama skrip untuk skrip Telugu.
Thaana	Nama skrip untuk skrip Thaana.
Thai	Nama skrip untuk skrip Thailand.
Tibetan	Nama skrip untuk skrip Tibet.
UnifiedCanadianAboriginalSyllabics	Nama skrip untuk skrip UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

Objek

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 (int32)	Panjang target.
offset	integer (int32)	Offset target dari awal kalimat.
sentiment	TokenSentimentValue	Sentimen kalimat.
text	string	Teks target terdeteksi.

SentenceSentiment

Objek

Sentimen kalimat dokumen.

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

SentenceSentimentValue

Enumeration

Sentimen yang diprediksi untuk kalimat tersebut.

Nilai	Deskripsi
negative	Sentimen negatif
neutral	Sentimen netral
positive	Sentimen positif

SentenceTarget

Objek

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 (int32)	Panjang target.
offset	integer (int32)	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

Objek

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

Objek

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

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

SentimentDocumentResult

Objek

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[]	Sentimen kalimat dokumen.
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

Objek

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

Objek

Berisi teks analisis hasil tugas LRO SentimentAnalysis.

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

SpeedMetadata

Objek

Mewakili model Metadata entitas Kecepatan.

Nama	Jenis	Deskripsi
metadataKind	string: SpeedMetadata	Jenis objek Metadata entitas.
unit	SpeedUnit	Satuan ukuran untuk kecepatan.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

SpeedUnit

Enumeration

Unit kecepatan pengukuran

Nilai	Deskripsi
CentimetersPerMillisecond	Unit kecepatan dalam sentimeter per milidetik.
FeetPerMinute	Unit kecepatan dalam satuan kaki per menit.
FeetPerSecond	Unit kecepatan dalam satuan kaki per detik.
KilometersPerHour	Unit kecepatan dalam kilometer per jam.
KilometersPerMillisecond	Unit kecepatan dalam Kilometer per milidetik.
KilometersPerMinute	Unit kecepatan dalam kilometer per menit.
KilometersPerSecond	Unit kecepatan dalam kilometer per detik.
Knots	Unit kecepatan dalam simpul.
MetersPerMillisecond	Unit kecepatan dalam meter per milidetik.
MetersPerSecond	Unit kecepatan dalam meter per detik.
MilesPerHour	Unit kecepatan dalam mil per jam.
Unspecified	Unit kecepatan yang tidak ditentukan.
YardsPerMinute	Unit kecepatan dalam satuan yard per menit.
YardsPerSecond	Unit kecepatan dalam yard per detik.

StringIndexType

Enumeration

Jenis indeks string

Nilai	Deskripsi
TextElements_v8	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	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	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

Objek

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

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

TargetRelation

Objek

Mewakili hubungan antara penilaian dan/atau target.

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

TargetRelationType

Enumeration

Jenis yang terkait dengan target.

Nilai	Deskripsi
assessment	Hubungan penilaian.
target	Hubungan target.

TemperatureMetadata

Objek

Mewakili model Metadata entitas Informasi.

Nama	Jenis	Deskripsi
metadataKind	string: TemperatureMetadata	Jenis objek Metadata entitas.
unit	TemperatureUnit	Satuan ukuran untuk suhu.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

TemperatureUnit

Enumeration

Satuan pengukuran suhu.

Nilai	Deskripsi
Celsius	Unit suhu di Celcius
Fahrenheit	Unit suhu di Fahrenheit
Kelvin	Unit suhu di Kelvin
Rankine	Unit suhu di Rankine
Unspecified	Unit suhu yang tidak ditentukan

TemporalModifier

Enumeration

Pengubah opsional instans tanggal/waktu.

Nilai	Deskripsi
After	Setelah waktu tertentu
AfterApprox	Setelah perkiraan waktu
AfterMid	Setelah pertengahan periode waktu
AfterStart	Setelah awal periode waktu
Approx	Kira-kira pada waktu tertentu
Before	Sebelum waktu tertentu
BeforeApprox	Sebelum perkiraan waktu
BeforeEnd	Sebelum akhir periode waktu
BeforeStart	Sebelum dimulainya periode waktu
End	Pada akhir periode waktu
Less	Kurang dari waktu tertentu
Mid	Di pertengahan periode waktu
More	Lebih dari waktu tertentu
ReferenceUndefined	Referensi ke waktu yang tidak ditentukan
Since	Sejak waktu tertentu
SinceEnd	Sejak akhir periode waktu
Start	Pada awal periode waktu
Until	Hingga waktu tertentu

TemporalSetMetadata

Objek

Metadata untuk instans entitas set temporal.

Nama	Jenis	Deskripsi
dateValues	DateValue[]	Daftar nilai tanggal.
metadataKind	string: TemporalSetMetadata	Jenis objek Metadata entitas.

TemporalSpanMetadata

Objek

mewakili Metadata rentang tanggal dan/atau waktu.

Nama	Jenis	Deskripsi
metadataKind	string: TemporalSpanMetadata	Jenis objek Metadata entitas.
spanValues	TemporalSpanValues[]	Daftar rentang temporal terdeteksi.

TemporalSpanValues

Objek

Objek rentang temporal.

Nama	Jenis	Deskripsi
begin	string	Nilai awal untuk rentang.
duration	string	Nilai durasi opsional yang diformat berdasarkan ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Nilai akhir untuk rentang.
modifier	TemporalModifier	Pengubah untuk tanggalwaktu untuk menunjukkan titik referensi seperti sebelumnya, setelah dll.
timex	string	Triplet opsional yang berisi awal, akhir, dan durasi semuanya dinyatakan sebagai string berformat ISO 8601.

TimeMetadata

Objek

Metadata untuk instans entitas waktu.

Nama	Jenis	Deskripsi
dateValues	DateValue[]	Daftar nilai tanggal.
metadataKind	string: TimeMetadata	Jenis objek Metadata entitas.

TokenSentimentValue

Enumeration

Sentimen yang diprediksi untuk kalimat tersebut.

Nilai	Deskripsi
mixed	Sentimen campuran
negative	Sentimen negatif
positive	Sentimen positif

VolumeMetadata

Objek

Mewakili model Metadata entitas volume.

Nama	Jenis	Deskripsi
metadataKind	string: VolumeMetadata	Jenis objek Metadata entitas.
unit	VolumeUnit	Satuan ukuran untuk volume.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

VolumeUnit

Enumeration

Unit Volume pengukuran

Nilai	Deskripsi
Barrel	Unit volume dalam barel.
Bushel	Unit volume di bushels.
Centiliter	Unit volume di sentiliter.
Cord	Unit volume dalam kabel.
CubicCentimeter	Unit volume dalam sentimeter kubik.
CubicFoot	Unit volume dalam kaki kubik.
CubicInch	Unit volume dalam inci kubik.
CubicMeter	Unit volume dalam meter kubik.
CubicMile	Unit volume dalam mil kubik.
CubicMillimeter	Unit volume dalam milimeter kubik.
CubicYard	Unit volume dalam halaman kubik.
Cup	Unit volume dalam cangkir.
Decaliter	Unit volume dalam decaliter.
FluidDram	Unit volume dalam dram cairan.
FluidOunce	Unit volume dalam ons cairan.
Gill	Unit volume dalam insang.
Hectoliter	Unit volume dalam hektoliter.
Hogshead	Unit volume di hogsheads.
Liter	Unit volume dalam liter.
Milliliter	Unit volume dalam mililiter.
Minim	Unit volume dalam minim.
Peck	Unit volume dalam mematuk.
Pinch	Unit volume dalam mencubit.
Pint	Unit volume dalam pint.
Quart	Unit volume dalam quart.
Tablespoon	Unit volume dalam sendok tabel.
Teaspoon	Unit volume dalam sendok teh.
Unspecified	Unit volume yang tidak ditentukan.

WarningCodeValue

Enumeration

Menentukan daftar kode peringatan.

Nilai	Deskripsi
DocumentTruncated	Peringatan terpotong dokumen
LongWordsInDocument	Kata-kata panjang dalam peringatan dokumen

WeightMetadata

Objek

Mewakili model Metadata entitas Bobot).

Nama	Jenis	Deskripsi
metadataKind	string: WeightMetadata	Jenis objek Metadata entitas.
unit	WeightUnit	Satuan ukuran untuk berat.
value	number (double)	Nilai numerik yang diekstrak teks menunjukkan.

WeightUnit

Enumeration

Unit pengukuran berat.

Nilai	Deskripsi
Dram	Unit berat dalam dram
Gallon	Unit volume dalam galon
Grain	Unit berat dalam biji-bijian
Gram	Unit berat dalam gram
Kilogram	Unit berat dalam kilogram
LongTonBritish	Unit berat dalam ton panjang (Inggris)
MetricTon	Unit berat dalam metrik ton
Milligram	Unit berat dalam miligram
Ounce	Unit berat dalam ons
PennyWeight	Unit berat dalam pennyweights
Pound	Unit berat dalam pound
ShortHundredWeightUS	Unit berat dalam seratus kelas pendek (AS)
ShortTonUS	Unit berat dalam ton pendek (AS)
Stone	Unit berat dalam batu
Ton	Unit berat dalam ton
Unspecified	Unit berat yang tidak ditentukan