Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

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

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

With optional parameters:

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

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.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
AnalyzeTextEntityLinkingInput	Contiene l'input di collegamento dell'entità di testo di analisi.
AnalyzeTextEntityRecognitionInput	Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.
AnalyzeTextKeyPhraseExtractionInput	Contiene l'input dell'attività KeyPhraseExtraction di analisi.
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 testo di analisi.

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 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 attività.

AnalyzeTextKeyPhraseExtractionInput

Contiene l'input dell'attività KeyPhraseExtraction di analisi.

Nome	Necessario	Tipo	Descrizione
kind	True	string: KeyPhraseExtraction	Tipo di attività da eseguire.
analysisInput		MultiLanguageAnalysisInput	Contiene i documenti di input.
parameters		KeyPhraseTaskParameters	Parametri attività di estrazione delle 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. Headers x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Esempio

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

Definizioni

Nome	Descrizione
AnalyzeTextEntityLinkingInput	Contiene l'input di collegamento dell'entità di testo di analisi.
AnalyzeTextEntityRecognitionInput	Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.
AnalyzeTextKeyPhraseExtractionInput	Contiene l'input dell'attività KeyPhraseExtraction di analisi.
AnalyzeTextLanguageDetectionInput	Contiene l'input dell'attività di analisi del documento di rilevamento della lingua.
AnalyzeTextPiiEntitiesRecognitionInput	Contiene l'input dell'attività PIIEntityRecognition del testo di analisi.
AnalyzeTextSentimentAnalysisInput	Contiene l'input dell'attività SentimentAnalysis del testo di analisi.
AnalyzeTextTaskKind	Tipo di attività di analisi-testo supportate.
AnalyzeTextTaskResultsKind	Tipo dell'oggetto di risposta restituito dall'attività analisi-testo.
DetectedLanguage	Contiene i dettagli della lingua rilevata per il testo.
DocumentError	Contiene i dettagli degli errori rilevati durante l'esecuzione di un processo.
DocumentSentimentValue	Sentiment stimato per il documento (Negativo, Neutrale, 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.
EntitiesDocumentResult	Contiene il risultato dell'attività di riconoscimento delle entità per il documento.
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.
EntityLinkingResult	Risultato collegamento entità.
EntityLinkingTaskParameters	Parametri supportati per un'attività Entity Linking.
EntityLinkingTaskResult	Contiene il risultato dell'attività di collegamento dell'entità di testo di analisi.
Error	L'oggetto risposta di errore restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.
ErrorCode	Codice di errore leggibile dall'utente.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile dall'utente.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'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 delle frasi chiave per un documento.
KeyPhraseTaskParameters	Parametri supportati per un'attività Di estrazione frasi chiave.
KeyPhraseTaskResult	Contiene il risultato dell'attività KeyPhraseExtraction di analisi.
LanguageDetectionAnalysisInput	Contiene l'input di analisi del documento 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.
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à rilevato con l'offset e la lunghezza.
MultiLanguageAnalysisInput	Raccolta di documenti di input da analizzare dal servizio.
MultiLanguageInput	Contiene un documento di input da analizzare dal servizio.
PiiCategory	(Facoltativo) descrive le categorie di informazioni personali da restituire
PiiDomain	Dominio per attività piI
PiiEntitiesDocumentResult	Contiene i risultati delle informazioni personali.
PiiResult	Contiene PiiResult.
PiiTaskParameters	Parametri supportati per un'attività Riconoscimento entità pii.
PiiTaskResult	Contiene l'attività PIIEntityRecognition LRO del testo di analisi.
RequestStatistics	se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload della richiesta.
SentenceAssessment	Rappresenta una valutazione della frase e le valutazioni o gli oggetti di destinazione correlati.
SentenceSentiment	Sentimento della frase di un documento.
SentenceSentimentValue	Sentiment previsto 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 sentiment.
SentimentConfidenceScores	Rappresenta i punteggi di attendibilità compresi tra 0 e 1 in tutte le classi di sentiment: positivi, neutrali, negativi.
SentimentDocumentResult	Oggetto che rappresenta i risultati dell'analisi del sentiment predefinita di ogni documento.
SentimentResponse	Risultati dell'analisi del sentiment per i documenti di input.
SentimentTaskResult	Contiene il risultato dell'attività SentimentAnalysis LRO di analisi.
StringIndexType	Tipo di indice stringa
TargetConfidenceScoreLabel	Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivi e negativi.
TargetRelation	Rappresenta la relazione tra valutazioni e/o destinazioni.
TargetRelationType	Tipo correlato alla destinazione.
TokenSentimentValue	Sentiment previsto per la frase.
WarningCodeValue	Definisce l'elenco dei codici di avviso.

AnalyzeTextEntityLinkingInput

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

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 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 attività.

AnalyzeTextKeyPhraseExtractionInput

Contiene l'input dell'attività KeyPhraseExtraction di analisi.

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

AnalyzeTextLanguageDetectionInput

Contiene l'input dell'attività di analisi del documento di rilevamento della lingua.

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

AnalyzeTextPiiEntitiesRecognitionInput

Contiene l'input dell'attività PIIEntityRecognition del testo di analisi.

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

AnalyzeTextSentimentAnalysisInput

Contiene l'input dell'attività SentimentAnalysis del testo di analisi.

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

AnalyzeTextTaskKind

Tipo di attività di analisi-testo supportate.

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

AnalyzeTextTaskResultsKind

Tipo dell'oggetto di risposta restituito dall'attività analisi-testo.

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

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 prossimi a 1 indicano con una certezza del 100% che la lingua identificata è true.
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).

