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 minLength: 1	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

Object

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 (double)	Valore numerico che indica il testo estratto.

AgeUnit

Enumerazione

Unità di misura dell'età

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

AllowOverlapEntityPolicyType

Object

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

Object

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

Object

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

Object

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

Object

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

Object

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

Object

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

Enumerazione

Tipo di attività di analisi-testo supportate.

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

AnalyzeTextTaskResultsKind

Enumerazione

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

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

AreaMetadata

Object

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 (double)	Valore numerico che indica il testo estratto.

AreaUnit

Enumerazione

Unità di misura dell'area.

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

CurrencyMetadata

Object

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 (double)	Valore numerico che indica il testo estratto.

DateMetadata

Object

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

Object

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

Object

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

Object

Contiene i dettagli della lingua rilevata per il testo.

Nome	Tipo	Descrizione
confidenceScore	number (double)	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

Object

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

Enumerazione

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

Valore	Descrizione
mixed	Istruzione mista
negative	Istruzione negativa
neutral	Istruzione neutra
positive	Dichiarazione positiva

DocumentStatistics

Object

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

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

DocumentWarning

Object

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

Object

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

Object

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

Object

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

Object

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

Object

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 (double)	Punteggio di confidenza compreso tra 0 e 1 dell'entità estratta.
length	integer (int32)	Lunghezza per il testo dell'entità. L'uso di valori 'stringIndexType' diversi può influire sulla lunghezza restituita.
offset	integer (int32)	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

Enumerazione

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

Valore	Descrizione
Address	Menzioni specifiche a livello di strada di località: numeri di casa/edificio, strade, strade, autostrade, intersezioni a cui fa riferimento il nome.
Age	Valori correlati all'età.
Airport	Gli aeroporti.
Area	Area di un oggetto.
City	Valori correlati alla città.
ComputingProduct	Prodotti informatici.
Continent	Valori correlati al continente.
CountryRegion	Valori correlati al paese o all'area geografica.
CulturalEvent	Valori relativi agli eventi culturali.
Currency	Valori correlati alla valuta.
Date	Date del calendario.
DateRange	Intervallo di date.
DateTime	Date del calendario con ora.
DateTimeRange	Intervallo di data e ora.
Dimension	Dimensione delle misurazioni
Duration	Durata del tempo.
Email	Indirizzi di posta elettronica.
Event	Eventi sociali, sportivi, commerciali, politici, educativi, naturali, storici, criminali, violenti, legali, militari con un periodo di tempo.
GPE	Città, paesi/aree geografiche, stati.
Geological	Caratteristiche geografiche e naturali come fiumi, oceani e deserti.
Height	Altezza di un oggetto.
IP	indirizzi IP di rete.
Information	Unità di misura per le informazioni digitali.
Length	Lunghezza di un oggetto.
Location	Punto o luogo specifico nello spazio fisico.
NaturalEvent	Valori relativi agli eventi naturali.
Number	Numeri senza unità
NumberRange	Intervallo di numeri
Numeric	Valori numerici, incluse cifre e parole numeriche.
Ordinal	Numeri ordinali.
Organization	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	Aziende mediche e gruppi.
OrganizationSports	Organizzazioni correlate allo sport.
OrganizationStockExchange	Gruppi di borsa.
Percentage	Valori correlati alla percentuale.
Person	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	Ruoli umani classificati da un'appartenenza a un gruppo.
PhoneNumber	Numeri di telefono (solo numeri di telefono usa e ue).
Product	Singolo o gruppo di oggetti commerciali, di consumo, elettronica, veicoli, gruppi alimentari.
SetTemporal	Set di valori correlati al tempo.
Skill	Una capacità, una competenza o un'esperienza.
Speed	Velocità di un oggetto.
SportsEvent	Valori correlati agli eventi sportivi.
State	Valori correlati allo stato.
Structural	Strutture fatte dall'uomo.
Temperature	Valori relativi alla temperatura.
Temporal	Elementi relativi all'ora.
Time	Orari del giorno.
TimeRange	Intervallo di volte.
URL	URL ai siti Web.
Volume	Volume di un oggetto.
Weight	Peso di un oggetto.

EntityInferenceOptions

Object

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

Object

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

Object

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

Object

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

Object

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 (double)	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

Object

Oggetto entità con tag e metadati.

Nome	Tipo	Descrizione
category	string	Tipo di entità.
confidenceScore	number (double)	Punteggio di confidenza compreso tra 0 e 1 dell'entità estratta.
length	integer (int32)	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 (int32)	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

Object

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

Enumerazione

Codice di errore leggibile.

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

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InformationMetadata

Object

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 (double)	Valore numerico che indica il testo estratto.

InformationUnit

Enumerazione

Unità di misura delle informazioni (dati).

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

