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

Reprezentuje model metadanych jednostki Wiek.

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

AgeUnit

Jednostka wieku miary

Nazwa	Typ	Opis
Day	string	Okres dnia
Month	string	Okres miesiąca
Unspecified	string	Nieokreślony okres
Week	string	Okres tygodnia
Year	string	Okres roku

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

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

AnalyzeTextEntityLinkingInput

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

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

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

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

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

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

Rodzaj obsługiwanych zadań analizy tekstu.

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

AnalyzeTextTaskResultsKind

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

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

AreaMetadata

Reprezentuje model metadanych jednostki Obszar.

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

AreaUnit

Jednostka powierzchni miary.

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

CurrencyMetadata

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	Wartość liczbowa oznaczana przez wyodrębniony tekst.

DateMetadata

Metadane dla wystąpień jednostek daty.

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

DateTimeMetadata

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

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

Zawiera szczegóły wykrytego języka tekstu.

Nazwa	Typ	Opis
confidenceScore	number	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

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

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

Nazwa	Typ	Opis
mixed	string	Instrukcja mieszana
negative	string	Ujemna instrukcja
neutral	string	Instrukcja neutralna
positive	string	Instrukcja dodatnia

DocumentStatistics

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	Liczba elementów tekstowych rozpoznanych w dokumencie.
transactionsCount	integer	Liczba transakcji dla dokumentu.

DocumentWarning

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

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

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

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

Zawiera zadanie jednostki

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

Entity

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

Nazwa	Typ	Opis
category	string	Typ jednostki.
confidenceScore	number	Współczynnik ufności z zakresu od 0 do 1 wyodrębnionej jednostki.
length	integer	Długość tekstu jednostki. Użycie różnych wartości "stringIndexType" może mieć wpływ na zwracaną długość.
offset	integer	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

Zawiera wszystkie kategorie jednostek wykryte przez rozpoznawanie jednostek.

Nazwa	Typ	Opis
Address	string	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	string	Wartości związane z wiekiem.
Airport	string	Lotniska.
Area	string	Obszar obiektu.
City	string	Wartości związane z miastem.
ComputingProduct	string	Produkty obliczeniowe.
Continent	string	Wartości związane z kontynentem.
CountryRegion	string	Wartości związane z krajami lub regionami.
CulturalEvent	string	Wartości związane z wydarzeniami kulturalnymi.
Currency	string	Wartości związane z walutą.
Date	string	Daty kalendarza.
DateRange	string	Zakres dat.
DateTime	string	Daty kalendarza z godziną.
DateTimeRange	string	Zakres daty i godziny.
Dimension	string	Wymiar pomiarów
Duration	string	Czas trwania.
Email	string	Adresy e-mail.
Event	string	Społeczne, sportowe, biznesowe, polityczne, edukacyjne, naturalne, historyczne, przestępcze, brutalne, prawne, wojskowe wydarzenia z upływem czasu.
GPE	string	Miasta, kraje/regiony, stany.
Geological	string	Cechy geograficzne i naturalne, takie jak rzeki, oceany i pustynie.
Height	string	Wysokość obiektu.
IP	string	adresy IP sieci.
Information	string	Jednostka miary dla informacji cyfrowych.
Length	string	Długość obiektu.
Location	string	Konkretny punkt lub miejsce w przestrzeni fizycznej.
NaturalEvent	string	Naturalne wartości związane z zdarzeniami.
Number	string	Liczby bez jednostki
NumberRange	string	Zakres liczb
Numeric	string	Wartości liczbowe, w tym cyfry i wyrazy liczbowe.
Ordinal	string	Liczby porządkowe.
Organization	string	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	string	Firmy medyczne i grupy.
OrganizationSports	string	Organizacje związane z sportem.
OrganizationStockExchange	string	Grupy giełdowe.
Percentage	string	Wartości związane z wartościami procentowymi.
Person	string	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	string	Role ludzkie sklasyfikowane przez członkostwo w grupie.
PhoneNumber	string	Numery telefonów (tylko numery telefonów USA i UE).
Product	string	Pojedyncza lub grupa komercyjnych, eksploatacyjnych obiektów, elektroniki, pojazdów, grup żywnościowych.
SetTemporal	string	Zestaw wartości związanych z czasem.
Skill	string	Możliwość, umiejętność lub wiedza specjalistyczna.
Speed	string	Szybkość obiektu.
SportsEvent	string	Wartości związane z wydarzeniami sportowymi.
State	string	Wartości związane z stanem.
Structural	string	Manmade struktury.
Temperature	string	Wartości związane z temperaturą.
Temporal	string	Elementy odnoszące się do czasu.
Time	string	Godziny dnia.
TimeRange	string	Zakres czasów.
URL	string	Adresy URL witryn sieci Web.
Volume	string	Wolumin obiektu.
Weight	string	Waga obiektu.

EntityInferenceOptions

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

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

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

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

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

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.

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

EntityWithMetadata

Obiekt jednostki z tagami i metadanymi.

Nazwa	Typ	Opis
category	string	Typ jednostki.
confidenceScore	number	Współczynnik ufności z zakresu od 0 do 1 wyodrębnionej jednostki.
length	integer	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	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

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

Kod błędu czytelny dla człowieka.

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

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InformationMetadata

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	Wartość liczbowa oznaczana przez wyodrębniony tekst.