DocumentError

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

Nome	Tipo	Descrizione
error	Error	Errore rilevato.
id	string	ID del documento di input.

DocumentSentimentValue

Sentiment stimato per il documento (Negativo, Neutrale, Positivo o Misto).

Nome	Tipo	Descrizione
mixed	string	Istruzione mista
negative	string	Istruzione negativa
neutral	string	Istruzione neutrale
positive	string	Istruzione 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 al puntatore JSON che indica l'oggetto di destinazione.

EntitiesDocumentResult

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

Nome	Tipo	Descrizione
entities	Entity[]	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	EntitiesDocumentResult[]	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
loggingOptOut	boolean	False	disconnettersi
modelVersion	string	latest	versione del modello
stringIndexType	StringIndexType	TextElements_v8	(Facoltativo) parametro per specificare il tipo di indice stringa usato per interpretare gli offset stringa. Impostazione predefinita in 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 attendibilità 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) Tipo secondario di entità.
text	string	Testo dell'entità visualizzato nella richiesta.

EntityLinkingResult

Risultato collegamento 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	disconnettersi
modelVersion	string	latest	versione del modello
stringIndexType	StringIndexType	TextElements_v8	Parametro facoltativo per specificare il tipo di indice stringa usato per interpretare gli offset stringa. Impostazione predefinita in 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 collegamento entità.

Error

L'oggetto 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 dall'utente.

Nome	Tipo	Descrizione
AzureCognitiveSearchIndexLimitReached	string	Ricerca cognitiva di Azure limite di indice raggiunto l'errore
AzureCognitiveSearchIndexNotFound	string	Ricerca cognitiva di Azure indice non trovato
AzureCognitiveSearchNotFound	string	Ricerca cognitiva di Azure errore non trovato
AzureCognitiveSearchThrottling	string	Ricerca cognitiva di Azure errore di limitazione delle limitazioni
Conflict	string	errore di conflitto
Forbidden	string	Errore di accesso non consentito
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	Operazione non trovata
ProjectNotFound	string	Errore del progetto non trovato
QuotaExceeded	string	Errore di superamento della quota
ServiceUnavailable	string	Errore non disponibile del servizio
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.

InnerErrorCode

Codice di errore leggibile dall'utente.

Nome	Tipo	Descrizione
AzureCognitiveSearchNotFound	string	Ricerca cognitiva di Azure errore non trovato
AzureCognitiveSearchThrottling	string	Ricerca cognitiva di Azure errore di limitazione delle limitazioni
EmptyRequest	string	Errore di richiesta vuota
ExtractionFailure	string	Errore di estrazione
InvalidCountryHint	string	Errore di hint del paese non valido
InvalidDocument	string	Errore del documento non valido
InvalidDocumentBatch	string	Errore batch di documento 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 di Knowledge Base non trovato
MissingInputDocuments	string	Errore dei documenti di input mancanti
ModelVersionIncorrect	string	Errore di versione del modello non corretto
UnsupportedLanguageCode	string	Errore del codice del linguaggio non supportato

