Text Analysis Runtime - Analyze Text

Servizio:

Azure AI Services

Versione API:

2024-11-01

Richiedere l'analisi del testo su una raccolta di documenti.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versione dell'API da usare per questa operazione.
showStats	query		boolean	(Facoltativo) se impostato su true, la risposta conterrà statistiche a livello di richiesta e documento.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
AnalyzeTextEntityLinkingInput	Contiene l'input di collegamento dell'entità di analisi del testo.
AnalyzeTextEntityRecognitionInput	Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.
AnalyzeTextKeyPhraseExtractionInput	Contiene l'input dell'attività Analyze text KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contiene l'input dell'attività di analisi dei documenti di rilevamento della lingua.
AnalyzeTextPiiEntitiesRecognitionInput	Contiene l'input dell'attività analizza testo PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contiene l'input dell'attività Analisi del testo SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Contiene l'input di collegamento dell'entità di analisi del testo.

Nome	Necessario	Tipo	Descrizione
kind	True	string: EntityLinking	Tipo di attività da eseguire.
analysisInput		MultiLanguageAnalysisInput	Contiene l'input di analisi da gestire dal servizio.
parameters		EntityLinkingTaskParameters	Parametri dell'attività.

AnalyzeTextEntityRecognitionInput

Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.

Nome	Necessario	Tipo	Descrizione
kind	True	string: EntityRecognition	Tipo di attività da eseguire.
analysisInput		MultiLanguageAnalysisInput	Input da analizzare.
parameters		EntitiesTaskParameters	Parametri dell'attività.

AnalyzeTextKeyPhraseExtractionInput

Contiene l'input dell'attività Analyze text KeyPhraseExtraction.

Nome	Necessario	Tipo	Descrizione
kind	True	string: KeyPhraseExtraction	Tipo di attività da eseguire.
analysisInput		MultiLanguageAnalysisInput	Contiene i documenti di input.
parameters		KeyPhraseTaskParameters	Parametri dell'attività di estrazione frasi chiave.

AnalyzeTextLanguageDetectionInput

Contiene l'input dell'attività di analisi dei documenti di rilevamento della lingua.

Nome	Necessario	Tipo	Descrizione
kind	True	string: LanguageDetection	Tipo di attività da eseguire.
analysisInput		LanguageDetectionAnalysisInput	Documenti da analizzare.
parameters		LanguageDetectionTaskParameters	parametri dell'attività.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene l'input dell'attività analizza testo PIIEntityRecognition.

Nome	Necessario	Tipo	Descrizione
kind	True	string: PiiEntityRecognition	Tipo di attività da eseguire.
analysisInput		MultiLanguageAnalysisInput	Contiene i documenti di input.
parameters		PiiTaskParameters	Parametri dell'attività Pii.

AnalyzeTextSentimentAnalysisInput

Contiene l'input dell'attività Analisi del testo SentimentAnalysis.

Nome	Necessario	Tipo	Descrizione
kind	True	string: SentimentAnalysis	Tipo di attività da eseguire.
analysisInput		MultiLanguageAnalysisInput	Contiene i documenti di input.
parameters		SentimentAnalysisTaskParameters	Parametri dell'attività Analisi del sentiment.

Risposte

Nome	Tipo	Descrizione
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
AgeMetadata	Rappresenta il modello di metadati dell'entità Age.
AgeUnit	Unità di misura dell'età
AllowOverlapEntityPolicyType	Rappresenta il criterio di sovrapposizione consenti. Non verrà applicata alcuna logica di post-elaborazione per le entità. Indipendentemente dal modello previsto, l'utente restituirà ciò che verrà restituito. In questo modo l'utente può ottenere una visualizzazione completa dei valori possibili di ogni singolo modello e applicare la propria logica personalizzata alla selezione di entità
AnalyzeTextEntityLinkingInput	Contiene l'input di collegamento dell'entità di analisi del testo.
AnalyzeTextEntityRecognitionInput	Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.
AnalyzeTextKeyPhraseExtractionInput	Contiene l'input dell'attività Analyze text KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contiene l'input dell'attività di analisi dei documenti di rilevamento della lingua.
AnalyzeTextPiiEntitiesRecognitionInput	Contiene l'input dell'attività analizza testo PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contiene l'input dell'attività Analisi del testo SentimentAnalysis.
AnalyzeTextTaskKind	Tipo di attività di analisi-testo supportate.
AnalyzeTextTaskResultsKind	Tipo di oggetto risposta restituito dall'attività analyze-text.
AreaMetadata	Rappresenta il modello di metadati dell'entità Area.
AreaUnit	Unità di misura dell'area.
CurrencyMetadata	Rappresenta il modello di metadati dell'entità Currency ).
DateMetadata	Metadati per le istanze di entità di data.
DateTimeMetadata	Metadati per le istanze di entità datetime.
DateValue	Rappresenta il valore della data.
DetectedLanguage	Contiene i dettagli della lingua rilevata per il testo.
DocumentError	Contiene i dettagli degli errori riscontrati durante l'esecuzione di un processo.
DocumentSentimentValue	Valutazione stimata per il documento (negativo, neutro, positivo o misto).
DocumentStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
DocumentWarning	Contiene l'oggetto avvisi con avvisi rilevati per il documento elaborato.
EntitiesDocumentResultWithMetadata	Risultato dei documenti di entità con metadati.
EntitiesResult	Contiene il risultato dell'attività di riconoscimento delle entità.
EntitiesTaskParameters	Parametri supportati per un'attività Riconoscimento entità.
EntitiesTaskResult	Contiene l'attività dell'entità
Entity	Definisce l'oggetto entità rilevato contenente la categoria di entità e il testo dell'entità rilevati e così via.
EntityCategory	Contiene tutte le categorie di entità rilevate dal riconoscimento delle entità.
EntityInferenceOptions	Classe che ospita le opzioni di inferenza consentite per il riconoscimento di entità denominate.
EntityLinkingResult	Risultato del collegamento di entità.
EntityLinkingTaskParameters	Parametri supportati per un'attività Entity Linking.
EntityLinkingTaskResult	Contiene il risultato dell'attività di collegamento dell'entità di testo di analisi.
EntityTag	Oggetto tag di entità che contiene il nome dei tag abd qualsiasi punteggio di attendibilità associato. I tag di entità vengono usati per esprimere alcune analogie/affinità tra entità.
EntityWithMetadata	Oggetto entità con tag e metadati.
Error	Oggetto di risposta di errore restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InformationMetadata	Rappresenta il modello di metadati dell'entità Information (data).
InformationUnit	Unità di misura delle informazioni (dati).
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Contiene KeyPhraseResult.
KeyPhrasesDocumentResult	Contiene i risultati dell'estrazione di frasi chiave per un documento.
KeyPhraseTaskParameters	Parametri supportati per un'attività Estrazione frasi chiave.
KeyPhraseTaskResult	Contiene il risultato dell'attività Analyze text KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contiene l'input di analisi dei documenti di rilevamento della lingua.
LanguageDetectionDocumentResult	Contiene il rilevamento della lingua per un documento.
LanguageDetectionResult	Contiene il risultato del rilevamento della lingua per la richiesta.
LanguageDetectionTaskParameters	Parametri supportati per un'attività Rilevamento lingua.
LanguageDetectionTaskResult	Contiene il risultato dell'attività di rilevamento della lingua per la richiesta.
LanguageInput	Contiene l'input di rilevamento della lingua.
LengthMetadata	Rappresenta il modello di metadati dell'entità Length.
LengthUnit	Unità di misura di lunghezza.
LinkedEntitiesDocumentResult	Risultato del documento di collegamento delle entità.
LinkedEntity	Oggetto LinkedEntity contenente l'entità rilevata con le origini/collegamenti associati.
Match	Oggetto Match contenente il testo dell'entità rilevata con l'offset e la lunghezza.
MatchLongestEntityPolicyType	Rappresenta i criteri di sovrapposizione più lunghi della corrispondenza. Nessuna entità sovrapposta per quanto possibile. 1. Se sono presenti entità sovrapposte, verrà restituita la più lunga. 2. Se il set di caratteri stimati per 2 o più entità è esattamente lo stesso, selezionare l'entità con il punteggio di attendibilità più elevato.3. Se i punteggi di entità sono identici, restituire tutte le entità ancora presenti dopo l'applicazione delle regole precedenti. 3. Se si verifica una sovrapposizione parziale (come in Hello Text Analytics) seguire i passaggi precedenti a partire da 1.
MetadataKind	Tipo di oggetto Metadata dell'entità.
MultiLanguageAnalysisInput	Raccolta di documenti di input da analizzare dal servizio.
MultiLanguageInput	Contiene un documento di input da analizzare dal servizio.
NumberKind	Tipo dell'entità numero estratto.
NumberMetadata	Metadati per le istanze di entità numeriche.
NumericRangeMetadata	rappresenta i metadati degli intervalli numerici.
OrdinalMetadata	Metadati per le istanze di entità numeriche.
PiiCategory	(Facoltativo) descrive le categorie di informazioni personali da restituire
PiiDomain	Dominio per l'attività PII
PiiEntitiesDocumentResult	Contiene i risultati delle informazioni personali.
PiiResult	Contiene PiiResult.
PiiTaskParameters	Parametri supportati per un'attività Riconoscimento entità personali.
PiiTaskResult	Contiene l'attività analisi del testo PIIEntityRecognition LRO.
RangeInclusivity	Inclusione dell'intervallo di questa proprietà di proprietà.
RangeKind	Tipo di entità dell'intervallo di numeri.
RelativeTo	Punto di riferimento che indica il numero ordinale.
RequestStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.
ScriptCode	Identifica lo script del documento di input. Esegue il mapping al codice di script standard ISO 15924.
ScriptKind	Identifica lo script del documento di input. Esegue il mapping al nome formale standard ISO 15924.
SentenceAssessment	Rappresenta una valutazione della frase e le valutazioni o gli oggetti di destinazione correlati.
SentenceSentiment	Sentiment della frase di un documento.
SentenceSentimentValue	Sentiment stimato per la frase.
SentenceTarget	Rappresenta una destinazione di frase e le valutazioni o gli oggetti di destinazione correlati.
SentimentAnalysisTaskParameters	Parametri supportati per un'attività Analisi del sentiment.
SentimentConfidenceScores	Rappresenta i punteggi di attendibilità compresi tra 0 e 1 in tutte le classi di sentiment: positivo, neutro, negativo.
SentimentDocumentResult	Oggetto che rappresenta i risultati predefiniti dell'analisi del sentiment di ogni documento.
SentimentResponse	Risultati dell'analisi del sentiment per i documenti di input.
SentimentTaskResult	Contiene il risultato dell'attività Analisi del testo SentimentAnalysis LRO.
SpeedMetadata	Rappresenta il modello di metadati dell'entità Speed.
SpeedUnit	Unità di misura della velocità
StringIndexType	Tipo di indice stringa
TargetConfidenceScoreLabel	Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo.
TargetRelation	Rappresenta la relazione tra valutazioni e/o destinazioni.
TargetRelationType	Tipo correlato alla destinazione.
TemperatureMetadata	Rappresenta il modello di metadati dell'entità Informazioni.
TemperatureUnit	Unità di misura della temperatura.
TemporalModifier	Modificatore facoltativo di un'istanza di data/ora.
TemporalSetMetadata	Metadati per le istanze di entità del set temporale.
TemporalSpanMetadata	rappresenta i metadati di una data e/o di un intervallo di tempo.
TemporalSpanValues	Oggetto intervallo temporale.
TimeMetadata	Metadati per le istanze dell'entità temporale.
TokenSentimentValue	Sentiment stimato per la frase.
VolumeMetadata	Rappresenta il modello metadati dell'entità volume.
VolumeUnit	Unità di misura del volume
WarningCodeValue	Definisce l'elenco dei codici di avviso.
WeightMetadata	Rappresenta il modello di metadati dell'entità Weight ).
WeightUnit	Unità di misura del peso.

