Text Analysis Runtime - Analyze Text

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-01

Zażądaj analizy tekstu w kolekcji dokumentów.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
showStats	query		boolean	(Opcjonalnie) jeśli ustawiono wartość true, odpowiedź będzie zawierać statystyki na poziomie żądania i dokumentu.

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa	Opis
AnalyzeTextEntityLinkingInput	Zawiera dane wejściowe linku do jednostki analizującej tekst.
AnalyzeTextEntityRecognitionInput	Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.
AnalyzeTextKeyPhraseExtractionInput	Zawiera dane wejściowe zadania analizy KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.
AnalyzeTextPiiEntitiesRecognitionInput	Zawiera dane wejściowe zadania analizy PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Zawiera dane wejściowe zadania Analizy tonacji tekstu.

AnalyzeTextEntityLinkingInput

Zawiera dane wejściowe linku do jednostki analizującej tekst.

Nazwa	Wymagane	Typ	Opis
kind	True	string: EntityLinking	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dane wejściowe analizy, które mają być obsługiwane przez usługę.
parameters		EntityLinkingTaskParameters	Parametry zadania.

AnalyzeTextEntityRecognitionInput

Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.

Nazwa	Wymagane	Typ	Opis
kind	True	string: EntityRecognition	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Dane wejściowe do przeanalizowania.
parameters		EntitiesTaskParameters	Parametry zadania.

AnalyzeTextKeyPhraseExtractionInput

Zawiera dane wejściowe zadania analizy KeyPhraseExtraction.

Nazwa	Wymagane	Typ	Opis
kind	True	string: KeyPhraseExtraction	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
parameters		KeyPhraseTaskParameters	Parametry zadania wyodrębniania kluczowych fraz.

AnalyzeTextLanguageDetectionInput

Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.

Nazwa	Wymagane	Typ	Opis
kind	True	string: LanguageDetection	Rodzaj zadania do wykonania.
analysisInput		LanguageDetectionAnalysisInput	Dokumenty do przeanalizowania.
parameters		LanguageDetectionTaskParameters	parametry zadania.

AnalyzeTextPiiEntitiesRecognitionInput

Zawiera dane wejściowe zadania analizy PIIEntityRecognition.

Nazwa	Wymagane	Typ	Opis
kind	True	string: PiiEntityRecognition	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
parameters		PiiTaskParameters	Parametry zadania pii.

AnalyzeTextSentimentAnalysisInput

Zawiera dane wejściowe zadania Analizy tonacji tekstu.

Nazwa	Wymagane	Typ	Opis
kind	True	string: SentimentAnalysis	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
parameters		SentimentAnalysisTaskParameters	Parametry zadania Analiza tonacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
AgeMetadata	Reprezentuje model metadanych jednostki Wiek.
AgeUnit	Jednostka wieku miary
AllowOverlapEntityPolicyType	Reprezentuje zasady zezwalania na nakładanie się. Nie będzie stosować logiki przetwarzania końcowego dla jednostek. Niezależnie od tego, co przewiduje model, zostanie zwrócony użytkownikowi. Dzięki temu użytkownik może uzyskać pełny widok możliwych wartości każdego modelu i zastosować własną logikę niestandardową do wyboru jednostki
AnalyzeTextEntityLinkingInput	Zawiera dane wejściowe linku do jednostki analizującej tekst.
AnalyzeTextEntityRecognitionInput	Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.
AnalyzeTextKeyPhraseExtractionInput	Zawiera dane wejściowe zadania analizy KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.
AnalyzeTextPiiEntitiesRecognitionInput	Zawiera dane wejściowe zadania analizy PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Zawiera dane wejściowe zadania Analizy tonacji tekstu.
AnalyzeTextTaskKind	Rodzaj obsługiwanych zadań analizy tekstu.
AnalyzeTextTaskResultsKind	Rodzaj obiektu odpowiedzi zwróconego przez zadanie analizuj-tekst.
AreaMetadata	Reprezentuje model metadanych jednostki Obszar.
AreaUnit	Jednostka powierzchni miary.
CurrencyMetadata	Reprezentuje model metadanych jednostki Waluta ).
DateMetadata	Metadane dla wystąpień jednostek daty.
DateTimeMetadata	Metadane dla wystąpień jednostki typu data/godzina.
DateValue	Reprezentuje wartość daty.
DetectedLanguage	Zawiera szczegóły wykrytego języka tekstu.
DocumentError	Zawiera szczegółowe informacje o błędach napotkanych podczas wykonywania zadania.
DocumentSentimentValue	Przewidywana tonacja dokumentu (negatywna, neutralna, dodatnia lub mieszana).
DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
DocumentWarning	Zawiera obiekt ostrzeżeń z ostrzeżeniami napotkanymi dla przetworzonego dokumentu.
EntitiesDocumentResultWithMetadata	Wynik dokumentów jednostki z metadanymi.
EntitiesResult	Zawiera wynik zadania rozpoznawania jednostek.
EntitiesTaskParameters	Obsługiwane parametry zadania rozpoznawania jednostek.
EntitiesTaskResult	Zawiera zadanie jednostki
Entity	Definiuje wykryty obiekt jednostki zawierający wykryty tekst kategorii jednostki i jednostki itp.
EntityCategory	Zawiera wszystkie kategorie jednostek wykryte przez rozpoznawanie jednostek.
EntityInferenceOptions	Klasa, która mieści opcje wnioskowania dozwolone dla rozpoznawania nazwanych jednostek.
EntityLinkingResult	Wynik łączenia jednostek.
EntityLinkingTaskParameters	Obsługiwane parametry zadania Entity Linking.
EntityLinkingTaskResult	Zawiera wynik zadania analizowania jednostki łączącej jednostki.
EntityTag	Obiekt tagu jednostki, który zawiera nazwę tagów abd wszelkie skojarzone współczynnik ufności. Tagi jednostek służą do wyrażania niektórych podobieństw/koligacji między jednostkami.
EntityWithMetadata	Obiekt jednostki z tagami i metadanymi.
Error	Obiekt odpowiedzi o błędzie zwracany, gdy usługa napotka pewne błędy podczas przetwarzania żądania.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InformationMetadata	Reprezentuje model metadanych jednostki Informacje (dane).
InformationUnit	Jednostka miary informacji (danych).
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Zawiera wartość KeyPhraseResult.
KeyPhrasesDocumentResult	Zawiera wyniki wyodrębniania kluczowych fraz dla dokumentu.
KeyPhraseTaskParameters	Obsługiwane parametry zadania wyodrębniania kluczowych fraz.
KeyPhraseTaskResult	Zawiera wynik zadania analizy KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Zawiera dane wejściowe analizy dokumentów wykrywania języka.
LanguageDetectionDocumentResult	Zawiera wykrywanie języka dla dokumentu.
LanguageDetectionResult	Zawiera wynik wykrywania języka dla żądania.
LanguageDetectionTaskParameters	Obsługiwane parametry zadania wykrywania języka.
LanguageDetectionTaskResult	Zawiera wynik zadania wykrywania języka dla żądania.
LanguageInput	Zawiera dane wejściowe wykrywania języka.
LengthMetadata	Reprezentuje model metadanych jednostki Length.
LengthUnit	Jednostka długości miary.
LinkedEntitiesDocumentResult	Wynik dokumentu łączenia jednostek.
LinkedEntity	Obiekt LinkedEntity zawierający wykrytą jednostkę ze skojarzonymi źródłami/łączami.
Match	Obiekt Match zawierający wykryty tekst jednostki z przesunięciem i długością.
MatchLongestEntityPolicyType	Reprezentuje najdłuższe nakładające się zasady dopasowania. Nie nakładające się jednostki tak daleko, jak to możliwe. 1. Jeśli występują nakładające się jednostki, zostanie zwrócony najdłuższy. 2. Jeśli zestaw znaków przewidywanych dla co najmniej 2 jednostek jest dokładnie taki sam, wybierz jednostkę, która ma wyższy współczynnik ufności.3. Jeśli wyniki jednostki są identyczne, zwróć wszystkie jednostki, które są nadal obecne po zastosowaniu poprzednich reguł. 3. W przypadku częściowego nakładania się (tak jak w analizie tekstu hello) wykonaj powyższe kroki rozpoczynające się od 1.
MetadataKind	Rodzaj obiektu Metadane jednostki.
MultiLanguageAnalysisInput	Kolekcja dokumentów wejściowych, które mają być analizowane przez usługę.
MultiLanguageInput	Zawiera dokument wejściowy do przeanalizowania przez usługę.
NumberKind	Typ wyodrębnionej jednostki liczbowej.
NumberMetadata	Metadane dla wystąpień jednostek liczbowych.
NumericRangeMetadata	reprezentuje metadane interwałów liczbowych.
OrdinalMetadata	Metadane dla wystąpień jednostek liczbowych.
PiiCategory	(Opcjonalnie) opisuje kategorie pii do zwrócenia
PiiDomain	Domena dla zadania pii
PiiEntitiesDocumentResult	Zawiera wyniki danych pii.
PiiResult	Zawiera element PiiResult.
PiiTaskParameters	Obsługiwane parametry zadania rozpoznawania jednostek PII.
PiiTaskResult	Zawiera zadanie LRO analizy tekstu PIIEntityRecognition.
RangeInclusivity	Zakres inkluzywności tej właściwości.
RangeKind	Rodzaj jednostki zakresu liczb.
RelativeTo	Punkt odniesienia oznaczający liczbę porządkową.
RequestStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.
ScriptCode	Identyfikuje skrypt dokumentu wejściowego. Mapuje na standardowy kod skryptu ISO 15924.
ScriptKind	Identyfikuje skrypt dokumentu wejściowego. Mapuje standardową nazwę standardową ISO 15924.
SentenceAssessment	Reprezentuje ocenę zdania oraz powiązane z nią oceny lub obiekty docelowe.
SentenceSentiment	Tonacja zdań dokumentu.
SentenceSentimentValue	Przewidywana tonacja dla zdania.
SentenceTarget	Reprezentuje element docelowy zdania oraz oceny lub obiekty docelowe powiązane z nim.
SentimentAnalysisTaskParameters	Obsługiwane parametry zadania Analiza tonacji.
SentimentConfidenceScores	Reprezentuje wyniki ufności z zakresu od 0 do 1 we wszystkich klasach tonacji: dodatnie, neutralne, ujemne.
SentimentDocumentResult	Obiekt reprezentujący wstępnie utworzone wyniki analizy tonacji każdego dokumentu.
SentimentResponse	Wyniki analizy tonacji dla dokumentów wejściowych.
SentimentTaskResult	Zawiera wynik zadania LRO analizy tekstu SentimentAnalysis.
SpeedMetadata	Reprezentuje model metadanych jednostki Speed.
SpeedUnit	Jednostka prędkości miary
StringIndexType	Typ indeksu ciągu
TargetConfidenceScoreLabel	Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.
TargetRelation	Reprezentuje relację między ocenami i/lub celami.
TargetRelationType	Typ powiązany z obiektem docelowym.
TemperatureMetadata	Reprezentuje model metadanych jednostki informacyjnej.
TemperatureUnit	Jednostka temperatury miary.
TemporalModifier	Opcjonalny modyfikator wystąpienia daty/godziny.
TemporalSetMetadata	Metadane dla wystąpień jednostki zestawu czasowego.
TemporalSpanMetadata	reprezentuje metadane zakresu daty i/lub godziny.
TemporalSpanValues	Obiekt zakresu czasowego.
TimeMetadata	Metadane dla wystąpień jednostek czasu.
TokenSentimentValue	Przewidywana tonacja dla zdania.
VolumeMetadata	Reprezentuje model metadanych jednostki woluminu.
VolumeUnit	Jednostka miary objętości
WarningCodeValue	Definiuje listę kodów ostrzegawczych.
WeightMetadata	Reprezentuje model metadanych jednostki Waga ).
WeightUnit	Jednostka wagi miary.