InnerErrorCode

Enumerazione

Codice di errore leggibile.

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

InnerErrorModel

Object

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

Object

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

Object

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

Object

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

Object

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

Object

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

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

LanguageDetectionDocumentResult

Object

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

Object

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

Object

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

Object

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

Object

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

Object

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 (double)	Valore numerico che indica il testo estratto.

LengthUnit

Enumerazione

Unità di misura di lunghezza.

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

LinkedEntitiesDocumentResult

Object

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

Object

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

Object

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

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

MatchLongestEntityPolicyType

Object

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

Enumerazione

Tipo di oggetto Metadata dell'entità.

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

MultiLanguageAnalysisInput

Object

Raccolta di documenti di input da analizzare dal servizio.

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

MultiLanguageInput

Object

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

Enumerazione

Tipo dell'entità numero estratto.

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

NumberMetadata

Object

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 (double)	Rappresentazione numerica di ciò che il testo estratto indica.

NumericRangeMetadata

Object

rappresenta i metadati degli intervalli numerici.

Nome	Tipo	Descrizione
maximum	number (double)	Valore finale dell'intervallo.
metadataKind	string: NumericRangeMetadata	Tipo di oggetto Metadata dell'entità.
minimum	number (double)	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

Object

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

Enumerazione

(Facoltativo) descrive le categorie di informazioni personali da restituire

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

PiiDomain

Enumerazione

Dominio per l'attività PII

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

PiiEntitiesDocumentResult

Object

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

Object

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

Object

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

Object

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

Enumerazione

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

Valore	Descrizione
LeftInclusive	Lato sinistro inclusivo
LeftRightInclusive	Entrambi i lati inclusi
NoneInclusive	Nessuna inclusione
RightInclusive	Lato destro inclusivo

RangeKind

Enumerazione

Tipo di entità dell'intervallo di numeri.

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

RelativeTo

Enumerazione

Punto di riferimento che indica il numero ordinale.

Valore	Descrizione
Current	Stato o posizione correnti
End	Stato finale o posizione
Start	Stato iniziale o posizione

RequestStatistics

Object

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

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

ScriptCode

Enumerazione

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

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

ScriptKind

Enumerazione

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

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

SentenceAssessment

Object

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 (int32)	Lunghezza della destinazione.
offset	integer (int32)	Offset di destinazione dall'inizio della frase.
sentiment	TokenSentimentValue	Sentiment della frase.
text	string	Testo di destinazione rilevato.

SentenceSentiment

Object

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 (int32)	Lunghezza della destinazione.
offset	integer (int32)	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

Enumerazione

Sentiment stimato per la frase.

Valore	Descrizione
negative	Sentiment negativo
neutral	Sentiment neutrale
positive	Sentiment positivo

SentenceTarget

Object

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 (int32)	Lunghezza della destinazione.
offset	integer (int32)	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

Object

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

Object

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

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

SentimentDocumentResult

Object

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

Object

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

Object

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

Object

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 (double)	Valore numerico che indica il testo estratto.

SpeedUnit

Enumerazione

Unità di misura della velocità

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

StringIndexType

Enumerazione

Tipo di indice stringa

Valore	Descrizione
TextElements_v8	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	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	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

Object

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

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

TargetRelation

Object

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

Enumerazione

Tipo correlato alla destinazione.

Valore	Descrizione
assessment	Relazione di valutazione.
target	Relazione di destinazione.

TemperatureMetadata

Object

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 (double)	Valore numerico che indica il testo estratto.

TemperatureUnit

Enumerazione

Unità di misura della temperatura.

Valore	Descrizione
Celsius	Unità di temperatura in Celsius
Fahrenheit	Unità di temperatura in Fahrenheit
Kelvin	Unità di temperatura in Kelvin
Rankine	Unità di temperatura in Rankine
Unspecified	Unità di temperatura non specificata

TemporalModifier

Enumerazione

Modificatore facoltativo di un'istanza di data/ora.

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

TemporalSetMetadata

Object

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

Object

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

Object

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

Object

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

Enumerazione

Sentiment stimato per la frase.

Valore	Descrizione
mixed	Sentiment misto
negative	Sentiment negativo
positive	Sentiment positivo

VolumeMetadata

Object

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 (double)	Valore numerico che indica il testo estratto.

VolumeUnit

Enumerazione

Unità di misura del volume

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

WarningCodeValue

Enumerazione

Definisce l'elenco dei codici di avviso.

Valore	Descrizione
DocumentTruncated	Avviso troncato del documento
LongWordsInDocument	Parole lunghe nell'avviso del documento

WeightMetadata

Object

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 (double)	Valore numerico che indica il testo estratto.

WeightUnit

Enumerazione

Unità di misura del peso.

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