AgeMetadata

Rappresenta il modello di metadati dell'entità Age.

Nome	Tipo	Descrizione
metadataKind	string: AgeMetadata	Tipo di oggetto Metadata dell'entità.
unit	AgeUnit	Unità di misura per l'età.
value	number	Valore numerico che indica il testo estratto.

AgeUnit

Unità di misura dell'età

Nome	Tipo	Descrizione
Day	string	Periodo di tempo di un giorno
Month	string	Periodo di tempo di un mese
Unspecified	string	Periodo di tempo non specificato
Week	string	Periodo di tempo di una settimana
Year	string	Periodo di tempo di un anno

AllowOverlapEntityPolicyType

Rappresenta il criterio di sovrapposizione consenti. Non verrà applicata alcuna logica di post-elaborazione per le entità. Indipendentemente dal modello previsto, l'utente restituirà ciò che verrà restituito. In questo modo l'utente può ottenere una visualizzazione completa dei valori possibili di ogni singolo modello e applicare la propria logica personalizzata alla selezione di entità

Nome	Tipo	Valore predefinito	Descrizione
policyKind	string: allowOverlap	matchLongest	Tipo di oggetto OverlapPolicy dell'entità.

AnalyzeTextEntityLinkingInput

Contiene l'input di collegamento dell'entità di analisi del testo.

Nome	Tipo	Descrizione
analysisInput	MultiLanguageAnalysisInput	Contiene l'input di analisi da gestire dal servizio.
kind	string: EntityLinking	Tipo di attività da eseguire.
parameters	EntityLinkingTaskParameters	Parametri dell'attività.

AnalyzeTextEntityRecognitionInput

Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.

Nome	Tipo	Descrizione
analysisInput	MultiLanguageAnalysisInput	Input da analizzare.
kind	string: EntityRecognition	Tipo di attività da eseguire.
parameters	EntitiesTaskParameters	Parametri dell'attività.

AnalyzeTextKeyPhraseExtractionInput

Contiene l'input dell'attività Analyze text KeyPhraseExtraction.

Nome	Tipo	Descrizione
analysisInput	MultiLanguageAnalysisInput	Contiene i documenti di input.
kind	string: KeyPhraseExtraction	Tipo di attività da eseguire.
parameters	KeyPhraseTaskParameters	Parametri dell'attività di estrazione frasi chiave.

AnalyzeTextLanguageDetectionInput

Contiene l'input dell'attività di analisi dei documenti di rilevamento della lingua.

Nome	Tipo	Descrizione
analysisInput	LanguageDetectionAnalysisInput	Documenti da analizzare.
kind	string: LanguageDetection	Tipo di attività da eseguire.
parameters	LanguageDetectionTaskParameters	parametri dell'attività.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene l'input dell'attività analizza testo PIIEntityRecognition.

Nome	Tipo	Descrizione
analysisInput	MultiLanguageAnalysisInput	Contiene i documenti di input.
kind	string: PiiEntityRecognition	Tipo di attività da eseguire.
parameters	PiiTaskParameters	Parametri dell'attività Pii.

AnalyzeTextSentimentAnalysisInput

Contiene l'input dell'attività Analisi del testo SentimentAnalysis.

Nome	Tipo	Descrizione
analysisInput	MultiLanguageAnalysisInput	Contiene i documenti di input.
kind	string: SentimentAnalysis	Tipo di attività da eseguire.
parameters	SentimentAnalysisTaskParameters	Parametri dell'attività Analisi del sentiment.

AnalyzeTextTaskKind

Tipo di attività di analisi-testo supportate.

Nome	Tipo	Descrizione
EntityLinking	string	Attività di collegamento delle entità
EntityRecognition	string	Attività di riconoscimento delle entità
KeyPhraseExtraction	string	Attività di estrazione frasi chiave
LanguageDetection	string	Attività di rilevamento della lingua
PiiEntityRecognition	string	Attività di riconoscimento delle entità personali
SentimentAnalysis	string	Attività di analisi del sentiment

AnalyzeTextTaskResultsKind

Tipo di oggetto risposta restituito dall'attività analyze-text.

Nome	Tipo	Descrizione
EntityLinkingResults	string	Risultati del collegamento di entità
EntityRecognitionResults	string	Risultati del riconoscimento delle entità
KeyPhraseExtractionResults	string	Risultati dell'estrazione di frasi chiave
LanguageDetectionResults	string	Risultati del rilevamento della lingua
PiiEntityRecognitionResults	string	Risultati del riconoscimento delle entità PII
SentimentAnalysisResults	string	Risultati dell'analisi del sentiment

AreaMetadata

Rappresenta il modello di metadati dell'entità Area.

Nome	Tipo	Descrizione
metadataKind	string: AreaMetadata	Tipo di oggetto Metadata dell'entità.
unit	AreaUnit	Unità di misura per l'area.
value	number	Valore numerico che indica il testo estratto.

AreaUnit

Unità di misura dell'area.

Nome	Tipo	Descrizione
Acre	string	Unità di area in acri
SquareCentimeter	string	Unità di area in centimetri quadrati
SquareDecameter	string	Unità di area in decametri quadrati
SquareDecimeter	string	Unità di area in decimetri quadrati
SquareFoot	string	Unità di area in piedi quadrati
SquareHectometer	string	Unità di area negli hectometri quadrati
SquareInch	string	Unità di area in pollici quadrati
SquareKilometer	string	Unità di zona in chilometri quadrati
SquareMeter	string	Unità di area in metri quadrati
SquareMile	string	Unità di area in miglia quadrate
SquareMillimeter	string	Unità di area in millimetri quadrati
SquareYard	string	Unità di zona in metri quadrati
Unspecified	string	Unità di area non specificata

CurrencyMetadata

Rappresenta il modello di metadati dell'entità Currency ).

Nome	Tipo	Descrizione
iso4217	string	Codice alfabetico basato su un altro standard ISO, ISO 3166, che elenca i codici per i nomi dei paesi. Le prime due lettere del codice ISO 4217 a tre lettere corrispondono al codice per il nome del paese e, ove possibile, la terza lettera corrisponde alla prima lettera del nome della valuta.
metadataKind	string: CurrencyMetadata	Tipo di oggetto Metadata dell'entità.
unit	string	Unità valuta.
value	number	Valore numerico che indica il testo estratto.

DateMetadata

Metadati per le istanze di entità di data.

Nome	Tipo	Descrizione
dateValues	DateValue[]	Elenco di valori di data.
metadataKind	string: DateMetadata	Tipo di oggetto Metadata dell'entità.

DateTimeMetadata

Metadati per le istanze di entità datetime.

Nome	Tipo	Descrizione
dateValues	DateValue[]	Elenco di valori di data.
metadataKind	string: DateTimeMetadata	Tipo di oggetto Metadata dell'entità.

DateValue