InnerErrorModel

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'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 degli errori.
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 delle 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à Di estrazione frasi chiave.

Nome	Tipo	Valore predefinito	Descrizione
loggingOptOut	boolean	False	disconnettersi
modelVersion	string	latest	versione del modello

KeyPhraseTaskResult

Contiene il risultato dell'attività KeyPhraseExtraction di analisi.

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 del documento 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	disconnettersi
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 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.

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	Entità Bing Search identificatore univoco api 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 usata nell'origine dati.
matches	Match[]	L'elenco delle istanze di questa entità viene visualizzato nel testo.
name	string	Nome formale del collegamento di entità.
url	string	URL della pagina dell'entità dall'origine dati.

Match

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

Nome	Tipo	Descrizione
confidenceScore	number	Se viene riconosciuto un elemento noto, verrà restituito un numero decimale che denota il livello di attendibilità 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.

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) Si tratta della rappresentazione ISO 639-1 di 2 lettere di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo e così via. Se non è impostato, usare "en" per l'inglese come impostazione predefinita. (In seguito si applica solo a 2023-04-15-preview e versioni successive) Per Il rilevamento automatico della lingua, usare "auto". Se non è impostato, usare "en" per l'inglese come impostazione predefinita.
text	string	Testo di input da elaborare.

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 di Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	string	Connessione al database IAAS di Azure e stringa SQL
AzureIoTConnectionString	string	Stringa di connessione di Azure IoT
AzurePublishSettingPassword	string	Password delle impostazioni di pubblicazione di Azure
AzureRedisCacheString	string	Stringa cache Redis di Azure
AzureSAS	string	Azure SAS
AzureServiceBusString	string	stringa 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	BR CPF Number
BRLegalEntityNumber	string	BR Legal Entity Number
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	CA Bank Account Number
CADriversLicenseNumber	string	CA Driver's License Number
CAHealthServiceNumber	string	CA Health Service Number
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 DI WINDOWS
CZPersonalIdentityV2	string	IDENTITÀ PERSONALE DI WINDOWS V2
CreditCardNumber	string	Numero di 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	DE Value Added Number
DKPersonalIdentificationNumber	string	Numero di identificazione personale DK
DKPersonalIdentificationV2	string	Identificazione personale DK V2
Date	string	Data
Default	string	Categorie di piI predefinite per la lingua.
DrugEnforcementAgencyNumber	string	Numero dell'agenzia di imposizione della 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 di guida EU
EUGPSCoordinates	string	Coordinate GPS EU
EUNationalIdentificationNumber	string	Numero documento di identità EU
EUPassportNumber	string	Numero di passaporto EU
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 di passaporto FR
FRSocialSecurityNumber	string	Numero di previdenza sociale FR
FRTaxIdentificationNumber	string	Numero di identificazione fiscale FR
FRValueAddedTaxNumber	string	Numero di imposta aggiunto valore FR
GRNationalIDCard	string	Carta 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	HR Personal Identification Number
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	Numero di carta di identità ID
IEPersonalPublicServiceNumber	string	Numero di servizio pubblico personale di Internet Explorer
IEPersonalPublicServiceNumberV2	string	IE Personal Public Service Number V2
ILBankAccountNumber	string	Numero conto corrente bancario IL
ILNationalID	string	ID nazionale IL
INPermanentAccount	string	IN Account permanente
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 di conto 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 del residente JP
JPSocialInsuranceNumber	string	Numero di assicurazione sociale JP
KRResidentRegistrationNumber	string	Numero di registrazione di KR Resident
LTPersonalCode	string	Codice personale LT
LUNationalIdentificationNumberNatural	string	Numero di identificazione nazionale LU naturale
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 IVA MT
MYIdentityCardNumber	string	Numero di carta di identità MY
NLCitizensServiceNumber	string	Numero di servizio NL Citizens
NLCitizensServiceNumberV2	string	Numero di servizio NL Citizens V2
NLTaxIdentificationNumber	string	Numero di identificazione fiscale NL
NLValueAddedTaxNumber	string	Numero di imposta aggiunto valore NL
NOIdentityNumber	string	NESSUN numero di identità
NZBankAccountNumber	string	Numero conto NZ NZ
NZDriversLicenseNumber	string	Numero di licenza del driver NZ
NZInlandRevenueNumber	string	Numero di ricavi inland NZ
NZMinistryOfHealthNumber	string	Numero di salute del ministero della salute
NZSocialWelfareNumber	string	Numero di previdenza sociale NZ
Organization	string	Organizzazione
PHUnifiedMultiPurposeIDNumber	string	Numero ID multiuso di PH unificato
PLIdentityCard	string	Scheda di identità PL
PLNationalID	string	ID nazionale PL
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	Numero di passaporto PL
PLREGONNumber	string	Numero REGON PL
PLTaxIdentificationNumber	string	Numero di identificazione fiscale PL
PTCitizenCardNumber	string	Numero di carta pt cittadino
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 domestico
RUPassportNumberInternational	string	Ur Passport Number International
SANationalID	string	ID nazionale SA
SENationalID	string	ID nazionale SE
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Numero di passaporto SE
SETaxIdentificationNumber	string	Numero di identificazione fiscale SE
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	Numero personale SK
SQLServerConnectionString	string	Stringa di connessione di SQL Server
SWIFTCode	string	Codice SWIFT
THPopulationIdentificationCode	string	Codice di identificazione della popolazione TH
TRNationalIdentificationNumber	string	Numero di identificazione nazionale TR
TWNationalID	string	ID nazionale TW
TWPassportNumber	string	Numero di passaporto TW
TWResidentCertificate	string	Certificato residente TW
UAPassportNumberDomestic	string	Numero di passaporto UA domestico
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	Numero di licenza del driver britannico
UKElectoralRollNumber	string	Numero di rollback elettorale del Regno Unito
UKNationalHealthNumber	string	Numero di salute nazionale del Regno Unito
UKNationalInsuranceNumber	string	Numero di assicurazione nazionale britannica
UKUniqueTaxpayerNumber	string	Numero di contribuenti univoci del Regno Unito
URL	string	URL
USBankAccountNumber	string	Numero conto bancario US
USDriversLicenseNumber	string	Numero di licenza di US Driver
USIndividualTaxpayerIdentification	string	Identificazione dei singoli contribuenti statunitensi
USSocialSecurityNumber	string	Numero di sicurezza sociale statunitense
USUKPassportNumber	string	Numero di passaporto US UK
ZAIdentificationNumber	string	Numero di identificazione ZA