AgeMetadata

Objekt

Reprezentuje model metadanych jednostki Wiek.

Nazwa	Typ	Opis
metadataKind	string: AgeMetadata	Rodzaj obiektu Metadane jednostki.
unit	AgeUnit	Jednostka miary dla wieku.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

AgeUnit

Wyliczanie

Jednostka wieku miary

Wartość	Opis
Day	Okres dnia
Month	Okres miesiąca
Unspecified	Nieokreślony okres
Week	Okres tygodnia
Year	Okres roku

AllowOverlapEntityPolicyType

Objekt

Reprezentuje zasady zezwalania na nakładanie się. Nie będzie stosować logiki przetwarzania końcowego dla jednostek. Niezależnie od tego, co przewiduje model, zostanie zwrócony użytkownikowi. Dzięki temu użytkownik może uzyskać pełny widok możliwych wartości każdego modelu i zastosować własną logikę niestandardową do wyboru jednostki

Nazwa	Typ	Domyślna wartość	Opis
policyKind	string: allowOverlap	matchLongest	Typ obiektu OverlapPolicy jednostki.

AnalyzeTextEntityLinkingInput

Objekt

Zawiera dane wejściowe linku do jednostki analizującej tekst.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dane wejściowe analizy, które mają być obsługiwane przez usługę.
kind	string: EntityLinking	Rodzaj zadania do wykonania.
parameters	EntityLinkingTaskParameters	Parametry zadania.

AnalyzeTextEntityRecognitionInput

Objekt

Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Dane wejściowe do przeanalizowania.
kind	string: EntityRecognition	Rodzaj zadania do wykonania.
parameters	EntitiesTaskParameters	Parametry zadania.

AnalyzeTextKeyPhraseExtractionInput

Objekt

Zawiera dane wejściowe zadania analizy KeyPhraseExtraction.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
kind	string: KeyPhraseExtraction	Rodzaj zadania do wykonania.
parameters	KeyPhraseTaskParameters	Parametry zadania wyodrębniania kluczowych fraz.

AnalyzeTextLanguageDetectionInput

Objekt

Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.

Nazwa	Typ	Opis
analysisInput	LanguageDetectionAnalysisInput	Dokumenty do przeanalizowania.
kind	string: LanguageDetection	Rodzaj zadania do wykonania.
parameters	LanguageDetectionTaskParameters	parametry zadania.

AnalyzeTextPiiEntitiesRecognitionInput

Objekt

Zawiera dane wejściowe zadania analizy PIIEntityRecognition.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
kind	string: PiiEntityRecognition	Rodzaj zadania do wykonania.
parameters	PiiTaskParameters	Parametry zadania pii.

AnalyzeTextSentimentAnalysisInput

Objekt

Zawiera dane wejściowe zadania Analizy tonacji tekstu.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
kind	string: SentimentAnalysis	Rodzaj zadania do wykonania.
parameters	SentimentAnalysisTaskParameters	Parametry zadania Analiza tonacji.

AnalyzeTextTaskKind

Wyliczanie

Rodzaj obsługiwanych zadań analizy tekstu.

Wartość	Opis
EntityLinking	Zadanie łączenia jednostek
EntityRecognition	Zadanie rozpoznawania jednostek
KeyPhraseExtraction	Zadanie wyodrębniania kluczowych fraz
LanguageDetection	Zadanie wykrywania języka
PiiEntityRecognition	Zadanie rozpoznawania jednostek PII
SentimentAnalysis	Zadanie analizy tonacji

AnalyzeTextTaskResultsKind

Wyliczanie

Rodzaj obiektu odpowiedzi zwróconego przez zadanie analizuj-tekst.

Wartość	Opis
EntityLinkingResults	Wyniki łączenia jednostek
EntityRecognitionResults	Wyniki rozpoznawania jednostek
KeyPhraseExtractionResults	Wyniki wyodrębniania kluczowych fraz
LanguageDetectionResults	Wyniki wykrywania języka
PiiEntityRecognitionResults	Wyniki rozpoznawania jednostek PII
SentimentAnalysisResults	Wyniki analizy tonacji

AreaMetadata

Objekt

Reprezentuje model metadanych jednostki Obszar.

Nazwa	Typ	Opis
metadataKind	string: AreaMetadata	Rodzaj obiektu Metadane jednostki.
unit	AreaUnit	Jednostka miary dla obszaru.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

AreaUnit

Wyliczanie

Jednostka powierzchni miary.

Wartość	Opis
Acre	Jednostka obszaru w akrach
SquareCentimeter	Jednostka powierzchni w centymetrach kwadratowych
SquareDecameter	Jednostka obszaru w dekametrach kwadratowych
SquareDecimeter	Jednostka obszaru w decymetrach kwadratowych
SquareFoot	Jednostka powierzchni w stopach kwadratowych
SquareHectometer	Jednostka powierzchniowa w hektometrach kwadratowych
SquareInch	Jednostka powierzchniowa w calach kwadratowych
SquareKilometer	Jednostka obszaru w kilometrach kwadratowych
SquareMeter	Jednostka powierzchni w metrach kwadratowych
SquareMile	Jednostka obszaru w milach kwadratowych
SquareMillimeter	Jednostka powierzchniowa w milimetrach kwadratowych
SquareYard	Jednostka powierzchni w jardach kwadratowych
Unspecified	Nieokreślona jednostka obszaru

CurrencyMetadata

Objekt

Reprezentuje model metadanych jednostki Waluta ).

Nazwa	Typ	Opis
iso4217	string	Kod alfabetyczny oparty na innym standardzie ISO ISO 3166, który zawiera listę kodów nazw krajów. Pierwsze dwie litery trzyliterowego kodu ISO 4217 są takie same jak kod nazwy kraju, a w miarę możliwości trzecia litera odpowiada pierwszej literze nazwy waluty.
metadataKind	string: CurrencyMetadata	Rodzaj obiektu Metadane jednostki.
unit	string	Jednostka waluty.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

DateMetadata

Objekt

Metadane dla wystąpień jednostek daty.

Nazwa	Typ	Opis
dateValues	DateValue[]	Lista wartości daty.
metadataKind	string: DateMetadata	Rodzaj obiektu Metadane jednostki.

DateTimeMetadata

Objekt

Metadane dla wystąpień jednostki typu data/godzina.

Nazwa	Typ	Opis
dateValues	DateValue[]	Lista wartości daty.
metadataKind	string: DateTimeMetadata	Rodzaj obiektu Metadane jednostki.

DateValue

Objekt

Reprezentuje wartość daty.