Rappresenta il valore della data.

Nome	Tipo	Descrizione
modifier	TemporalModifier	Modificatore per datetime per indicare il punto di riferimento come prima, dopo e così via.
timex	string	Rappresentazione di data/ora ISO 8601 estesa come descritto in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Ora effettiva in cui il testo estratto indica.

DetectedLanguage

Contiene i dettagli della lingua rilevata per il testo.

Nome	Tipo	Descrizione
confidenceScore	number	Punteggio di attendibilità compreso tra 0 e 1. I punteggi vicini a 1 indicano 100% certezza che la lingua identificata sia vera.
iso6391Name	string	Rappresentazione di due lettere della lingua rilevata in base allo standard ISO 639-1 (ad esempio en, fr).
name	string	Nome lungo di una lingua rilevata (ad esempio inglese, francese).
scriptIso15924Code	ScriptCode	Identifica il codice script del documento di input in base allo standard ISO 15924.
scriptName	ScriptKind	Identifica il nome dello script del documento di input in base allo standard ISO 15924.

DocumentError

Contiene i dettagli degli errori riscontrati durante l'esecuzione di un processo.

Nome	Tipo	Descrizione
error	Error	Si è verificato un errore.
id	string	ID del documento di input.

DocumentSentimentValue

Valutazione stimata per il documento (negativo, neutro, positivo o misto).

Nome	Tipo	Descrizione
mixed	string	Istruzione mista
negative	string	Istruzione negativa
neutral	string	Istruzione neutra
positive	string	Dichiarazione positiva

DocumentStatistics

se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.

Nome	Tipo	Descrizione
charactersCount	integer	Numero di elementi di testo riconosciuti nel documento.
transactionsCount	integer	Numero di transazioni per il documento.

DocumentWarning

Contiene l'oggetto avvisi con avvisi rilevati per il documento elaborato.

Nome	Tipo	Descrizione
code	WarningCodeValue	Codice di avviso.
message	string	Messaggio di avviso.
targetRef	string	Riferimento puntatore JSON che indica l'oggetto di destinazione.

EntitiesDocumentResultWithMetadata

Risultato dei documenti di entità con metadati.

Nome	Tipo	Descrizione
entities	EntityWithMetadata[]	Entità riconosciute nel documento.
id	string	Identificatore di documento univoco e non vuoto.
statistics	DocumentStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
warnings	DocumentWarning[]	Avvisi rilevati durante l'elaborazione del documento.

EntitiesResult

Contiene il risultato dell'attività di riconoscimento delle entità.

Nome	Tipo	Descrizione
documents	EntitiesDocumentResultWithMetadata[]	Risposta per documento
errors	DocumentError[]	Errori in base all'ID documento.
modelVersion	string	Questo campo indica quale modello viene usato per l'assegnazione dei punteggi.
statistics	RequestStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.

EntitiesTaskParameters

Parametri supportati per un'attività Riconoscimento entità.

Nome	Tipo	Valore predefinito	Descrizione
exclusionList	EntityCategory[]		(Facoltativo) parametro di richiesta che filtra tutte le entità incluse nell'excludeList. Quando un utente specifica un elemento excludeList, non può ottenere una stima restituita con un'entità in tale elenco. L'inclusionList verrà applicata prima di exclusionList
inclusionList	EntityCategory[]		(Facoltativo) parametro di richiesta che limita l'output ai tipi di entità richiesti inclusi in questo elenco. L'inclusionList verrà applicata prima di exclusionList
inferenceOptions	EntityInferenceOptions		(Facoltativo) parametro di richiesta che consente all'utente di specificare le impostazioni per l'esecuzione dell'inferenza.
loggingOptOut	boolean	False	rifiutare esplicitamente la registrazione
modelVersion	string	latest	versione del modello
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Facoltativo) descrive il tipo di criteri di sovrapposizione da applicare all'output del ner.
stringIndexType	StringIndexType	TextElements_v8	(Facoltativo) parametro per specificare il tipo di indice stringa usato per interpretare gli offset di stringa. Il valore predefinito è TextElements (Graphemes).

EntitiesTaskResult

Contiene l'attività dell'entità

Nome	Tipo	Descrizione
kind	string: EntityRecognitionResults	Tipo di risultato dell'attività.
results	EntitiesResult	Risultati per il riconoscimento delle entità.

Entity

Definisce l'oggetto entità rilevato contenente la categoria di entità e il testo dell'entità rilevati e così via.

Nome	Tipo	Descrizione
category	string	Tipo di entità.
confidenceScore	number	Punteggio di confidenza compreso tra 0 e 1 dell'entità estratta.
length	integer	Lunghezza per il testo dell'entità. L'uso di valori 'stringIndexType' diversi può influire sulla lunghezza restituita.
offset	integer	Posizione iniziale per il testo dell'entità. L'uso di valori 'stringIndexType' diversi può influire sull'offset restituito.
subcategory	string	(Facoltativo) Sottotipo di entità.
text	string	Testo dell'entità visualizzato nella richiesta.

EntityCategory

Contiene tutte le categorie di entità rilevate dal riconoscimento delle entità.

Nome	Tipo	Descrizione
Address	string	Menzioni specifiche a livello di strada di località: numeri di casa/edificio, strade, strade, autostrade, intersezioni a cui fa riferimento il nome.
Age	string	Valori correlati all'età.
Airport	string	Gli aeroporti.
Area	string	Area di un oggetto.
City	string	Valori correlati alla città.
ComputingProduct	string	Prodotti informatici.
Continent	string	Valori correlati al continente.
CountryRegion	string	Valori correlati al paese o all'area geografica.
CulturalEvent	string	Valori relativi agli eventi culturali.
Currency	string	Valori correlati alla valuta.
Date	string	Date del calendario.
DateRange	string	Intervallo di date.
DateTime	string	Date del calendario con ora.
DateTimeRange	string	Intervallo di data e ora.
Dimension	string	Dimensione delle misurazioni
Duration	string	Durata del tempo.
Email	string	Indirizzi di posta elettronica.
Event	string	Eventi sociali, sportivi, commerciali, politici, educativi, naturali, storici, criminali, violenti, legali, militari con un periodo di tempo.
GPE	string	Città, paesi/aree geografiche, stati.
Geological	string	Caratteristiche geografiche e naturali come fiumi, oceani e deserti.
Height	string	Altezza di un oggetto.
IP	string	indirizzi IP di rete.
Information	string	Unità di misura per le informazioni digitali.
Length	string	Lunghezza di un oggetto.
Location	string	Punto o luogo specifico nello spazio fisico.
NaturalEvent	string	Valori relativi agli eventi naturali.
Number	string	Numeri senza unità
NumberRange	string	Intervallo di numeri
Numeric	string	Valori numerici, incluse cifre e parole numeriche.
Ordinal	string	Numeri ordinali.
Organization	string	Società, agenzie e altri gruppi di persone definite da una struttura organizzativa consolidata. Queste etichette possono includere società, partiti politici/movimenti, bande musicali, club sportivi, enti governativi e organizzazioni pubbliche. Nazionalità o religioni non sono ORGANIZZAZIONE.
OrganizationMedical	string	Aziende mediche e gruppi.
OrganizationSports	string	Organizzazioni correlate allo sport.
OrganizationStockExchange	string	Gruppi di borsa.
Percentage	string	Valori correlati alla percentuale.
Person	string	First, last, and middle names, names of fictional characters, and aliases. Titoli, ad esempio 'Mr.' o "Presidente", non sono considerati parte dell'entità denominata.
PersonType	string	Ruoli umani classificati da un'appartenenza a un gruppo.
PhoneNumber	string	Numeri di telefono (solo numeri di telefono usa e ue).
Product	string	Singolo o gruppo di oggetti commerciali, di consumo, elettronica, veicoli, gruppi alimentari.
SetTemporal	string	Set di valori correlati al tempo.
Skill	string	Una capacità, una competenza o un'esperienza.
Speed	string	Velocità di un oggetto.
SportsEvent	string	Valori correlati agli eventi sportivi.
State	string	Valori correlati allo stato.
Structural	string	Strutture fatte dall'uomo.
Temperature	string	Valori relativi alla temperatura.
Temporal	string	Elementi relativi all'ora.
Time	string	Orari del giorno.
TimeRange	string	Intervallo di volte.
URL	string	URL ai siti Web.
Volume	string	Volume di un oggetto.
Weight	string	Peso di un oggetto.

EntityInferenceOptions

Classe che ospita le opzioni di inferenza consentite per il riconoscimento di entità denominate.

Nome	Tipo	Valore predefinito	Descrizione
excludeNormalizedValues	boolean	False	Opzione per includere/escludere i valori di entità rilevati da normalizzare e includere nei metadati. I tipi di entità numerici e temporali supportano la normalizzazione dei valori.

EntityLinkingResult

Risultato del collegamento di entità.

Nome	Tipo	Descrizione
documents	LinkedEntitiesDocumentResult[]	Risposta per documento
errors	DocumentError[]	Errori in base all'ID documento.
modelVersion	string	Questo campo indica quale modello viene usato per l'assegnazione dei punteggi.
statistics	RequestStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.

EntityLinkingTaskParameters

Parametri supportati per un'attività Entity Linking.