PiiDomain

Dominio per attività piI

Nome	Tipo	Descrizione
none	string	Indica che non è specificato alcun dominio.
phi	string	Indica che le entità nel dominio Informazioni sull'integrità personale 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 redattito.
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à pii.

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

PiiTaskResult

Contiene l'attività PIIEntityRecognition LRO del testo di analisi.

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

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. Include documenti di linguaggi vuoti, over-size o non supportati.
transactionsCount	integer	Numero di transazioni per la richiesta.
validDocumentsCount	integer	Numero di documenti validi. Ciò esclude documenti di linguaggi vuoti, over-size o non supportati.

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: positivi e negativi.
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

Sentimento 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 previsto per la frase.
targets	SentenceTarget[]	Matrice di destinazioni di frase per la frase.
text	string	Testo della frase.

SentenceSentimentValue

Sentiment previsto 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: positivi e negativi.
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 sentiment.

Nome	Tipo	Valore predefinito	Descrizione
loggingOptOut	boolean	False	disconnettersi
modelVersion	string	latest	versione del modello
opinionMining	boolean	False	Se usare il data mining di opinione nella richiesta o meno.
stringIndexType	StringIndexType	TextElements_v8	Specifica il metodo usato per interpretare gli offset di stringa.

SentimentConfidenceScores

Rappresenta i punteggi di attendibilità compresi tra 0 e 1 in tutte le classi di sentiment: positivi, neutrali, negativi.

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

SentimentDocumentResult

Oggetto che rappresenta i risultati dell'analisi del sentiment predefinita 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	Sentiment stimato per il documento (Negativo, Neutrale, 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[]	L'analisi del sentiment restituisce i risultati di 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à SentimentAnalysis LRO di analisi.

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

StringIndexType

Tipo di indice stringa

Nome	Tipo	Descrizione
TextElements_v8	string	I valori di offset e lunghezza restituiti corrispondono ai cluster TextElements (Graphemes e Grapheme) confermando 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 è scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.

TargetConfidenceScoreLabel

Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivi e negativi.

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

TokenSentimentValue

Sentiment previsto per la frase.

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

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