Nazwa	Typ	Opis
modifier	TemporalModifier	Modyfikator daty/godziny, aby wskazać punkt odniesienia, taki jak przed, po itp.
timex	string	Rozszerzona reprezentacja daty/godziny ISO 8601 zgodnie z opisem w artykule (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Rzeczywisty czas, który oznacza wyodrębniony tekst.

DetectedLanguage

Objekt

Zawiera szczegóły wykrytego języka tekstu.

Nazwa	Typ	Opis
confidenceScore	number (double)	Współczynnik ufności z zakresu od 0 do 1. Wyniki zbliżone do 1 wskazują 100% pewność, że zidentyfikowany język jest prawdziwy.
iso6391Name	string	Dwuliterowa reprezentacja wykrytego języka zgodnie ze standardem ISO 639-1 (np. en, fr).
name	string	Długa nazwa wykrytego języka (np. angielski, francuski).
scriptIso15924Code	ScriptCode	Identyfikuje kod skryptu dokumentu wejściowego zgodnie ze standardem ISO 15924.
scriptName	ScriptKind	Identyfikuje nazwę skryptu dokumentu wejściowego zgodnie ze standardem ISO 15924.

DocumentError

Objekt

Zawiera szczegółowe informacje o błędach napotkanych podczas wykonywania zadania.

Nazwa	Typ	Opis
error	Error	Napotkano błąd.
id	string	Identyfikator dokumentu wejściowego.

DocumentSentimentValue

Wyliczanie

Przewidywana tonacja dokumentu (negatywna, neutralna, dodatnia lub mieszana).

Wartość	Opis
mixed	Instrukcja mieszana
negative	Ujemna instrukcja
neutral	Instrukcja neutralna
positive	Instrukcja dodatnia

DocumentStatistics

Objekt

jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.

Nazwa	Typ	Opis
charactersCount	integer (int32)	Liczba elementów tekstowych rozpoznanych w dokumencie.
transactionsCount	integer (int32)	Liczba transakcji dla dokumentu.

DocumentWarning

Objekt

Zawiera obiekt ostrzeżeń z ostrzeżeniami napotkanymi dla przetworzonego dokumentu.

Nazwa	Typ	Opis
code	WarningCodeValue	Kod ostrzegawczy.
message	string	Komunikat ostrzegawczy.
targetRef	string	Odwołanie do wskaźnika JSON wskazujące obiekt docelowy.

EntitiesDocumentResultWithMetadata

Objekt

Wynik dokumentów jednostki z metadanymi.

Nazwa	Typ	Opis
entities	EntityWithMetadata[]	Rozpoznane jednostki w dokumencie.
id	string	Unikatowy, niepusty identyfikator dokumentu.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Ostrzeżenia napotkane podczas przetwarzania dokumentu.

EntitiesResult

Objekt

Zawiera wynik zadania rozpoznawania jednostek.

Nazwa	Typ	Opis
documents	EntitiesDocumentResultWithMetadata[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

EntitiesTaskParameters

Objekt

Obsługiwane parametry zadania rozpoznawania jednostek.

Nazwa	Typ	Domyślna wartość	Opis
exclusionList	EntityCategory[]		(Opcjonalnie) parametr żądania, który filtruje wszystkie jednostki, które są dołączone do listy excludeList. Gdy użytkownik określi element excludeList, nie może uzyskać przewidywania zwróconego z jednostką na tej liście. Zastosujemy element inclusionList przed listą wykluczeń
inclusionList	EntityCategory[]		(Opcjonalnie) parametr żądania, który ogranicza dane wyjściowe do żądanych typów jednostek znajdujących się na tej liście. Zastosujemy element inclusionList przed listą wykluczeń
inferenceOptions	EntityInferenceOptions		(Opcjonalnie) parametr żądania, który umożliwia użytkownikowi podanie ustawień uruchamiania wnioskowania.
loggingOptOut	boolean	False	Wylogowanie z rezygnacji
modelVersion	string	latest	wersja modelu
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Opcjonalnie) opisuje typ nakładających się zasad, które mają być stosowane do danych wyjściowych modułu.
stringIndexType	StringIndexType	TextElements_v8	(Opcjonalnie) parametr umożliwiający podanie typu indeksu ciągu używanego do interpretowania przesunięć ciągów. Wartości domyślne to TextElements (Graphemes).

EntitiesTaskResult

Objekt

Zawiera zadanie jednostki

Nazwa	Typ	Opis
kind	string: EntityRecognitionResults	Rodzaj wyniku zadania.
results	EntitiesResult	Wyniki rozpoznawania jednostek.

Entity

Objekt

Definiuje wykryty obiekt jednostki zawierający wykryty tekst kategorii jednostki i jednostki itp.

Nazwa	Typ	Opis
category	string	Typ jednostki.
confidenceScore	number (double)	Współczynnik ufności z zakresu od 0 do 1 wyodrębnionej jednostki.
length	integer (int32)	Długość tekstu jednostki. Użycie różnych wartości "stringIndexType" może mieć wpływ na zwracaną długość.
offset	integer (int32)	Pozycja początkowa dla tekstu jednostki. Użycie różnych wartości "stringIndexType" może mieć wpływ na zwrócone przesunięcie.
subcategory	string	(Opcjonalnie) Typ podrzędny jednostki.
text	string	Tekst jednostki wyświetlany w żądaniu.

EntityCategory

Wyliczanie

Zawiera wszystkie kategorie jednostek wykryte przez rozpoznawanie jednostek.

Wartość	Opis
Address	Konkretne wzmianki o lokalizacjach na poziomie ulicy: numery domów/budynków, ulice, aleje, autostrady, skrzyżowania, do których odwołuje się nazwa.
Age	Wartości związane z wiekiem.
Airport	Lotniska.
Area	Obszar obiektu.
City	Wartości związane z miastem.
ComputingProduct	Produkty obliczeniowe.
Continent	Wartości związane z kontynentem.
CountryRegion	Wartości związane z krajami lub regionami.
CulturalEvent	Wartości związane z wydarzeniami kulturalnymi.
Currency	Wartości związane z walutą.
Date	Daty kalendarza.
DateRange	Zakres dat.
DateTime	Daty kalendarza z godziną.
DateTimeRange	Zakres daty i godziny.
Dimension	Wymiar pomiarów
Duration	Czas trwania.
Email	Adresy e-mail.
Event	Społeczne, sportowe, biznesowe, polityczne, edukacyjne, naturalne, historyczne, przestępcze, brutalne, prawne, wojskowe wydarzenia z upływem czasu.
GPE	Miasta, kraje/regiony, stany.
Geological	Cechy geograficzne i naturalne, takie jak rzeki, oceany i pustynie.
Height	Wysokość obiektu.
IP	adresy IP sieci.
Information	Jednostka miary dla informacji cyfrowych.
Length	Długość obiektu.
Location	Konkretny punkt lub miejsce w przestrzeni fizycznej.
NaturalEvent	Naturalne wartości związane z zdarzeniami.
Number	Liczby bez jednostki
NumberRange	Zakres liczb
Numeric	Wartości liczbowe, w tym cyfry i wyrazy liczbowe.
Ordinal	Liczby porządkowe.
Organization	Korporacje, agencje i inne grupy osób zdefiniowane przez niektóre ustalone struktury organizacyjne. Etykiety te mogą obejmować firmy, partie polityczne/ruchy, zespoły muzyczne, kluby sportowe, organy rządowe i organizacje publiczne. Narodowości lub religie nie są ORGANIZACJĄ.
OrganizationMedical	Firmy medyczne i grupy.
OrganizationSports	Organizacje związane z sportem.
OrganizationStockExchange	Grupy giełdowe.
Percentage	Wartości związane z wartościami procentowymi.
Person	Pierwsze, ostatnie i środkowe nazwy, nazwy fikcyjnych znaków i aliasów. Tytuły, takie jak "Pan". lub "Prezes", nie są uważane za część nazwanej jednostki.
PersonType	Role ludzkie sklasyfikowane przez członkostwo w grupie.
PhoneNumber	Numery telefonów (tylko numery telefonów USA i UE).
Product	Pojedyncza lub grupa komercyjnych, eksploatacyjnych obiektów, elektroniki, pojazdów, grup żywnościowych.
SetTemporal	Zestaw wartości związanych z czasem.
Skill	Możliwość, umiejętność lub wiedza specjalistyczna.
Speed	Szybkość obiektu.
SportsEvent	Wartości związane z wydarzeniami sportowymi.
State	Wartości związane z stanem.
Structural	Manmade struktury.
Temperature	Wartości związane z temperaturą.
Temporal	Elementy odnoszące się do czasu.
Time	Godziny dnia.
TimeRange	Zakres czasów.
URL	Adresy URL witryn sieci Web.
Volume	Wolumin obiektu.
Weight	Waga obiektu.

EntityInferenceOptions

Objekt

Klasa, która mieści opcje wnioskowania dozwolone dla rozpoznawania nazwanych jednostek.

Nazwa	Typ	Domyślna wartość	Opis
excludeNormalizedValues	boolean	False	Opcja dołączania/wykluczania wykrytych wartości jednostki, które mają być znormalizowane i uwzględnione w metadanych. Typy jednostek liczbowych i czasowych obsługują normalizację wartości.

EntityLinkingResult

Objekt

Wynik łączenia jednostek.

Nazwa	Typ	Opis
documents	LinkedEntitiesDocumentResult[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

EntityLinkingTaskParameters

Objekt

Obsługiwane parametry zadania Entity Linking.

Nazwa	Typ	Domyślna wartość	Opis
loggingOptOut	boolean	False	Wylogowanie z rezygnacji
modelVersion	string	latest	wersja modelu
stringIndexType	StringIndexType	TextElements_v8	Opcjonalny parametr umożliwiający podanie typu indeksu ciągu używanego do interpretowania przesunięć ciągów. Wartości domyślne to TextElements (Graphemes).

EntityLinkingTaskResult

Objekt

Zawiera wynik zadania analizowania jednostki łączącej jednostki.

Nazwa	Typ	Opis
kind	string: EntityLinkingResults	Rodzaj wyniku zadania.
results	EntityLinkingResult	Wynik łączenia jednostek.

EntityTag

Objekt

Obiekt tagu jednostki, który zawiera nazwę tagów abd wszelkie skojarzone współczynnik ufności. Tagi jednostek służą do wyrażania niektórych podobieństw/koligacji między jednostkami.

Nazwa	Typ	Opis
confidenceScore	number (double)	Wynik wykrywania z zakresu od 0 do 1 wyodrębnionej jednostki.
name	string	Nazwa tagu. Nazwy tagów jednostek będą unikatowe globalnie.

EntityWithMetadata

Objekt

Obiekt jednostki z tagami i metadanymi.

Nazwa	Typ	Opis
category	string	Typ jednostki.
confidenceScore	number (double)	Współczynnik ufności z zakresu od 0 do 1 wyodrębnionej jednostki.
length	integer (int32)	Długość tekstu jednostki. Użycie różnych wartości "stringIndexType" może mieć wpływ na zwracaną długość.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Obiekt metadanych jednostki.
offset	integer (int32)	Pozycja początkowa dla tekstu jednostki. Użycie różnych wartości "stringIndexType" może mieć wpływ na zwrócone przesunięcie.
subcategory	string	(Opcjonalnie) Typ podrzędny jednostki.
tags	EntityTag[]	Lista tagów jednostek. Tagi mają na celu wyrażenie niektórych podobieństw/koligacji między jednostkami.
text	string	Tekst jednostki wyświetlany w żądaniu.
type	string	Typ jednostki to najniższy (lub najlepszy) stopień szczegółowości, na którym wykryto jednostkę. Typ jest mapowany na określone atrybuty metadanych skojarzone z wykrytą jednostką.

Error

Objekt

Obiekt odpowiedzi o błędzie zwracany, gdy usługa napotka pewne błędy podczas przetwarzania żądania.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
AzureCognitiveSearchIndexLimitReached	Błąd osiągnięto limit indeksu usługi Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Nie znaleziono błędu indeksu usługi Azure Cognitive Search
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
Conflict	Błąd konfliktu
Forbidden	Błąd dostępu zabronionego
InternalServerError	Wewnętrzny błąd serwera
InvalidArgument	Błąd nieprawidłowego argumentu
InvalidRequest	Błąd nieprawidłowego żądania
NotFound	Nie znaleziono błędu
OperationNotFound	Błąd nie znaleziono operacji
ProjectNotFound	Błąd nie znaleziono projektu
QuotaExceeded	Błąd przekroczenia limitu przydziału
ServiceUnavailable	Błąd niedostępności usługi
Timeout	Błąd przekroczenia limitu czasu
TooManyRequests	Błąd zbyt wielu żądań
Unauthorized	Błąd nieautoryzowanego dostępu
Warning	Błąd ostrzeżenia

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InformationMetadata

Objekt

Reprezentuje model metadanych jednostki Informacje (dane).

Nazwa	Typ	Opis
metadataKind	string: InformationMetadata	Rodzaj obiektu Metadane jednostki.
unit	InformationUnit	Jednostka miary w celu uzyskania informacji.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

InformationUnit

Wyliczanie

Jednostka miary informacji (danych).

Wartość	Opis
Bit	Jednostka rozmiaru danych w bitach
Byte	Jednostka rozmiaru danych w bajtach
Gigabit	Jednostka rozmiaru danych w gigabitach
Gigabyte	Jednostka rozmiaru danych w gigabajtach
Kilobit	Jednostka rozmiaru danych w kilobitach
Kilobyte	Jednostka rozmiaru danych w kilobajtach
Megabit	Jednostka rozmiaru danych w megabitach
Megabyte	Jednostka rozmiaru danych w megabajtach
Petabit	Jednostka rozmiaru danych w petabitach
Petabyte	Jednostka rozmiaru danych w petabajtach
Terabit	Jednostka rozmiaru danych w terabitach
Terabyte	Jednostka rozmiaru danych w terabajtach
Unspecified	Nieokreślona jednostka rozmiaru danych

InnerErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
EmptyRequest	Błąd pustego żądania
ExtractionFailure	Błąd wyodrębniania
InvalidCountryHint	Błąd nieprawidłowej wskazówki dotyczącej kraju
InvalidDocument	Błąd nieprawidłowego dokumentu
InvalidDocumentBatch	Błąd wsadowy nieprawidłowego dokumentu
InvalidParameterValue	Błąd nieprawidłowej wartości parametru
InvalidRequest	Błąd nieprawidłowego żądania
InvalidRequestBodyFormat	Błąd nieprawidłowego formatu treści żądania
KnowledgeBaseNotFound	Nie znaleziono błędu bazy wiedzy
MissingInputDocuments	Błąd brakujących dokumentów wejściowych
ModelVersionIncorrect	Błąd nieprawidłowej wersji modelu
UnsupportedLanguageCode	Nieobsługiwany błąd kodu języka

InnerErrorModel

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

KeyPhraseResult

Objekt

Zawiera wartość KeyPhraseResult.

Nazwa	Typ	Opis
documents	KeyPhrasesDocumentResult[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

KeyPhrasesDocumentResult

Objekt

Zawiera wyniki wyodrębniania kluczowych fraz dla dokumentu.

Nazwa	Typ	Opis
id	string	Unikatowy, niepusty identyfikator dokumentu.
keyPhrases	string[]	Lista reprezentatywnych słów lub fraz. Liczba zwracanych kluczowych fraz jest proporcjonalna do liczby wyrazów w dokumencie wejściowym.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Ostrzeżenia napotkane podczas przetwarzania dokumentu.

KeyPhraseTaskParameters

Objekt

Obsługiwane parametry zadania wyodrębniania kluczowych fraz.

Nazwa	Typ	Domyślna wartość	Opis
loggingOptOut	boolean	False	Wylogowanie z rezygnacji
modelVersion	string	latest	wersja modelu

KeyPhraseTaskResult

Objekt

Zawiera wynik zadania analizy KeyPhraseExtraction.

Nazwa	Typ	Opis
kind	string: KeyPhraseExtractionResults	Rodzaj wyniku zadania.
results	KeyPhraseResult	Lista wyników wyodrębniania fraz kluczowych

LanguageDetectionAnalysisInput

Objekt

Zawiera dane wejściowe analizy dokumentów wykrywania języka.

Nazwa	Typ	Opis
documents	LanguageInput[]	Lista dokumentów do przeanalizowania.

LanguageDetectionDocumentResult

Objekt

Zawiera wykrywanie języka dla dokumentu.

Nazwa	Typ	Opis
detectedLanguage	DetectedLanguage	Wykryty język.
id	string	Unikatowy, niepusty identyfikator dokumentu.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Ostrzeżenia napotkane podczas przetwarzania dokumentu.

LanguageDetectionResult

Objekt

Zawiera wynik wykrywania języka dla żądania.

Nazwa	Typ	Opis
documents	LanguageDetectionDocumentResult[]	Wyliczanie wyników wykrywania języka dla każdego dokumentu wejściowego.
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

LanguageDetectionTaskParameters

Objekt

Obsługiwane parametry zadania wykrywania języka.

Nazwa	Typ	Domyślna wartość	Opis
loggingOptOut	boolean	False	Wylogowanie z rezygnacji
modelVersion	string	latest	wersja modelu

LanguageDetectionTaskResult

Objekt

Zawiera wynik zadania wykrywania języka dla żądania.

Nazwa	Typ	Opis
kind	string: LanguageDetectionResults	Rodzaj wyniku zadania.
results	LanguageDetectionResult	Zawiera wyniki wykrywania języka.

LanguageInput

Objekt

Zawiera dane wejściowe wykrywania języka.

Nazwa	Typ	Opis
countryHint	string	Kraj wskazówek, aby pomóc w wykrywaniu języka tekstu.
id	string	Unikatowy, niepusty identyfikator dokumentu.
text	string	Tekst wejściowy do przetworzenia.

LengthMetadata

Objekt

Reprezentuje model metadanych jednostki Length.

Nazwa	Typ	Opis
metadataKind	string: LengthMetadata	Rodzaj obiektu Metadane jednostki.
unit	LengthUnit	Jednostka miary dla długości.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

LengthUnit

Wyliczanie

Jednostka długości miary.

Wartość	Opis
Centimeter	Jednostka długości w centymetrach.
Decameter	Jednostka długości w dekametrach.
Decimeter	Jednostka długości w decymetrach.
Foot	Jednostka długości w stopach.
Hectometer	Jednostka długości w hektometrach.
Inch	Jednostka długości w calach.
Kilometer	Jednostka długości w kilometrach.
LightYear	Jednostka długości w latach świetlnych.
Meter	Jednostka długości w metrach.
Micrometer	Jednostka długości w mikrometrach.
Mile	Jednostka długości w milach.
Millimeter	Jednostka długości w milimetrach.
Nanometer	Jednostka długości w nanometrach.
Picometer	Jednostka długości w pikometrach.
Point	Jednostka długości w punktach.
Unspecified	Nieokreślona jednostka długości.
Yard	Jednostka długości w jardach.

LinkedEntitiesDocumentResult

Objekt

Wynik dokumentu łączenia jednostek.

Nazwa	Typ	Opis
entities	LinkedEntity[]	Rozpoznano dobrze znane jednostki w dokumencie.
id	string	Unikatowy, niepusty identyfikator dokumentu.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Ostrzeżenia napotkane podczas przetwarzania dokumentu.

LinkedEntity

Objekt

Obiekt LinkedEntity zawierający wykrytą jednostkę ze skojarzonymi źródłami/łączami.

Nazwa	Typ	Opis
bingId	string	Unikatowy identyfikator rozpoznanej jednostki interfejsu API wyszukiwania jednostek Bing.
dataSource	string	Źródło danych używane do wyodrębniania linków jednostek, takich jak wiki/Bing itp.
id	string	Unikatowy identyfikator rozpoznanej jednostki ze źródła danych.
language	string	Język używany w źródle danych.
matches	Match[]	Lista wystąpień tej jednostki jest wyświetlana w tekście.
name	string	Nazwa formalna łączenia jednostek.
url	string	Adres URL strony jednostki ze źródła danych.

Match

Objekt

Obiekt Match zawierający wykryty tekst jednostki z przesunięciem i długością.

Nazwa	Typ	Opis
confidenceScore	number (double)	Jeśli dobrze znany element zostanie rozpoznany, zostanie zwrócona liczba dziesiętna oznaczająca poziom ufności z zakresu od 0 do 1.
length	integer (int32)	Długość tekstu dopasowania jednostki.
offset	integer (int32)	Pozycja początkowa dla tekstu dopasowania jednostki.
text	string	Tekst jednostki wyświetlany w żądaniu.

MatchLongestEntityPolicyType

Objekt

Reprezentuje najdłuższe nakładające się zasady dopasowania. Nie nakładające się jednostki tak daleko, jak to możliwe. 1. Jeśli występują nakładające się jednostki, zostanie zwrócony najdłuższy. 2. Jeśli zestaw znaków przewidywanych dla co najmniej 2 jednostek jest dokładnie taki sam, wybierz jednostkę, która ma wyższy współczynnik ufności.3. Jeśli wyniki jednostki są identyczne, zwróć wszystkie jednostki, które są nadal obecne po zastosowaniu poprzednich reguł. 3. W przypadku częściowego nakładania się (tak jak w analizie tekstu hello) wykonaj powyższe kroki rozpoczynające się od 1.

Nazwa	Typ	Domyślna wartość	Opis
policyKind	string: matchLongest	matchLongest	Typ obiektu OverlapPolicy jednostki.

MetadataKind

Wyliczanie

Rodzaj obiektu Metadane jednostki.

Wartość	Opis
AgeMetadata	Metadane dotyczące wartości związanych z wiekiem.
AreaMetadata	Metadane dla wartości związanych z obszarem.
CurrencyMetadata	Metadane dla wartości związanych z walutą.
DateMetadata	Metadane dotyczące wartości związanych z datą.
DateTimeMetadata	Metadane dla wartości związanych z datą i godziną.
InformationMetadata	Metadane dotyczące wartości związanych z informacjami.
LengthMetadata	Metadane dotyczące wartości związanych z długością.
NumberMetadata	Metadane wartości liczbowych.
NumericRangeMetadata	Metadane dla wartości zakresu liczbowego.
OrdinalMetadata	Metadane liczb porządkowych.
SpeedMetadata	Metadane dotyczące wartości związanych z szybkością.
TemperatureMetadata	Metadane dotyczące wartości związanych z temperaturą.
TemporalSetMetadata	Metadane dla zestawu wartości związanych z czasem.
TemporalSpanMetadata	Metadane wartości zakresu czasowego.
TimeMetadata	Metadane dla wartości związanych z czasem.
VolumeMetadata	Metadane dla wartości związanych z woluminem.
WeightMetadata	Metadane dla wartości związanych z wagą.

MultiLanguageAnalysisInput

Objekt

Kolekcja dokumentów wejściowych, które mają być analizowane przez usługę.

Nazwa	Typ	Opis
documents	MultiLanguageInput[]	Dokumenty wejściowe do przeanalizowania.

MultiLanguageInput

Objekt

Zawiera dokument wejściowy do przeanalizowania przez usługę.

Nazwa	Typ	Opis
id	string	Unikatowy, niepusty identyfikator dokumentu.
language	string	(Opcjonalnie) Jest to 2 litera ISO 639-1 reprezentacja języka. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego. (Poniższe dotyczy tylko wersji 2023-04-15-preview i nowszych) W przypadku wykrywania automatycznego języka użyj opcji "auto". Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego.
text	string	Tekst wejściowy do przetworzenia.

NumberKind

Wyliczanie

Typ wyodrębnionej jednostki liczbowej.

Wartość	Opis
Decimal	Liczba dziesiętna
Fraction	Liczba ułamkowa
Integer	Liczba całkowita
Percent	Liczba procentowa
Power	Numer zasilania
Unspecified	Nieokreślony rodzaj numeru

NumberMetadata

Objekt

Metadane dla wystąpień jednostek liczbowych.

Nazwa	Typ	Opis
metadataKind	string: NumberMetadata	Rodzaj obiektu Metadane jednostki.
numberKind	NumberKind	Rodzaj typu liczby.
value	number (double)	Liczbowa reprezentacja wyodrębnionego tekstu.

NumericRangeMetadata

Objekt

reprezentuje metadane interwałów liczbowych.

Nazwa	Typ	Opis
maximum	number (double)	Wartość końcowa interwału.
metadataKind	string: NumericRangeMetadata	Rodzaj obiektu Metadane jednostki.
minimum	number (double)	Wartość początkowa interwału.
rangeInclusivity	RangeInclusivity	Inkluzywność tego zakresu.
rangeKind	RangeKind	Obsługiwany rodzaj zakresów liczbowych — na przykład Liczba, Szybkość itp.

OrdinalMetadata

Objekt

Metadane dla wystąpień jednostek liczbowych.

Nazwa	Typ	Opis
metadataKind	string: OrdinalMetadata	Rodzaj obiektu Metadane jednostki.
offset	string	Przesunięcie względem odwołania (np. przesunięcie = -1 wskazuje drugi do ostatniego)
relativeTo	RelativeTo	Punkt odniesienia oznaczający liczbę porządkową.
value	string	Proste wyrażenie arytmetyczne, które oznacza porządkowe.

PiiCategory

Wyliczanie

(Opcjonalnie) opisuje kategorie pii do zwrócenia

Wartość	Opis
ABARoutingNumber	Numer routingu usługi ABA
ARNationalIdentityNumber	Numer tożsamości krajowej AR
ATIdentityCard	AT Identity Card
ATTaxIdentificationNumber	NUMER identyfikacyjny PODATKU AT
ATValueAddedTaxNumber	Numer podatku od wartości dodanej AT
AUBankAccountNumber	AT Identity Card
AUBusinessNumber	Numer biznesowy jednostki organizacyjnej
AUCompanyNumber	Numer firmy jednostki organizacyjnej
AUDriversLicenseNumber	Numer licencji kierowcy AU
AUMedicalAccountNumber	Numer konta medycznego jednostki organizacyjnej
AUPassportNumber	Numer paszportu jednostki organizacyjnej
AUTaxFileNumber	Numer pliku podatkowego jednostki organizacyjnej
Address	Adres
Age	Wiek
All	Wszystkie kategorie pii.
AzureDocumentDBAuthKey	Klucz uwierzytelniania usługi Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	Połączenie z bazą danych Iaas platformy Azure i parametry SQL
AzureIoTConnectionString	Parametry połączenia usługi Azure IoT
AzurePublishSettingPassword	Hasło ustawienia publikowania platformy Azure
AzureRedisCacheString	Ciąg usługi Azure Redis Cache
AzureSAS	Sygnatura dostępu współdzielonego platformy
AzureServiceBusString	Ciąg usługi Azure Service Bus
AzureStorageAccountGeneric	Ogólne konto usługi Azure Storage
AzureStorageAccountKey	Klucz konta usługi Azure Storage
BENationalNumber	Numer krajowy BE
BENationalNumberV2	Numer krajowy BE V2
BEValueAddedTaxNumber	Numer podatku od wartości dodanej BE
BGUniformCivilNumber	BG Uniform Civil Number
BRCPFNumber	Numer BR CPF
BRLegalEntityNumber	Numer podmiotu prawnego BR
BRNationalIDRG	BR National ID RG
CABankAccountNumber	Numer konta bankowego urzędu certyfikacji
CADriversLicenseNumber	Numer licencji kierowcy urzędu certyfikacji
CAHealthServiceNumber	Numer usługi kondycji urzędu certyfikacji
CAPassportNumber	Numer paszportu urzędu certyfikacji
CAPersonalHealthIdentification	Identyfikacja kondycji osobistej urzędu certyfikacji
CASocialInsuranceNumber	Numer ubezpieczenia społecznego urzędu certyfikacji
CHSocialSecurityNumber	Numer ubezpieczenia społecznego CH
CLIdentityCardNumber	Numer karty tożsamości CL
CNResidentIdentityCardNumber	Numer karty tożsamości rezydenta CN
CYIdentityCard	Karta tożsamości CY
CYTaxIdentificationNumber	Numer identyfikacyjny podatku CY
CZPersonalIdentityNumber	Numer tożsamości osobistej CZ
CZPersonalIdentityV2	CZ Personal Identity V2
CreditCardNumber	Numer karty kredytowej
DEDriversLicenseNumber	Numer licencji de kierowcy
DEIdentityCardNumber	Numer karty tożsamości DE
DEPassportNumber	Numer paszportu DE
DETaxIdentificationNumber	DE Numer identyfikacyjny podatku DE
DEValueAddedNumber	Liczba dodana wartości DE
DKPersonalIdentificationNumber	Osobisty numer identyfikacyjny klucza DK
DKPersonalIdentificationV2	Identyfikacja osobista DK w wersji 2
Date	Data
Default	Domyślne kategorie danych pii dla języka.
DrugEnforcementAgencyNumber	Numer agencji egzekwowania narkotyków
EEPersonalIdentificationCode	Kod identyfikacji osobistej EE
ESDNI	ES DNI
ESSocialSecurityNumber	Numer ubezpieczenia społecznego ES
ESTaxIdentificationNumber	Numer identyfikacyjny podatku ES
EUDebitCardNumber	Numer karty debetowej UE
EUDriversLicenseNumber	Numer licencji kierowcy UE
EUGPSCoordinates	Współrzędne GPS UE
EUNationalIdentificationNumber	Krajowy numer identyfikacyjny UE
EUPassportNumber	Numer paszportu UE
EUSocialSecurityNumber	Numer ubezpieczenia społecznego UE
EUTaxIdentificationNumber	Numer identyfikacyjny podatku UE
Email	E-mail
FIEuropeanHealthNumber	FI European Health Number
FINationalID	Identyfikator krajowy FI
FINationalIDV2	FI National ID V2
FIPassportNumber	Numer paszportu FI
FRDriversLicenseNumber	Numer licencji kierowcy FR
FRHealthInsuranceNumber	Numer ubezpieczenia zdrowotnego FR
FRNationalID	Identyfikator krajowy FR
FRPassportNumber	Numer paszportu FR
FRSocialSecurityNumber	Numer ubezpieczenia społecznego FR
FRTaxIdentificationNumber	Numer identyfikacyjny podatku FR
FRValueAddedTaxNumber	Numer podatku od wartości dodanej FR
GRNationalIDCard	GR National ID Card
GRNationalIDV2	GR National ID V2
GRTaxIdentificationNumber	GR Numer identyfikacyjny podatku
HKIdentityCardNumber	Numer karty tożsamości HK
HRIdentityCardNumber	Numer karty tożsamości działu kadr
HRNationalIDNumber	Numer identyfikatora narodowego HR
HRPersonalIdentificationNumber	Osobisty numer identyfikacyjny działu kadr
HRPersonalIdentificationOIBNumberV2	Numer OIB identyfikacji osobistej HR v2
HUPersonalIdentificationNumber	Osobisty numer identyfikacyjny HU
HUTaxIdentificationNumber	Numer identyfikacyjny podatku HU
HUValueAddedNumber	Liczba dodana przez wartość HU
IDIdentityCardNumber	Numer karty tożsamości identyfikatora
IEPersonalPublicServiceNumber	Osobisty numer usługi publicznej programu IE
IEPersonalPublicServiceNumberV2	Osobisty numer usługi publicznej programu IE w wersji 2
ILBankAccountNumber	Numer konta bankowego IL
ILNationalID	Identyfikator narodowy IL
INPermanentAccount	Konto trwałe IN
INUniqueIdentificationNumber	W unikatowym numerze identyfikacyjnym
IPAddress	Adres IP
ITDriversLicenseNumber	Numer licencji kierowcy IT
ITFiscalCode	Kod fiskalny IT
ITValueAddedTaxNumber	Numer podatku od wartości dodanej IT
InternationalBankingAccountNumber	Numer konta bankowego międzynarodowego
JPBankAccountNumber	Numer konta bankowego JP
JPDriversLicenseNumber	Numer licencji KIEROWCY JP
JPMyNumberCorporate	JP My Number Corporate
JPMyNumberPersonal	JP Mój numer osobisty
JPPassportNumber	Numer paszportu JP
JPResidenceCardNumber	Numer karty rezydencji JP
JPResidentRegistrationNumber	Numer rejestracji rezydenta JP
JPSocialInsuranceNumber	JP Numer ubezpieczenia społecznego
KRResidentRegistrationNumber	Numer rejestracji rezydenta KR
LTPersonalCode	LT Personal Code
LUNationalIdentificationNumberNatural	Numer identyfikacji krajowej LU Naturalny
LUNationalIdentificationNumberNonNatural	Krajowy numer identyfikacyjny LU, który nie jest naturalny
LVPersonalCode	LV Personal Code
MTIdentityCardNumber	Numer karty tożsamości usługi MT
MTTaxIDNumber	Numer identyfikatora podatkowego mt
MYIdentityCardNumber	Mój numer karty tożsamości
NLCitizensServiceNumber	Numer usługi NL Citizens Service
NLCitizensServiceNumberV2	Numer usługi NL Citizens w wersji 2
NLTaxIdentificationNumber	Numer identyfikacyjny podatku NL
NLValueAddedTaxNumber	Numer podatku od wartości dodanej nl
NOIdentityNumber	BRAK numeru tożsamości
NZBankAccountNumber	Numer konta bankowego NZ
NZDriversLicenseNumber	Numer licencji kierowcy NZ
NZInlandRevenueNumber	Numer przychodu NZ w landzie
NZMinistryOfHealthNumber	NZ Ministerstwo Zdrowia
NZSocialWelfareNumber	Numer opieki społecznej NZ
Organization	Organizacja
PHUnifiedMultiPurposeIDNumber	PH Unified Multi Purpose ID Number
PLIdentityCard	Karta tożsamości PL
PLNationalID	Identyfikator krajowy PL
PLNationalIDV2	PL National ID V2
PLPassportNumber	Numer paszportu PL
PLREGONNumber	Numer REGON PL
PLTaxIdentificationNumber	Numer identyfikacyjny podatku PL
PTCitizenCardNumber	Numer karty obywatela PT
PTCitizenCardNumberV2	Numer karty obywatela PT V2
PTTaxIdentificationNumber	Numer identyfikacyjny podatku PT
Person	Osoba
PhoneNumber	Numer
ROPersonalNumericalCode	Osobisty kod liczbowy RO
RUPassportNumberDomestic	Numer krajowy paszportu RU
RUPassportNumberInternational	Numer paszportu RU International
SANationalID	Identyfikator krajowy sa
SENationalID	Identyfikator krajowy SE
SENationalIDV2	SE National ID V2
SEPassportNumber	Numer paszportu SE
SETaxIdentificationNumber	Numer identyfikacyjny podatku SE
SGNationalRegistrationIdentityCardNumber	Numer karty tożsamości rejestracji krajowej SG
SITaxIdentificationNumber	Numer identyfikacyjny podatku SI
SIUniqueMasterCitizenNumber	Unikatowy numer obywatela głównego SI
SKPersonalNumber	Numer osobisty SK
SQLServerConnectionString	Parametry połączenia programu SQL Server
SWIFTCode	Kod SWIFT
THPopulationIdentificationCode	Kod identyfikacji populacji TH
TRNationalIdentificationNumber	Krajowy numer identyfikacyjny TR
TWNationalID	Identyfikator krajowy TW
TWPassportNumber	Numer paszportu TW
TWResidentCertificate	Certyfikat rezydenta TW
UAPassportNumberDomestic	Numer krajowy paszportu UA
UAPassportNumberInternational	Numer paszportu UA International
UKDriversLicenseNumber	Numer licencji kierowcy w Wielkiej Brytanii
UKElectoralRollNumber	Numer brytyjskiej listy wyborczej
UKNationalHealthNumber	Brytyjski numer zdrowia narodowego
UKNationalInsuranceNumber	Numer ubezpieczenia narodowego w Wielkiej Brytanii
UKUniqueTaxpayerNumber	Unikatowy numer podatnika w Wielkiej Brytanii
URL	Adres URL
USBankAccountNumber	Numer konta bankowego USA
USDriversLicenseNumber	Numer licencji kierowcy USA
USIndividualTaxpayerIdentification	Identyfikacja indywidualnych podatników w USA
USSocialSecurityNumber	Amerykański numer ubezpieczenia społecznego
USUKPassportNumber	US UK Passport Number
ZAIdentificationNumber	Numer identyfikacyjny ZA

PiiDomain

Wyliczanie

Domena dla zadania pii

Wartość	Opis
none	Wskazuje, że żadna domena nie jest określona.
phi	Wskazuje, że jednostki w domenie Informacji o kondycji osobistej powinny zostać zredagowane.

PiiEntitiesDocumentResult

Objekt

Zawiera wyniki danych pii.

Nazwa	Typ	Opis
entities	Entity[]	Rozpoznane jednostki w dokumencie.
id	string	Unikatowy, niepusty identyfikator dokumentu.
redactedText	string	Zwraca tekst zredagowany.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Ostrzeżenia napotkane podczas przetwarzania dokumentu.

PiiResult

Objekt

Zawiera element PiiResult.

Nazwa	Typ	Opis
documents	PiiEntitiesDocumentResult[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

PiiTaskParameters

Objekt

Obsługiwane parametry zadania rozpoznawania jednostek PII.

Nazwa	Typ	Domyślna wartość	Opis
domain	PiiDomain	none	Domena dla zadania pii
loggingOptOut	boolean	False	Wylogowanie z rezygnacji
modelVersion	string	latest	wersja modelu
piiCategories	PiiCategory[]		Wyliczenie kategorii pii, które mają być zwracane w odpowiedzi.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType do użycia do analizy.

PiiTaskResult

Objekt

Zawiera zadanie LRO analizy tekstu PIIEntityRecognition.

Nazwa	Typ	Opis
kind	string: PiiEntityRecognitionResults	Rodzaj wyniku zadania.
results	PiiResult	Lista wyników pii

RangeInclusivity

Wyliczanie

Zakres inkluzywności tej właściwości.

Wartość	Opis
LeftInclusive	Włącznie z lewą stroną
LeftRightInclusive	Obie strony włącznie
NoneInclusive	Brak inkluzywności
RightInclusive	Prawa strona włącznie

RangeKind

Wyliczanie

Rodzaj jednostki zakresu liczb.

Wartość	Opis
Age	Zakres wiekowy
Area	Zakres obszarów
Currency	Zakres walut
Information	Zakres informacji
Length	Zakres długości
Number	Zakres liczb
Speed	Zakres prędkości
Temperature	Zakres temperatury
Volume	Zakres woluminów
Weight	Zakres wagi

RelativeTo

Wyliczanie

Punkt odniesienia oznaczający liczbę porządkową.

Wartość	Opis
Current	Bieżący stan lub położenie
End	Stan zakończenia lub położenie
Start	Stan rozpoczęcia lub pozycja

RequestStatistics

Objekt

jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

Nazwa	Typ	Opis
documentsCount	integer (int32)	Liczba dokumentów przesłanych w żądaniu.
erroneousDocumentsCount	integer (int32)	Liczba nieprawidłowych dokumentów. Obejmuje to puste, nadmierne limity rozmiaru lub dokumenty języków nieobsługiwanych.
transactionsCount	integer (int64)	Liczba transakcji dla żądania.
validDocumentsCount	integer (int32)	Liczba prawidłowych dokumentów. Nie obejmuje to pustych, nadmiernych limitów rozmiaru lub dokumentów języków nieobsługiwanych.

ScriptCode

Wyliczanie

Identyfikuje skrypt dokumentu wejściowego. Mapuje na standardowy kod skryptu ISO 15924.

Wartość	Opis
Arab	Kod skryptu dla skryptu arabskiego.
Armn	Kod skryptu dla ormiańskiego skryptu.
Beng	Kod skryptu dla skryptu Bangla.
Cans	Kod skryptu dla skryptu UnifiedCanadianAboriginalSyllabics.
Cyrl	Kod skryptu dla skryptu cyrylica.
Deva	Kod skryptu dla skryptu Devanagari.
Ethi	Kod skryptu dla skryptu Ethiopic.
Geor	Kod skryptu dla skryptu gruzińskiego.
Grek	Kod skryptu dla greckiego skryptu.
Gujr	Kod skryptu dla skryptu Gujarati.
Guru	Kod skryptu dla skryptu Gurmukhi.
Hang	Kod skryptu hangul.
Hani	Kod skryptu dla skryptu HanLiteral.
Hans	Kod skryptu dla skryptu HanSimplified.
Hant	Kod skryptu dla skryptu HanTraditional.
Hebr	Kod skryptu dla skryptu hebrajskiego.
Jpan	Kod skryptu dla skryptu japońskiego.
Khmr	Kod skryptu dla skryptu Khmeru.
Knda	Kod skryptu dla skryptu Kannada.
Laoo	Kod skryptu dla skryptu Lao.
Latn	Kod skryptu dla skryptu łacińskiego.
Mlym	Kod skryptu dla skryptu Malayalam.
Mong	Kod skryptu mongolskiego.
Mtei	Kod skryptu dla skryptu Meitei.
Mymr	Kod skryptu mjanmy.
Olck	Kod skryptu dla skryptu Santali.
Orya	Kod skryptu dla skryptu Odia.
Shrd	Kod skryptu dla skryptu Sharada.
Sinh	Kod skryptu skryptu Sinhala.
Taml	Kod skryptu dla skryptu tamilu.
Telu	Kod skryptu dla skryptu Telugu.
Thaa	Kod skryptu dla skryptu Thaana.
Thai	Kod skryptu dla skryptu tajskiego.
Tibt	Kod skryptu dla skryptu tybetańskiego.

ScriptKind

Wyliczanie

Identyfikuje skrypt dokumentu wejściowego. Mapuje standardową nazwę standardową ISO 15924.

Wartość	Opis
Arabic	Nazwa skryptu arabskiego.
Armenian	Nazwa skryptu ormiańskiego.
Bangla	Nazwa skryptu Bangla.
Cyrillic	Nazwa skryptu cyrylica.
Devanagari	Nazwa skryptu devanagari.
Ethiopic	Nazwa skryptu Etiopic.
Georgian	Nazwa skryptu gruzińskiego.
Greek	Nazwa skryptu greckiego.
Gujarati	Nazwa skryptu Gujarati.
Gurmukhi	Nazwa skryptu Gurmukhi.
HanLiteral	Nazwa skryptu HanLiteral.
HanSimplified	Nazwa skryptu han uproszczonego.
HanTraditional	Nazwa skryptu HanTraditional.
Hangul	Nazwa skryptu Hangul.
Hebrew	Nazwa skryptu hebrajskiego.
Japanese	Nazwa skryptu japońskiego.
Kannada	Nazwa skryptu Kannada.
Khmer	Nazwa skryptu khmeru.
Lao	Nazwa skryptu lao.
Latin	Nazwa skryptu łacińskiego.
Malayalam	Nazwa skryptu Malayalam.
Meitei	Nazwa skryptu Meitei.
Mongolian	Nazwa skryptu mongolskiego.
Myanmar	Nazwa skryptu mjanmy.
Odia	Nazwa skryptu Odia.
Santali	Nazwa skryptu Santali.
Sharada	Nazwa skryptu Sharada.
Sinhala	Nazwa skryptu Sinhala.
Tamil	Nazwa skryptu tamilu.
Telugu	Nazwa skryptu Telugu.
Thaana	Nazwa skryptu firmy Thaana.
Thai	Nazwa skryptu tajskiego.
Tibetan	Nazwa skryptu tybetańskiego.
UnifiedCanadianAboriginalSyllabics	Nazwa skryptu UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

Objekt

Reprezentuje ocenę zdania oraz powiązane z nią oceny lub obiekty docelowe.

Nazwa	Typ	Opis
confidenceScores	TargetConfidenceScoreLabel	Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.
isNegated	boolean	Wskaźnik reprezentujący, czy ocena jest negowana.
length	integer (int32)	Długość obiektu docelowego.
offset	integer (int32)	Przesunięcie docelowe od początku zdania.
sentiment	TokenSentimentValue	Tonacja zdania.
text	string	Wykryto tekst docelowy.

SentenceSentiment

Objekt

Tonacja zdań dokumentu.

Nazwa	Typ	Opis
assessments	SentenceAssessment[]	Tablica ocen zdania.
confidenceScores	SentimentConfidenceScores	Wskaźnik ufności tonacji z zakresu od 0 do 1 dla zdania dla wszystkich klas.
length	integer (int32)	Długość obiektu docelowego.
offset	integer (int32)	Przesunięcie docelowe od początku zdania.
sentiment	SentenceSentimentValue	Przewidywana tonacja dla zdania.
targets	SentenceTarget[]	Tablica obiektów docelowych zdań dla zdania.
text	string	Tekst zdania.

SentenceSentimentValue

Wyliczanie

Przewidywana tonacja dla zdania.

Wartość	Opis
negative	Negatywna tonacja
neutral	Neutralna tonacja
positive	Pozytywna tonacja

SentenceTarget

Objekt

Reprezentuje element docelowy zdania oraz oceny lub obiekty docelowe powiązane z nim.

Nazwa	Typ	Opis
confidenceScores	TargetConfidenceScoreLabel	Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.
length	integer (int32)	Długość obiektu docelowego.
offset	integer (int32)	Przesunięcie docelowe od początku zdania.
relations	TargetRelation[]	Tablica obiektów oceny lub obiektów docelowych, które są powiązane z obiektem docelowym.
sentiment	TokenSentimentValue	Tonacja zdania.
text	string	Wykryto tekst docelowy.

SentimentAnalysisTaskParameters

Objekt

Obsługiwane parametry zadania Analiza tonacji.

Nazwa	Typ	Domyślna wartość	Opis
loggingOptOut	boolean	False	Wylogowanie z rezygnacji
modelVersion	string	latest	wersja modelu
opinionMining	boolean	False	Czy używać wyszukiwania opinii w żądaniu, czy nie.
stringIndexType	StringIndexType	TextElements_v8	Określa metodę używaną do interpretowania przesunięć ciągów.

SentimentConfidenceScores

Objekt

Reprezentuje wyniki ufności z zakresu od 0 do 1 we wszystkich klasach tonacji: dodatnie, neutralne, ujemne.

Nazwa	Typ	Opis
negative	number (double)	Wskaźnik ufności dla negatywnej tonacji
neutral	number (double)	Wskaźnik ufności dla neutralnej tonacji
positive	number (double)	Wskaźnik ufności dla pozytywnej tonacji

SentimentDocumentResult

Objekt

Obiekt reprezentujący wstępnie utworzone wyniki analizy tonacji każdego dokumentu.

Nazwa	Typ	Opis
confidenceScores	SentimentConfidenceScores	Wskaźnik ufności tonacji z zakresu od 0 do 1 dla zdania dla wszystkich klas.
id	string	Unikatowy, niepusty identyfikator dokumentu.
sentences	SentenceSentiment[]	Tonacja zdań dokumentu.
sentiment	DocumentSentimentValue	Przewidywana tonacja dokumentu (negatywna, neutralna, dodatnia lub mieszana).
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Ostrzeżenia napotkane podczas przetwarzania dokumentu.

SentimentResponse

Objekt

Wyniki analizy tonacji dla dokumentów wejściowych.

Nazwa	Typ	Opis
documents	SentimentDocumentResult[]	Wyniki analizy tonacji dla każdego dokumentu w danych wejściowych.
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

SentimentTaskResult

Objekt

Zawiera wynik zadania LRO analizy tekstu SentimentAnalysis.

Nazwa	Typ	Opis
kind	string: SentimentAnalysisResults	Rodzaj wyniku zadania.
results	SentimentResponse	Wyniki analizy tonacji

SpeedMetadata

Objekt

Reprezentuje model metadanych jednostki Speed.

Nazwa	Typ	Opis
metadataKind	string: SpeedMetadata	Rodzaj obiektu Metadane jednostki.
unit	SpeedUnit	Jednostka miary dla prędkości.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

SpeedUnit

Wyliczanie

Jednostka prędkości miary

Wartość	Opis
CentimetersPerMillisecond	Jednostka prędkości w centymetrach na milisekundę.
FeetPerMinute	Jednostka prędkości w stopach na minutę.
FeetPerSecond	Jednostka prędkości w stopach na sekundę.
KilometersPerHour	Jednostka prędkości w kilometrach na godzinę.
KilometersPerMillisecond	Jednostka prędkości w kilometrach na milisekundę.
KilometersPerMinute	Jednostka prędkości w kilometrach na minutę.
KilometersPerSecond	Jednostka prędkości w kilometrach na sekundę.
Knots	Jednostka prędkości w węzłach.
MetersPerMillisecond	Jednostka prędkości w metrach na milisekundę.
MetersPerSecond	Jednostka prędkości w metrach na sekundę.
MilesPerHour	Jednostka prędkości w milach na godzinę.
Unspecified	Nieokreślona jednostka prędkości.
YardsPerMinute	Jednostka prędkości w metrach na minutę.
YardsPerSecond	Jednostka prędkości w metrach na sekundę.

StringIndexType

Wyliczanie

Typ indeksu ciągu

Wartość	Opis
TextElements_v8	Zwrócone wartości przesunięcia i długości będą odpowiadać elementom TextElements (klastrom Graphemes i Grapheme) potwierdzającym standard Unicode 8.0.0. Użyj tej opcji, jeśli aplikacja jest napisana w programie .Net Framework lub .Net Core i będziesz używać funkcji StringInfo.
UnicodeCodePoint	Zwrócone wartości przesunięcia i długości będą odpowiadać punktom kodu Unicode. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład Python.
Utf16CodeUnit	Zwrócone wartości przesunięcia i długości będą odpowiadać jednostkom kodu UTF-16. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład JavaScript.

TargetConfidenceScoreLabel

Objekt

Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.

Nazwa	Typ	Opis
negative	number (double)	Wskaźnik ufności dla negatywnej tonacji
positive	number (double)	Wskaźnik ufności dla pozytywnej tonacji

TargetRelation

Objekt

Reprezentuje relację między ocenami i/lub celami.

Nazwa	Typ	Opis
ref	string	Wskaźnik JSON wskazujący połączony obiekt.
relationType	TargetRelationType	Typ powiązany z obiektem docelowym.

TargetRelationType

Wyliczanie

Typ powiązany z obiektem docelowym.

Wartość	Opis
assessment	Relacja oceny.
target	Relacja docelowa.

TemperatureMetadata

Objekt

Reprezentuje model metadanych jednostki informacyjnej.

Nazwa	Typ	Opis
metadataKind	string: TemperatureMetadata	Rodzaj obiektu Metadane jednostki.
unit	TemperatureUnit	Jednostka miary dla temperatury.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

TemperatureUnit

Wyliczanie

Jednostka temperatury miary.

Wartość	Opis
Celsius	Jednostka temperatury w stopniach Celsjusza
Fahrenheit	Jednostka temperatury w Fahrenheit
Kelvin	Jednostka temperatury w Kelvin
Rankine	Jednostka temperatury w Rankine
Unspecified	Nieokreślona jednostka temperatury

TemporalModifier

Wyliczanie

Opcjonalny modyfikator wystąpienia daty/godziny.

Wartość	Opis
After	Po określonej godzinie
AfterApprox	Po przybliżonym czasie
AfterMid	Po środku okresu
AfterStart	Po rozpoczęciu okresu
Approx	Około w określonym czasie
Before	Przed określonym czasem
BeforeApprox	Przed przybliżonym czasem
BeforeEnd	Przed końcem okresu
BeforeStart	Przed rozpoczęciem okresu
End	Na koniec okresu
Less	Mniej niż określony czas
Mid	W środku okresu
More	Więcej niż określony czas
ReferenceUndefined	Odwołanie do niezdefiniowanego czasu
Since	Od określonego czasu
SinceEnd	Od końca okresu
Start	Na początku okresu
Until	Do określonej godziny

TemporalSetMetadata

Objekt

Metadane dla wystąpień jednostki zestawu czasowego.

Nazwa	Typ	Opis
dateValues	DateValue[]	Lista wartości daty.
metadataKind	string: TemporalSetMetadata	Rodzaj obiektu Metadane jednostki.

TemporalSpanMetadata

Objekt

reprezentuje metadane zakresu daty i/lub godziny.

Nazwa	Typ	Opis
metadataKind	string: TemporalSpanMetadata	Rodzaj obiektu Metadane jednostki.
spanValues	TemporalSpanValues[]	Lista wykrytych zakresów czasowych.

TemporalSpanValues

Objekt

Obiekt zakresu czasowego.

Nazwa	Typ	Opis
begin	string	Wartość początkowa dla zakresu.
duration	string	Opcjonalna wartość czasu trwania sformatowana na podstawie iso 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Wartość końcowa dla zakresu.
modifier	TemporalModifier	Modyfikator daty/godziny, aby wskazać punkt odniesienia, taki jak przed, po itp.
timex	string	Opcjonalna trójka zawierająca początek, koniec i czas trwania określony jako ciągi sformatowane w formacie ISO 8601.

TimeMetadata

Objekt

Metadane dla wystąpień jednostek czasu.

Nazwa	Typ	Opis
dateValues	DateValue[]	Lista wartości daty.
metadataKind	string: TimeMetadata	Rodzaj obiektu Metadane jednostki.

TokenSentimentValue

Wyliczanie

Przewidywana tonacja dla zdania.

Wartość	Opis
mixed	Mieszane tonacje
negative	Negatywna tonacja
positive	Pozytywna tonacja

VolumeMetadata

Objekt

Reprezentuje model metadanych jednostki woluminu.

Nazwa	Typ	Opis
metadataKind	string: VolumeMetadata	Rodzaj obiektu Metadane jednostki.
unit	VolumeUnit	Jednostka miary dla woluminu.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

VolumeUnit

Wyliczanie

Jednostka miary objętości

Wartość	Opis
Barrel	Jednostka objętościowa w baryłkach.
Bushel	Jednostka objętościowa w bushels.
Centiliter	Jednostka objętościowa w centiliters.
Cord	Jednostka objętościowa w przewodach.
CubicCentimeter	Jednostka objętości w centymetrach sześciennych.
CubicFoot	Jednostka objętościowa w stopach sześciennych.
CubicInch	Jednostka objętościowa w calach sześciennych.
CubicMeter	Jednostka objętościowa w metrach sześciennych.
CubicMile	Jednostka objętościowa w milach sześciennych.
CubicMillimeter	Jednostka objętościowa w milimetrach sześciennych.
CubicYard	Jednostka objętościowa w stoczniach sześciennych.
Cup	Jednostka objętościowa w kubkach.
Decaliter	Jednostka woluminu w dekaliterach.
FluidDram	Jednostka objętościowa w dramach płynów.
FluidOunce	Jednostka objętościowa w uncjach płynów.
Gill	Jednostka objętościowa w skrzelach.
Hectoliter	Jednostka objętościowa w hektoliterach.
Hogshead	Jednostka objętościowa w głowicach.
Liter	Jednostka objętościowa w litrach.
Milliliter	Jednostka objętościowa w mililiterach.
Minim	Jednostka objętościowa w minimach.
Peck	Jednostka objętościowa w dziobach.
Pinch	Jednostka objętościowa w pękcie.
Pint	Jednostka woluminu w pintach.
Quart	Jednostka objętościowa w kwartach.
Tablespoon	Jednostka objętości w łyżkach.
Teaspoon	Jednostka objętościowa w łyżeczkach.
Unspecified	Nieokreślona jednostka woluminu.

WarningCodeValue

Wyliczanie

Definiuje listę kodów ostrzegawczych.

Wartość	Opis
DocumentTruncated	Ostrzeżenie o obciętym dokumencie
LongWordsInDocument	Długie wyrazy w ostrzeżeniu dokumentu

WeightMetadata

Objekt

Reprezentuje model metadanych jednostki Waga ).

Nazwa	Typ	Opis
metadataKind	string: WeightMetadata	Rodzaj obiektu Metadane jednostki.
unit	WeightUnit	Jednostka miary dla wagi.
value	number (double)	Wartość liczbowa oznaczana przez wyodrębniony tekst.

WeightUnit

Wyliczanie

Jednostka wagi miary.

Wartość	Opis
Dram	Jednostka wagi w dramach
Gallon	Jednostka objętościowa w galonach
Grain	Jednostka wagi w ziarnach
Gram	Jednostka wagi w gramach
Kilogram	Jednostka wagi w kilogramach
LongTonBritish	Jednostka wagowa w długich tonach (Brytyjski)
MetricTon	Jednostka wagowa w tonach metrycznych
Milligram	Jednostka wagi w miligramach
Ounce	Jednostka wagi w uncjach
PennyWeight	Jednostka wagi w groszach
Pound	Jednostka wagi w funtach
ShortHundredWeightUS	Jednostka wagi w wadze krótkiej (USA)
ShortTonUS	Jednostka wagowa w krótkich tonach (USA)
Stone	Jednostka wagi w kamieniach
Ton	Jednostka wagowa w tonach
Unspecified	Nieokreślona jednostka wagi