Nome	Tipo	Valore predefinito	Descrizione
loggingOptOut	boolean	False	rifiutare esplicitamente la registrazione
modelVersion	string	latest	versione del modello
stringIndexType	StringIndexType	TextElements_v8	Parametro facoltativo per specificare il tipo di indice stringa usato per interpretare gli offset di stringa. Il valore predefinito è TextElements (Graphemes).

EntityLinkingTaskResult

Contiene il risultato dell'attività di collegamento dell'entità di testo di analisi.

Nome	Tipo	Descrizione
kind	string: EntityLinkingResults	Tipo di risultato dell'attività.
results	EntityLinkingResult	Risultato del collegamento di entità.

EntityTag

Oggetto tag di entità che contiene il nome dei tag abd qualsiasi punteggio di attendibilità associato. I tag di entità vengono usati per esprimere alcune analogie/affinità tra entità.

Nome	Tipo	Descrizione
confidenceScore	number	Punteggio di rilevamento compreso tra 0 e 1 dell'entità estratta.
name	string	Nome del tag. I nomi dei tag di entità saranno univoci a livello globale.

EntityWithMetadata

Oggetto entità con tag e metadati.

Nome	Tipo	Descrizione
category	string	Tipo di entità.
confidenceScore	number	Punteggio di confidenza compreso tra 0 e 1 dell'entità estratta.
length	integer	Lunghezza per il testo dell'entità. L'uso di valori 'stringIndexType' diversi può influire sulla lunghezza restituita.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Oggetto metadati dell'entità.
offset	integer	Posizione iniziale per il testo dell'entità. L'uso di valori 'stringIndexType' diversi può influire sull'offset restituito.
subcategory	string	(Facoltativo) Sottotipo di entità.
tags	EntityTag[]	Elenco di tag di entità. I tag devono esprimere alcune analogie/affinità tra entità.
text	string	Testo dell'entità visualizzato nella richiesta.
type	string	Un tipo di entità è la granularità minima (o migliore) in base alla quale è stata rilevata l'entità. Il tipo esegue il mapping agli attributi di metadati specifici associati all'entità rilevata.

Error

Oggetto di risposta di errore restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
AzureCognitiveSearchIndexLimitReached	string	Errore raggiunto dal limite di indice di Ricerca cognitiva di Azure
AzureCognitiveSearchIndexNotFound	string	Errore non trovato nell'indice di Ricerca cognitiva di Azure
AzureCognitiveSearchNotFound	string	Errore di Ricerca cognitiva di Azure non trovato
AzureCognitiveSearchThrottling	string	Errore di limitazione della limitazione di Ricerca cognitiva di Azure
Conflict	string	Errore di conflitto
Forbidden	string	Errore di accesso negato
InternalServerError	string	Errore interno del server
InvalidArgument	string	Errore di argomento non valido
InvalidRequest	string	Errore di richiesta non valido
NotFound	string	Errore non trovato
OperationNotFound	string	Errore di operazione non trovata
ProjectNotFound	string	Errore di progetto non trovato
QuotaExceeded	string	Errore di superamento della quota
ServiceUnavailable	string	Errore di servizio non disponibile
Timeout	string	Errore di timeout
TooManyRequests	string	Errore di troppe richieste
Unauthorized	string	Errore di accesso non autorizzato
Warning	string	Errore di avviso

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InformationMetadata

Rappresenta il modello di metadati dell'entità Information (data).

Nome	Tipo	Descrizione
metadataKind	string: InformationMetadata	Tipo di oggetto Metadata dell'entità.
unit	InformationUnit	Unità di misura per informazioni.
value	number	Valore numerico che indica il testo estratto.

InformationUnit

Unità di misura delle informazioni (dati).

Nome	Tipo	Descrizione
Bit	string	Unità dimensioni dati in bit
Byte	string	Unità dimensioni dati in byte
Gigabit	string	Unità dimensioni dati in gigabit
Gigabyte	string	Unità dimensioni dati in gigabyte
Kilobit	string	Unità di dimensioni dei dati in kilobit
Kilobyte	string	Unità dimensioni dati in kilobyte
Megabit	string	Unità dimensioni dati in megabit
Megabyte	string	Unità dimensioni dati in megabyte
Petabit	string	Unità di dimensioni dei dati in petabit
Petabyte	string	Unità dimensioni dati in petabyte
Terabit	string	Unità di dimensioni dei dati in terabit
Terabyte	string	Unità dimensioni dati in terabyte
Unspecified	string	Unità dimensioni dati non specificate

InnerErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
AzureCognitiveSearchNotFound	string	Errore di Ricerca cognitiva di Azure non trovato
AzureCognitiveSearchThrottling	string	Errore di limitazione della limitazione di Ricerca cognitiva di Azure
EmptyRequest	string	Errore di richiesta vuota
ExtractionFailure	string	Errore di estrazione
InvalidCountryHint	string	Errore di hint paese non valido
InvalidDocument	string	Errore del documento non valido
InvalidDocumentBatch	string	Errore del batch di documenti non valido
InvalidParameterValue	string	Errore del valore del parametro non valido
InvalidRequest	string	Errore di richiesta non valido
InvalidRequestBodyFormat	string	Errore di formato del corpo della richiesta non valido
KnowledgeBaseNotFound	string	Errore della Knowledge Base non trovato
MissingInputDocuments	string	Errore dei documenti di input mancanti
ModelVersionIncorrect	string	Errore di versione del modello non corretto
UnsupportedLanguageCode	string	Errore di codice della lingua non supportato

InnerErrorModel

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

KeyPhraseResult

Contiene KeyPhraseResult.

Nome	Tipo	Descrizione
documents	KeyPhrasesDocumentResult[]	Risposta per documento
errors	DocumentError[]	Errori in base all'ID documento.
modelVersion	string	Questo campo indica quale modello viene usato per l'assegnazione dei punteggi.
statistics	RequestStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.

KeyPhrasesDocumentResult

Contiene i risultati dell'estrazione di frasi chiave per un documento.

Nome	Tipo	Descrizione
id	string	Identificatore di documento univoco e non vuoto.
keyPhrases	string[]	Elenco di parole o frasi rappresentative. Il numero di frasi chiave restituite è proporzionale al numero di parole nel documento di input.
statistics	DocumentStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
warnings	DocumentWarning[]	Avvisi rilevati durante l'elaborazione del documento.

KeyPhraseTaskParameters

Parametri supportati per un'attività Estrazione frasi chiave.

Nome	Tipo	Valore predefinito	Descrizione
loggingOptOut	boolean	False	rifiutare esplicitamente la registrazione
modelVersion	string	latest	versione del modello

KeyPhraseTaskResult

Contiene il risultato dell'attività Analyze text KeyPhraseExtraction.

Nome	Tipo	Descrizione
kind	string: KeyPhraseExtractionResults	Tipo di risultato dell'attività.
results	KeyPhraseResult	Elenco dei risultati dell'estrazione di frasi chiave

LanguageDetectionAnalysisInput

Contiene l'input di analisi dei documenti di rilevamento della lingua.

Nome	Tipo	Descrizione
documents	LanguageInput[]	Elenco di documenti da analizzare.

LanguageDetectionDocumentResult

Contiene il rilevamento della lingua per un documento.

Nome	Tipo	Descrizione
detectedLanguage	DetectedLanguage	Lingua rilevata.
id	string	Identificatore di documento univoco e non vuoto.
statistics	DocumentStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
warnings	DocumentWarning[]	Avvisi rilevati durante l'elaborazione del documento.

LanguageDetectionResult

Contiene il risultato del rilevamento della lingua per la richiesta.

Nome	Tipo	Descrizione
documents	LanguageDetectionDocumentResult[]	Enumerazione dei risultati del rilevamento della lingua per ogni documento di input.
errors	DocumentError[]	Errori in base all'ID documento.
modelVersion	string	Questo campo indica quale modello viene usato per l'assegnazione dei punteggi.
statistics	RequestStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.

LanguageDetectionTaskParameters

Parametri supportati per un'attività Rilevamento lingua.

Nome	Tipo	Valore predefinito	Descrizione
loggingOptOut	boolean	False	rifiutare esplicitamente la registrazione
modelVersion	string	latest	versione del modello

LanguageDetectionTaskResult

Contiene il risultato dell'attività di rilevamento della lingua per la richiesta.

Nome	Tipo	Descrizione
kind	string: LanguageDetectionResults	Tipo di risultato dell'attività.
results	LanguageDetectionResult	Contiene i risultati del rilevamento della lingua.

LanguageInput

Contiene l'input di rilevamento della lingua.

Nome	Tipo	Descrizione
countryHint	string	Suggerimento per il paese per facilitare il rilevamento della lingua del testo.
id	string	Identificatore di documento univoco e non vuoto.
text	string	Testo di input da elaborare.

LengthMetadata

Rappresenta il modello di metadati dell'entità Length.

Nome	Tipo	Descrizione
metadataKind	string: LengthMetadata	Tipo di oggetto Metadata dell'entità.
unit	LengthUnit	Unità di misura per la lunghezza.
value	number	Valore numerico che indica il testo estratto.

LengthUnit

Unità di misura di lunghezza.