InformationUnit

Jednostka miary informacji (danych).

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

InnerErrorCode

Kod błędu czytelny dla człowieka.

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

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.

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

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

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

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

Zawiera wynik zadania analizy KeyPhraseExtraction.

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

LanguageDetectionAnalysisInput

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

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

LanguageDetectionDocumentResult

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

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

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

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

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

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	Wartość liczbowa oznaczana przez wyodrębniony tekst.

LengthUnit

Jednostka długości miary.

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

LinkedEntitiesDocumentResult

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

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

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

Nazwa	Typ	Opis
confidenceScore	number	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	Długość tekstu dopasowania jednostki.
offset	integer	Pozycja początkowa dla tekstu dopasowania jednostki.
text	string	Tekst jednostki wyświetlany w żądaniu.

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.

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

MetadataKind

Rodzaj obiektu Metadane jednostki.

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

MultiLanguageAnalysisInput

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

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

MultiLanguageInput

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

Typ wyodrębnionej jednostki liczbowej.

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

NumberMetadata

Metadane dla wystąpień jednostek liczbowych.

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

NumericRangeMetadata

reprezentuje metadane interwałów liczbowych.

Nazwa	Typ	Opis
maximum	number	Wartość końcowa interwału.
metadataKind	string: NumericRangeMetadata	Rodzaj obiektu Metadane jednostki.
minimum	number	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

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

(Opcjonalnie) opisuje kategorie pii do zwrócenia

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

PiiDomain

Domena dla zadania pii

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

PiiEntitiesDocumentResult

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

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

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

Zawiera zadanie LRO analizy tekstu PIIEntityRecognition.

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

RangeInclusivity

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

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

RangeKind

Rodzaj jednostki zakresu liczb.

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

RelativeTo

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

Nazwa	Typ	Opis
Current	string	Bieżący stan lub położenie
End	string	Stan zakończenia lub położenie
Start	string	Stan rozpoczęcia lub pozycja

RequestStatistics

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	Liczba dokumentów przesłanych w żądaniu.
erroneousDocumentsCount	integer	Liczba nieprawidłowych dokumentów. Obejmuje to puste, nadmierne limity rozmiaru lub dokumenty języków nieobsługiwanych.
transactionsCount	integer	Liczba transakcji dla żądania.
validDocumentsCount	integer	Liczba prawidłowych dokumentów. Nie obejmuje to pustych, nadmiernych limitów rozmiaru lub dokumentów języków nieobsługiwanych.

ScriptCode

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

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

ScriptKind

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

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

SentenceAssessment

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	Długość obiektu docelowego.
offset	integer	Przesunięcie docelowe od początku zdania.
sentiment	TokenSentimentValue	Tonacja zdania.
text	string	Wykryto tekst docelowy.

SentenceSentiment

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	Długość obiektu docelowego.
offset	integer	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

Przewidywana tonacja dla zdania.

Nazwa	Typ	Opis
negative	string	Negatywna tonacja
neutral	string	Neutralna tonacja
positive	string	Pozytywna tonacja

SentenceTarget

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	Długość obiektu docelowego.
offset	integer	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

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

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

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

SentimentDocumentResult

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

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

Zawiera wynik zadania LRO analizy tekstu SentimentAnalysis.

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

SpeedMetadata

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	Wartość liczbowa oznaczana przez wyodrębniony tekst.

SpeedUnit

Jednostka prędkości miary

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

StringIndexType

Typ indeksu ciągu

Nazwa	Typ	Opis
TextElements_v8	string	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	string	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	string	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

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

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

TargetRelation

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

Typ powiązany z obiektem docelowym.

Nazwa	Typ	Opis
assessment	string	Relacja oceny.
target	string	Relacja docelowa.

TemperatureMetadata

Reprezentuje model metadanych jednostki informacyjnej.

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

TemperatureUnit

Jednostka temperatury miary.

Nazwa	Typ	Opis
Celsius	string	Jednostka temperatury w stopniach Celsjusza
Fahrenheit	string	Jednostka temperatury w Fahrenheit
Kelvin	string	Jednostka temperatury w Kelvin
Rankine	string	Jednostka temperatury w Rankine
Unspecified	string	Nieokreślona jednostka temperatury

TemporalModifier

Opcjonalny modyfikator wystąpienia daty/godziny.

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

TemporalSetMetadata

Metadane dla wystąpień jednostki zestawu czasowego.

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

TemporalSpanMetadata

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

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

Metadane dla wystąpień jednostek czasu.

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

TokenSentimentValue

Przewidywana tonacja dla zdania.

Nazwa	Typ	Opis
mixed	string	Mieszane tonacje
negative	string	Negatywna tonacja
positive	string	Pozytywna tonacja

VolumeMetadata

Reprezentuje model metadanych jednostki woluminu.

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

VolumeUnit

Jednostka miary objętości

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

WarningCodeValue

Definiuje listę kodów ostrzegawczych.

Nazwa	Typ	Opis
DocumentTruncated	string	Ostrzeżenie o obciętym dokumencie
LongWordsInDocument	string	Długie wyrazy w ostrzeżeniu dokumentu

WeightMetadata

Reprezentuje model metadanych jednostki Waga ).

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

WeightUnit

Jednostka wagi miary.

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