Nome	Tipo	Descrizione
Centimeter	string	Unità di lunghezza in centimetri.
Decameter	string	Unità di lunghezza in decametri.
Decimeter	string	Unità di lunghezza in decimetri.
Foot	string	Unità di lunghezza in piedi.
Hectometer	string	Unità di lunghezza negli ectometri.
Inch	string	Unità di lunghezza in pollici.
Kilometer	string	Unità di lunghezza in chilometri.
LightYear	string	Unità di lunghezza negli anni leggeri.
Meter	string	Unità di lunghezza in metri.
Micrometer	string	Unità di lunghezza in micrometri.
Mile	string	Unità di lunghezza in miglia.
Millimeter	string	Unità di lunghezza in millimetri.
Nanometer	string	Unità di lunghezza in nanometri.
Picometer	string	Unità di lunghezza in picometri.
Point	string	Unità di lunghezza espressa in punti.
Unspecified	string	Unità di lunghezza non specificata.
Yard	string	Unità di lunghezza in yard.

LinkedEntitiesDocumentResult

Risultato del documento di collegamento delle entità.

Nome	Tipo	Descrizione
entities	LinkedEntity[]	Entità note riconosciute nel documento.
id	string	Identificatore di documento univoco e non vuoto.
statistics	DocumentStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
warnings	DocumentWarning[]	Avvisi rilevati durante l'elaborazione del documento.

LinkedEntity

Oggetto LinkedEntity contenente l'entità rilevata con le origini/collegamenti associati.

Nome	Tipo	Descrizione
bingId	string	Identificatore univoco dell'API Ricerca entità Bing dell'entità riconosciuta.
dataSource	string	Origine dati usata per estrarre il collegamento di entità, ad esempio Wiki/Bing e così via.
id	string	Identificatore univoco dell'entità riconosciuta dall'origine dati.
language	string	Lingua utilizzata nell'origine dati.
matches	Match[]	L'elenco di istanze di questa entità viene visualizzato nel testo.
name	string	Nome formale di Entity Linking.
url	string	URL della pagina dell'entità dall'origine dati.

Match

Oggetto Match contenente il testo dell'entità rilevata con l'offset e la lunghezza.

Nome	Tipo	Descrizione
confidenceScore	number	Se viene riconosciuto un elemento noto, verrà restituito un numero decimale che indica il livello di confidenza compreso tra 0 e 1.
length	integer	Lunghezza per il testo della corrispondenza dell'entità.
offset	integer	Posizione iniziale per il testo della corrispondenza dell'entità.
text	string	Testo dell'entità visualizzato nella richiesta.

MatchLongestEntityPolicyType

Rappresenta i criteri di sovrapposizione più lunghi della corrispondenza. Nessuna entità sovrapposta per quanto possibile. 1. Se sono presenti entità sovrapposte, verrà restituita la più lunga. 2. Se il set di caratteri stimati per 2 o più entità è esattamente lo stesso, selezionare l'entità con il punteggio di attendibilità più elevato.3. Se i punteggi di entità sono identici, restituire tutte le entità ancora presenti dopo l'applicazione delle regole precedenti. 3. Se si verifica una sovrapposizione parziale (come in Hello Text Analytics) seguire i passaggi precedenti a partire da 1.

Nome	Tipo	Valore predefinito	Descrizione
policyKind	string: matchLongest	matchLongest	Tipo di oggetto OverlapPolicy dell'entità.

MetadataKind

Tipo di oggetto Metadata dell'entità.

Nome	Tipo	Descrizione
AgeMetadata	string	Metadati per i valori correlati all'età.
AreaMetadata	string	Metadati per i valori correlati all'area.
CurrencyMetadata	string	Metadati per i valori correlati alla valuta.
DateMetadata	string	Metadati per i valori correlati alla data.
DateTimeMetadata	string	Metadati per i valori relativi a data e ora.
InformationMetadata	string	Metadati per i valori correlati alle informazioni.
LengthMetadata	string	Metadati per i valori correlati alla lunghezza.
NumberMetadata	string	Metadati per i valori numerici.
NumericRangeMetadata	string	Metadati per i valori di intervallo numerico.
OrdinalMetadata	string	Metadati per i numeri ordinali.
SpeedMetadata	string	Metadati per i valori correlati alla velocità.
TemperatureMetadata	string	Metadati per i valori relativi alla temperatura.
TemporalSetMetadata	string	Metadati per il set di valori correlati al tempo.
TemporalSpanMetadata	string	Metadati per i valori dell'intervallo temporale.
TimeMetadata	string	Metadati per i valori correlati al tempo.
VolumeMetadata	string	Metadati per i valori correlati al volume.
WeightMetadata	string	Metadati per i valori correlati al peso.

MultiLanguageAnalysisInput

Raccolta di documenti di input da analizzare dal servizio.

Nome	Tipo	Descrizione
documents	MultiLanguageInput[]	Documenti di input da analizzare.

MultiLanguageInput

Contiene un documento di input da analizzare dal servizio.

Nome	Tipo	Descrizione
id	string	Identificatore di documento univoco e non vuoto.
language	string	(Facoltativo) Questa è la rappresentazione ISO 639-1 di 2 lettere di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo ecc. Se non è impostato, usare "en" per l'inglese come impostazione predefinita. (Di seguito si applica solo a 2023-04-15-preview e versioni successive) Per rilevamento automatico della lingua, usare "auto". Se non è impostato, usare "en" per l'inglese come impostazione predefinita.
text	string	Testo di input da elaborare.

NumberKind

Tipo dell'entità numero estratto.

Nome	Tipo	Descrizione
Decimal	string	Numero decimale
Fraction	string	Numero frazionario
Integer	string	Numero intero
Percent	string	Numero percentuale
Power	string	Numero di alimentazione
Unspecified	string	Tipo di numero non specificato

NumberMetadata

Metadati per le istanze di entità numeriche.

Nome	Tipo	Descrizione
metadataKind	string: NumberMetadata	Tipo di oggetto Metadata dell'entità.
numberKind	NumberKind	Tipo di tipo numero.
value	number	Rappresentazione numerica di ciò che il testo estratto indica.

NumericRangeMetadata

rappresenta i metadati degli intervalli numerici.

Nome	Tipo	Descrizione
maximum	number	Valore finale dell'intervallo.
metadataKind	string: NumericRangeMetadata	Tipo di oggetto Metadata dell'entità.
minimum	number	Valore iniziale dell'intervallo.
rangeInclusivity	RangeInclusivity	Inclusività di questo intervallo.
rangeKind	RangeKind	Tipo di intervalli numerici supportati, ad esempio Numero, Velocità e così via.

OrdinalMetadata

Metadati per le istanze di entità numeriche.

Nome	Tipo	Descrizione
metadataKind	string: OrdinalMetadata	Tipo di oggetto Metadata dell'entità.
offset	string	Offset rispetto al riferimento ,ad esempio offset = -1 indica il secondo all'ultimo)
relativeTo	RelativeTo	Punto di riferimento che indica il numero ordinale.
value	string	Espressione aritmetica semplice che indica l'ordinale.

PiiCategory

(Facoltativo) descrive le categorie di informazioni personali da restituire

Nome	Tipo	Descrizione
ABARoutingNumber	string	Numero di routing ABA
ARNationalIdentityNumber	string	AR National Identity Number
ATIdentityCard	string	Carta di identità AT
ATTaxIdentificationNumber	string	Numero di identificazione fiscale AT
ATValueAddedTaxNumber	string	AT Value Added Tax Number
AUBankAccountNumber	string	Carta di identità AT
AUBusinessNumber	string	AU Business Number
AUCompanyNumber	string	AU Company Number
AUDriversLicenseNumber	string	AU Driver's License Number
AUMedicalAccountNumber	string	AU Medical Account Number
AUPassportNumber	string	AU Passport Number
AUTaxFileNumber	string	AU Tax File Number
Address	string	Indirizzo
Age	string	Età
All	string	Tutte le categorie PII.
AzureDocumentDBAuthKey	string	Chiave di autenticazione del database di documenti di Azure
AzureIAASDatabaseConnectionAndSQLString	string	Connessione al database IAAS di Azure e stringa SQL
AzureIoTConnectionString	string	Stringa di connessione di Azure IoT
AzurePublishSettingPassword	string	Password dell'impostazione di pubblicazione di Azure
AzureRedisCacheString	string	Stringa di Cache Redis di Azure
AzureSAS	string	Firma di accesso condiviso di Azure
AzureServiceBusString	string	Stringa del bus di servizio di Azure
AzureStorageAccountGeneric	string	Account di archiviazione di Azure generico
AzureStorageAccountKey	string	Chiave dell'account di archiviazione di Azure
BENationalNumber	string	BE National Number
BENationalNumberV2	string	BE National Number V2
BEValueAddedTaxNumber	string	BE Value Added Tax Number
BGUniformCivilNumber	string	Numero civile uniforme BG
BRCPFNumber	string	Numero CPF BR
BRLegalEntityNumber	string	Numero di persona giuridica BR
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	CA Bank Account Number
CADriversLicenseNumber	string	Numero di licenza del driver CA
CAHealthServiceNumber	string	Numero servizio integrità CA
CAPassportNumber	string	CA Passport Number
CAPersonalHealthIdentification	string	Identificazione dell'integrità personale della CA
CASocialInsuranceNumber	string	CA Social Insurance Number
CHSocialSecurityNumber	string	Numero di previdenza sociale CH
CLIdentityCardNumber	string	Numero di carta di identità CL
CNResidentIdentityCardNumber	string	Numero di carta di identità residente CN
CYIdentityCard	string	Carta di identità CY
CYTaxIdentificationNumber	string	CY Tax Identification Number
CZPersonalIdentityNumber	string	NUMERO di identità personale DISAS
CZPersonalIdentityV2	string	IDENTITÀ PERSONALE DI WINDOWS V2
CreditCardNumber	string	Numero carta di credito
DEDriversLicenseNumber	string	DE Driver's License Number
DEIdentityCardNumber	string	DE Identity Card Number
DEPassportNumber	string	DE Passport Number
DETaxIdentificationNumber	string	DE Tax Identification Number
DEValueAddedNumber	string	Numero aggiunto valore DE
DKPersonalIdentificationNumber	string	DK Personal Identification Number
DKPersonalIdentificationV2	string	Identificazione personale DK V2
Date	string	Dattero
Default	string	Categorie di informazioni personali predefinite per la lingua.
DrugEnforcementAgencyNumber	string	Numero dell'agenzia per l'applicazione di droga
EEPersonalIdentificationCode	string	Codice di identificazione personale EE
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Numero di previdenza sociale ES
ESTaxIdentificationNumber	string	Numero di identificazione fiscale ES
EUDebitCardNumber	string	Numero di carta di debito UE
EUDriversLicenseNumber	string	Numero di patente del conducente dell'UE
EUGPSCoordinates	string	Coordinate GPS DELL'UE
EUNationalIdentificationNumber	string	Numero di identificazione nazionale UE
EUPassportNumber	string	Numero passaporto UE
EUSocialSecurityNumber	string	Numero di previdenza sociale UE
EUTaxIdentificationNumber	string	Numero di identificazione fiscale UE
Email	string	E-mail
FIEuropeanHealthNumber	string	FI European Health Number
FINationalID	string	FI National ID
FINationalIDV2	string	FI National ID V2
FIPassportNumber	string	FI Passport Number
FRDriversLicenseNumber	string	Numero di patente del conducente FR
FRHealthInsuranceNumber	string	FR Health Insurance Number
FRNationalID	string	ID nazionale FR
FRPassportNumber	string	Numero passaporto FR
FRSocialSecurityNumber	string	Fr Numero previdenza sociale
FRTaxIdentificationNumber	string	Numero di identificazione fiscale FR
FRValueAddedTaxNumber	string	Numero di imposta aggiunto valore FR
GRNationalIDCard	string	Scheda ID nazionale gr
GRNationalIDV2	string	ID nazionale gr V2
GRTaxIdentificationNumber	string	Numero di identificazione fiscale gr
HKIdentityCardNumber	string	HK Identity Card Number
HRIdentityCardNumber	string	Numero di carta di identità HR
HRNationalIDNumber	string	HR National ID Number
HRPersonalIdentificationNumber	string	Numero di identificazione personale HR
HRPersonalIdentificationOIBNumberV2	string	HR Personal Identification OIB Number V2
HUPersonalIdentificationNumber	string	HU Personal Identification Number
HUTaxIdentificationNumber	string	Numero di identificazione fiscale HU
HUValueAddedNumber	string	Numero aggiunto valore HU
IDIdentityCardNumber	string	ID Identity Card Number
IEPersonalPublicServiceNumber	string	Numero di servizio pubblico personale di Internet Explorer
IEPersonalPublicServiceNumberV2	string	Numero di servizio pubblico personale IE V2
ILBankAccountNumber	string	Numero conto corrente bancario IL
ILNationalID	string	ID nazionale IL
INPermanentAccount	string	Account permanente IN
INUniqueIdentificationNumber	string	IN Numero di identificazione univoco
IPAddress	string	Indirizzo IP
ITDriversLicenseNumber	string	Numero di licenza del driver IT
ITFiscalCode	string	Codice fiscale IT
ITValueAddedTaxNumber	string	Numero di imposta aggiunto valore IT
InternationalBankingAccountNumber	string	Numero conto bancario internazionale
JPBankAccountNumber	string	Numero conto corrente bancario JP
JPDriversLicenseNumber	string	Numero di licenza del driver JP
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	Numero di passaporto JP
JPResidenceCardNumber	string	Numero di carta di residenza JP
JPResidentRegistrationNumber	string	Numero di registrazione residente JP
JPSocialInsuranceNumber	string	JP Social Insurance Number
KRResidentRegistrationNumber	string	Numero di registrazione residente KR
LTPersonalCode	string	Codice personale LT
LUNationalIdentificationNumberNatural	string	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	string	Numero di identificazione nazionale LU non naturale
LVPersonalCode	string	Codice personale LV
MTIdentityCardNumber	string	Numero di carta di identità MT
MTTaxIDNumber	string	NUMERO DI PARTITA IVA MT
MYIdentityCardNumber	string	MY Identity Card Number
NLCitizensServiceNumber	string	NL Citizens Service Number
NLCitizensServiceNumberV2	string	NL Citizens Service Number V2
NLTaxIdentificationNumber	string	Numero di identificazione fiscale NL
NLValueAddedTaxNumber	string	NL Value Added Tax Number
NOIdentityNumber	string	NO Identity Number
NZBankAccountNumber	string	Numero conto bancario NZ
NZDriversLicenseNumber	string	Numero di patente del driver NZ
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	Numero di salute del Ministero della Sanità NZ
NZSocialWelfareNumber	string	NZ Social Welfare Number
Organization	string	Organizzazione
PHUnifiedMultiPurposeIDNumber	string	PH Unified Multi Purpose ID Number
PLIdentityCard	string	PL Identity Card
PLNationalID	string	ID nazionale PL
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	PL Passport Number
PLREGONNumber	string	PL REGON Number
PLTaxIdentificationNumber	string	Numero di identificazione fiscale PL
PTCitizenCardNumber	string	PT Citizen Card Number
PTCitizenCardNumberV2	string	PT Citizen Card Number V2
PTTaxIdentificationNumber	string	Numero di identificazione fiscale PT
Person	string	Persona
PhoneNumber	string	Numero di telefono
ROPersonalNumericalCode	string	Codice numerico personale RO
RUPassportNumberDomestic	string	Numero di passaporto UR Nazionale
RUPassportNumberInternational	string	Numero di passaporto UR International
SANationalID	string	ID nazionale SA
SENationalID	string	SE National ID
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	SE Passport Number
SETaxIdentificationNumber	string	SE Tax Identification Number
SGNationalRegistrationIdentityCardNumber	string	Numero di carta di identità di registrazione nazionale SG
SITaxIdentificationNumber	string	Numero di identificazione fiscale SI
SIUniqueMasterCitizenNumber	string	SI Unique Master Citizen Number
SKPersonalNumber	string	SK Personal Number
SQLServerConnectionString	string	Stringa di connessione di SQL Server
SWIFTCode	string	Codice SWIFT
THPopulationIdentificationCode	string	Codice di identificazione popolazione TH
TRNationalIdentificationNumber	string	Numero di identificazione nazionale TR
TWNationalID	string	ID nazionale TW
TWPassportNumber	string	TW Passport Number
TWResidentCertificate	string	Certificato residente TW
UAPassportNumberDomestic	string	UA Passport Number Domestic
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	Numero di patente del conducente britannico
UKElectoralRollNumber	string	Numero di rollback elettorale britannico
UKNationalHealthNumber	string	Numero di salute nazionale del Regno Unito
UKNationalInsuranceNumber	string	UK National Insurance Number
UKUniqueTaxpayerNumber	string	Regno Unito Numero contribuente univoco
URL	string	URL
USBankAccountNumber	string	Us Bank Conto Number
USDriversLicenseNumber	string	US Driver's License Number
USIndividualTaxpayerIdentification	string	Identificazione individuale dei contribuenti statunitensi
USSocialSecurityNumber	string	US Social Security Number
USUKPassportNumber	string	US UK Passport Number
ZAIdentificationNumber	string	Numero di identificazione ZA

PiiDomain

Dominio per l'attività PII

Nome	Tipo	Descrizione
none	string	Indica che non è specificato alcun dominio.
phi	string	Indica che le entità nel dominio Informazioni sull'integrità personali devono essere elaborate.

PiiEntitiesDocumentResult

Contiene i risultati delle informazioni personali.

Nome	Tipo	Descrizione
entities	Entity[]	Entità riconosciute nel documento.
id	string	Identificatore di documento univoco e non vuoto.
redactedText	string	Restituisce testo redatto.
statistics	DocumentStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
warnings	DocumentWarning[]	Avvisi rilevati durante l'elaborazione del documento.

PiiResult

Contiene PiiResult.

Nome	Tipo	Descrizione
documents	PiiEntitiesDocumentResult[]	Risposta per documento
errors	DocumentError[]	Errori in base all'ID documento.
modelVersion	string	Questo campo indica quale modello viene usato per l'assegnazione dei punteggi.
statistics	RequestStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.

PiiTaskParameters

Parametri supportati per un'attività Riconoscimento entità personali.

Nome	Tipo	Valore predefinito	Descrizione
domain	PiiDomain	none	Dominio per l'attività PII
loggingOptOut	boolean	False	rifiutare esplicitamente la registrazione
modelVersion	string	latest	versione del modello
piiCategories	PiiCategory[]		Enumerazione delle categorie di informazioni personali da restituire nella risposta.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType da usare per l'analisi.

PiiTaskResult

Contiene l'attività analisi del testo PIIEntityRecognition LRO.

Nome	Tipo	Descrizione
kind	string: PiiEntityRecognitionResults	Tipo di risultato dell'attività.
results	PiiResult	Elenco dei risultati pii

RangeInclusivity

Inclusione dell'intervallo di questa proprietà di proprietà.

Nome	Tipo	Descrizione
LeftInclusive	string	Lato sinistro inclusivo
LeftRightInclusive	string	Entrambi i lati inclusi
NoneInclusive	string	Nessuna inclusione
RightInclusive	string	Lato destro inclusivo

RangeKind

Tipo di entità dell'intervallo di numeri.

Nome	Tipo	Descrizione
Age	string	Fascia di età
Area	string	Intervallo di aree
Currency	string	Intervallo di valuta
Information	string	Intervallo di informazioni
Length	string	Intervallo di lunghezza
Number	string	Intervallo di numeri
Speed	string	Intervallo di velocità
Temperature	string	Intervallo di temperatura
Volume	string	Intervallo di volumi
Weight	string	Intervallo di peso

RelativeTo

Punto di riferimento che indica il numero ordinale.

Nome	Tipo	Descrizione
Current	string	Stato o posizione correnti
End	string	Stato finale o posizione
Start	string	Stato iniziale o posizione

RequestStatistics

se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.

Nome	Tipo	Descrizione
documentsCount	integer	Numero di documenti inviati nella richiesta.
erroneousDocumentsCount	integer	Numero di documenti non validi. Sono inclusi documenti di lingue vuote, di dimensioni superiori o non supportate.
transactionsCount	integer	Numero di transazioni per la richiesta.
validDocumentsCount	integer	Numero di documenti validi. Ciò esclude documenti di lingue vuote, di dimensioni superiori o non supportate.

ScriptCode

Identifica lo script del documento di input. Esegue il mapping al codice di script standard ISO 15924.

Nome	Tipo	Descrizione
Arab	string	Codice script per lo script arabo.
Armn	string	Codice script per lo script armeno.
Beng	string	Codice script per lo script Bangla.
Cans	string	Codice script per lo script UnifiedCanadianAboriginalSyllabics.
Cyrl	string	Script del codice per lo script cirillico.
Deva	string	Codice script per lo script Devanagari.
Ethi	string	Codice script per lo script Ethiopic.
Geor	string	Codice script per lo script georgiano.
Grek	string	Codice script per lo script greco.
Gujr	string	Codice script per lo script Gujarati.
Guru	string	Codice script per lo script Gurmukhi.
Hang	string	Codice script per lo script Hangul.
Hani	string	Codice script per lo script HanLiteral.
Hans	string	Codice script per lo script HanSimplified.
Hant	string	Codice script per lo script HanTraditional.
Hebr	string	Codice script per lo script ebraico.
Jpan	string	Codice script per lo script giapponese.
Khmr	string	Codice script per lo script Khmer.
Knda	string	Codice script per lo script Kannada.
Laoo	string	Codice script per lo script Lao.
Latn	string	Codice script per lo script latino.
Mlym	string	Codice script per lo script Malayalam.
Mong	string	Codice script per lo script mongolo.
Mtei	string	Codice script per lo script Meitei.
Mymr	string	Codice script per lo script Myanmar.
Olck	string	Script del codice per lo script Santali.
Orya	string	Codice script per lo script Odia.
Shrd	string	Codice script per lo script Sharada.
Sinh	string	Codice script per lo script Sinhala.
Taml	string	Codice script per lo script Tamil.
Telu	string	Codice script per lo script Telugu.
Thaa	string	Codice script per lo script Thaana.
Thai	string	Codice script per lo script thai.
Tibt	string	Codice script per lo script tibetano.

ScriptKind

Identifica lo script del documento di input. Esegue il mapping al nome formale standard ISO 15924.

Nome	Tipo	Descrizione
Arabic	string	Nome script per lo script arabo.
Armenian	string	Nome script per lo script armeno.
Bangla	string	Nome script per lo script Bangla.
Cyrillic	string	Nome dello script per lo script cirillico.
Devanagari	string	Nome script per lo script Devanagari.
Ethiopic	string	Nome script per lo script Ethiopic.
Georgian	string	Nome script per lo script georgiano.
Greek	string	Nome script per lo script greco.
Gujarati	string	Nome script per lo script Gujarati.
Gurmukhi	string	Nome script per lo script Gurmukhi.
HanLiteral	string	Nome script per lo script HanLiteral.
HanSimplified	string	Nome script per lo script HanSimplified.
HanTraditional	string	Nome script per lo script HanTraditional.
Hangul	string	Nome script per lo script Hangul.
Hebrew	string	Nome script per lo script ebraico.
Japanese	string	Nome script per lo script giapponese.
Kannada	string	Nome script per lo script Kannada.
Khmer	string	Nome script per lo script Khmer.
Lao	string	Nome script per lo script Lao.
Latin	string	Nome script per lo script latino.
Malayalam	string	Nome script per lo script Malayalam.
Meitei	string	Nome script per lo script Meitei.
Mongolian	string	Nome script per lo script mongolo.
Myanmar	string	Nome script per lo script Myanmar.
Odia	string	Nome script per lo script Odia.
Santali	string	Nome script per lo script Santali.
Sharada	string	Nome script per lo script Sharada.
Sinhala	string	Nome script per lo script Sinhala.
Tamil	string	Nome script per lo script Tamil.
Telugu	string	Nome script per lo script Telugu.
Thaana	string	Nome script per lo script Thaana.
Thai	string	Nome script per lo script thai.
Tibetan	string	Nome script per lo script tibetano.
UnifiedCanadianAboriginalSyllabics	string	Nome script per lo script UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

Rappresenta una valutazione della frase e le valutazioni o gli oggetti di destinazione correlati.

Nome	Tipo	Descrizione
confidenceScores	TargetConfidenceScoreLabel	Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo.
isNegated	boolean	Indicatore che rappresenta se la valutazione viene negata.
length	integer	Lunghezza della destinazione.
offset	integer	Offset di destinazione dall'inizio della frase.
sentiment	TokenSentimentValue	Sentiment della frase.
text	string	Testo di destinazione rilevato.

SentenceSentiment

Sentiment della frase di un documento.

Nome	Tipo	Descrizione
assessments	SentenceAssessment[]	Matrice di valutazioni per la frase.
confidenceScores	SentimentConfidenceScores	Punteggio di attendibilità del sentiment compreso tra 0 e 1 per la frase per tutte le classi.
length	integer	Lunghezza della destinazione.
offset	integer	Offset di destinazione dall'inizio della frase.
sentiment	SentenceSentimentValue	Sentiment stimato per la frase.
targets	SentenceTarget[]	Matrice di destinazioni di frase per la frase.
text	string	Testo della frase.

SentenceSentimentValue

Sentiment stimato per la frase.

Nome	Tipo	Descrizione
negative	string	Sentiment negativo
neutral	string	Sentiment neutrale
positive	string	Sentiment positivo

SentenceTarget

Rappresenta una destinazione di frase e le valutazioni o gli oggetti di destinazione correlati.

Nome	Tipo	Descrizione
confidenceScores	TargetConfidenceScoreLabel	Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo.
length	integer	Lunghezza della destinazione.
offset	integer	Offset di destinazione dall'inizio della frase.
relations	TargetRelation[]	Matrice di oggetti di valutazione o di destinazione correlati alla destinazione.
sentiment	TokenSentimentValue	Sentiment della frase.
text	string	Testo di destinazione rilevato.

SentimentAnalysisTaskParameters

Parametri supportati per un'attività Analisi del sentiment.

Nome	Tipo	Valore predefinito	Descrizione
loggingOptOut	boolean	False	rifiutare esplicitamente la registrazione
modelVersion	string	latest	versione del modello
opinionMining	boolean	False	Indica se utilizzare il modello di opinion mining nella richiesta o meno.
stringIndexType	StringIndexType	TextElements_v8	Specifica il metodo utilizzato per interpretare gli offset di stringa.

SentimentConfidenceScores

Rappresenta i punteggi di attendibilità compresi tra 0 e 1 in tutte le classi di sentiment: positivo, neutro, negativo.

Nome	Tipo	Descrizione
negative	number	Punteggio di attendibilità per il sentiment negativo
neutral	number	Punteggio di attendibilità per il sentiment neutro
positive	number	Punteggio di attendibilità per il sentiment positivo

SentimentDocumentResult

Oggetto che rappresenta i risultati predefiniti dell'analisi del sentiment di ogni documento.

Nome	Tipo	Descrizione
confidenceScores	SentimentConfidenceScores	Punteggio di attendibilità del sentiment compreso tra 0 e 1 per la frase per tutte le classi.
id	string	Identificatore di documento univoco e non vuoto.
sentences	SentenceSentiment[]	Sentiment delle frasi del documento.
sentiment	DocumentSentimentValue	Valutazione stimata per il documento (negativo, neutro, positivo o misto).
statistics	DocumentStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
warnings	DocumentWarning[]	Avvisi rilevati durante l'elaborazione del documento.

SentimentResponse

Risultati dell'analisi del sentiment per i documenti di input.

Nome	Tipo	Descrizione
documents	SentimentDocumentResult[]	Risultati dell'analisi del sentiment per ogni documento nell'input.
errors	DocumentError[]	Errori in base all'ID documento.
modelVersion	string	Questo campo indica quale modello viene usato per l'assegnazione dei punteggi.
statistics	RequestStatistics	se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta.

SentimentTaskResult

Contiene il risultato dell'attività Analisi del testo SentimentAnalysis LRO.

Nome	Tipo	Descrizione
kind	string: SentimentAnalysisResults	Tipo di risultato dell'attività.
results	SentimentResponse	Risultati dell'analisi del sentiment

SpeedMetadata

Rappresenta il modello di metadati dell'entità Speed.

Nome	Tipo	Descrizione
metadataKind	string: SpeedMetadata	Tipo di oggetto Metadata dell'entità.
unit	SpeedUnit	Unità di misura per la velocità.
value	number	Valore numerico che indica il testo estratto.

SpeedUnit

Unità di misura della velocità

Nome	Tipo	Descrizione
CentimetersPerMillisecond	string	Unità di velocità in centimetri al millisecondo.
FeetPerMinute	string	Unità di velocità in piedi al minuto.
FeetPerSecond	string	Unità di velocità in piedi al secondo.
KilometersPerHour	string	Unità di velocità in chilometri all'ora.
KilometersPerMillisecond	string	Unità di velocità in chilometri al millisecondo.
KilometersPerMinute	string	Unità di velocità in chilometri al minuto.
KilometersPerSecond	string	Unità di velocità in chilometri al secondo.
Knots	string	Unità di velocità in nodi.
MetersPerMillisecond	string	Unità di velocità in metri al millisecondo.
MetersPerSecond	string	Unità di velocità in metri al secondo.
MilesPerHour	string	Unità di velocità in miglia all'ora.
Unspecified	string	Unità di velocità non specificata.
YardsPerMinute	string	Unità di velocità in yard al minuto.
YardsPerSecond	string	Unità di velocità in yard al secondo.

StringIndexType

Tipo di indice stringa

Nome	Tipo	Descrizione
TextElements_v8	string	I valori di offset e lunghezza restituiti corrispondono a TextElements (cluster Graphemes e Grapheme) che confermano lo standard Unicode 8.0.0. Usare questa opzione se l'applicazione è scritta in .Net Framework o .Net Core e si userà StringInfo.
UnicodeCodePoint	string	I valori di offset e lunghezza restituiti corrispondono ai punti di codice Unicode. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio Python.
Utf16CodeUnit	string	I valori di offset e lunghezza restituiti corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione viene scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.

TargetConfidenceScoreLabel

Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo.

Nome	Tipo	Descrizione
negative	number	Punteggio di attendibilità per il sentiment negativo
positive	number	Punteggio di attendibilità per il sentiment positivo

TargetRelation

Rappresenta la relazione tra valutazioni e/o destinazioni.

Nome	Tipo	Descrizione
ref	string	Puntatore JSON che indica l'oggetto collegato.
relationType	TargetRelationType	Tipo correlato alla destinazione.

TargetRelationType

Tipo correlato alla destinazione.

Nome	Tipo	Descrizione
assessment	string	Relazione di valutazione.
target	string	Relazione di destinazione.

TemperatureMetadata

Rappresenta il modello di metadati dell'entità Informazioni.

Nome	Tipo	Descrizione
metadataKind	string: TemperatureMetadata	Tipo di oggetto Metadata dell'entità.
unit	TemperatureUnit	Unità di misura per la temperatura.
value	number	Valore numerico che indica il testo estratto.

TemperatureUnit

Unità di misura della temperatura.

Nome	Tipo	Descrizione
Celsius	string	Unità di temperatura in Celsius
Fahrenheit	string	Unità di temperatura in Fahrenheit
Kelvin	string	Unità di temperatura in Kelvin
Rankine	string	Unità di temperatura in Rankine
Unspecified	string	Unità di temperatura non specificata

TemporalModifier

Modificatore facoltativo di un'istanza di data/ora.

Nome	Tipo	Descrizione
After	string	Dopo un'ora specifica
AfterApprox	string	Dopo un tempo approssimativo
AfterMid	string	Dopo la metà di un periodo di tempo
AfterStart	string	Dopo l'inizio di un periodo di tempo
Approx	string	Approssimativamente in un momento specifico
Before	string	Prima di un'ora specifica
BeforeApprox	string	Prima di un tempo approssimativo
BeforeEnd	string	Prima della fine di un periodo di tempo
BeforeStart	string	Prima dell'inizio di un periodo di tempo
End	string	Alla fine di un periodo di tempo
Less	string	Meno di un'ora specifica
Mid	string	Al centro di un periodo di tempo
More	string	Più di un momento specifico
ReferenceUndefined	string	Riferimento a un'ora non definita
Since	string	Da un momento specifico
SinceEnd	string	Dalla fine di un periodo di tempo
Start	string	All'inizio di un periodo di tempo
Until	string	Fino a un'ora specifica

TemporalSetMetadata

Metadati per le istanze di entità del set temporale.

Nome	Tipo	Descrizione
dateValues	DateValue[]	Elenco di valori di data.
metadataKind	string: TemporalSetMetadata	Tipo di oggetto Metadata dell'entità.

TemporalSpanMetadata

rappresenta i metadati di una data e/o di un intervallo di tempo.

Nome	Tipo	Descrizione
metadataKind	string: TemporalSpanMetadata	Tipo di oggetto Metadata dell'entità.
spanValues	TemporalSpanValues[]	Elenco degli intervalli temporali rilevati.

TemporalSpanValues

Oggetto intervallo temporale.

Nome	Tipo	Descrizione
begin	string	Valore iniziale per l'intervallo.
duration	string	Valore di durata facoltativo formattato in base a ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Valore finale per l'intervallo.
modifier	TemporalModifier	Modificatore per datetime per indicare il punto di riferimento come prima, dopo e così via.
timex	string	Triplo facoltativo contenente l'inizio, la fine e la durata sono tutte indicate come stringhe formattate ISO 8601.

TimeMetadata

Metadati per le istanze dell'entità temporale.

Nome	Tipo	Descrizione
dateValues	DateValue[]	Elenco di valori di data.
metadataKind	string: TimeMetadata	Tipo di oggetto Metadata dell'entità.

TokenSentimentValue

Sentiment stimato per la frase.

Nome	Tipo	Descrizione
mixed	string	Sentiment misto
negative	string	Sentiment negativo
positive	string	Sentiment positivo

VolumeMetadata

Rappresenta il modello metadati dell'entità volume.

Nome	Tipo	Descrizione
metadataKind	string: VolumeMetadata	Tipo di oggetto Metadata dell'entità.
unit	VolumeUnit	Unità di misura per il volume.
value	number	Valore numerico che indica il testo estratto.

VolumeUnit

Unità di misura del volume

Nome	Tipo	Descrizione
Barrel	string	Unità di volume in barili.
Bushel	string	Unità di volume in cespugli.
Centiliter	string	Unità di volume in centiliter.
Cord	string	Unità di volume nei cavi.
CubicCentimeter	string	Unità di volume in centimetri cubi.
CubicFoot	string	Unità di volume in piedi cubici.
CubicInch	string	Unità di volume in pollici cubi.
CubicMeter	string	Unità di volume in metri cubi.
CubicMile	string	Unità di volume in miglia cubiche.
CubicMillimeter	string	Unità di volume in millimetri cubi.
CubicYard	string	Unità di volume in metri cubi.
Cup	string	Unità di volume in tazze.
Decaliter	string	Unità di volume nei decalitter.
FluidDram	string	Unità di volume in drammi fluidi.
FluidOunce	string	Unità di volume in once fluide.
Gill	string	Unità di volume nelle branchie.
Hectoliter	string	Unità di volume negli hectoliter.
Hogshead	string	Unità di volume in teste.
Liter	string	Unità di volume in litri.
Milliliter	string	Unità di volume in milliliter.
Minim	string	Unità di volume in minims.
Peck	string	Unità di volume in peck.
Pinch	string	Unità di volume in avvicinamento delle dita.
Pint	string	Unità di volume in pinte.
Quart	string	Unità di volume in quart.
Tablespoon	string	Unità volume in cucchiai.
Teaspoon	string	Unità volume in cucchiaini.
Unspecified	string	Unità di volume non specificata.

WarningCodeValue

Definisce l'elenco dei codici di avviso.

Nome	Tipo	Descrizione
DocumentTruncated	string	Avviso troncato del documento
LongWordsInDocument	string	Parole lunghe nell'avviso del documento

WeightMetadata

Rappresenta il modello di metadati dell'entità Weight ).

Nome	Tipo	Descrizione
metadataKind	string: WeightMetadata	Tipo di oggetto Metadata dell'entità.
unit	WeightUnit	Unità di misura per il peso.
value	number	Valore numerico che indica il testo estratto.

WeightUnit

Unità di misura del peso.

Nome	Tipo	Descrizione
Dram	string	Unità di peso in drammi
Gallon	string	Unità di volume in galloni
Grain	string	Unità di peso in grani
Gram	string	Unità di peso in grammi
Kilogram	string	Unità di peso in kg
LongTonBritish	string	Unità di peso in tonnellate lunghe (britannico)
MetricTon	string	Unità di peso in tonnellate di metrica
Milligram	string	Unità di peso ingrammi
Ounce	string	Unità di peso in once
PennyWeight	string	Unità di peso in pennyweight
Pound	string	Unità di peso in libbre
ShortHundredWeightUS	string	Unità di peso in centinaia di pesi brevi (STATI UNITI)
ShortTonUS	string	Unità di peso in tonnellate brevi (STATI UNITI)
Stone	string	Unità di peso in pietre
Ton	string	Unità di peso in tonnellate
Unspecified	string	Unità di peso non specificata