Text Analysis Runtime - Analyze Text
Richiedere l'analisi del testo su una raccolta di documenti.
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
show
|
query |
boolean |
(Facoltativo) se impostato su true, la risposta conterrà statistiche a livello di richiesta e documento. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Corpo della richiesta
Il corpo della richiesta può essere uno dei seguenti:
Nome | Descrizione |
---|---|
Analyze |
Contiene l'input di collegamento dell'entità di testo di analisi. |
Analyze |
Il riconoscimento dell'entità analizza la richiesta di attività di input di testo. |
Analyze |
Contiene l'input dell'attività Analyze text KeyPhraseExtraction. |
Analyze |
Contiene l'input dell'attività di analisi dei documenti di rilevamento della lingua. |
Analyze |
Contiene l'input dell'attività analizza testo PIIEntityRecognition. |
Analyze |
Contiene l'input dell'attività Analisi del testo SentimentAnalysis. |
AnalyzeTextEntityLinkingInput
Contiene l'input di collegamento dell'entità di testo di analisi.
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
kind | True |
string:
Entity |
Tipo di attività da eseguire. |
analysisInput |
Contiene l'input di analisi da gestire dal servizio. |
||
parameters |
Parametri dell'attività. |
AnalyzeTextEntityRecognitionInput
Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
kind | True |
string:
Entity |
Tipo di attività da eseguire. |
analysisInput |
Input da analizzare. |
||
parameters |
Parametri dell'attività. |
AnalyzeTextKeyPhraseExtractionInput
Contiene l'input dell'attività Analyze text KeyPhraseExtraction.
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
kind | True |
string:
Key |
Tipo di attività da eseguire. |
analysisInput |
Contiene i documenti di input. |
||
parameters |
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:
Language |
Tipo di attività da eseguire. |
analysisInput |
Documenti da analizzare. |
||
parameters |
parametri dell'attività. |
AnalyzeTextPiiEntitiesRecognitionInput
Contiene l'input dell'attività analizza testo PIIEntityRecognition.
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
kind | True |
string:
Pii |
Tipo di attività da eseguire. |
analysisInput |
Contiene i documenti di input. |
||
parameters |
Parametri dell'attività Pii. |
AnalyzeTextSentimentAnalysisInput
Contiene l'input dell'attività Analisi del testo SentimentAnalysis.
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
kind | True |
string:
Sentiment |
Tipo di attività da eseguire. |
analysisInput |
Contiene i documenti di input. |
||
parameters |
Parametri dell'attività Analisi del sentiment. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK | AnalyzeTextTaskResult: |
La richiesta ha avuto esito positivo. |
Other Status Codes |
Risposta di errore imprevista. Headers x-ms-error-code: string |
Sicurezza
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Esempio
SuccessfulEntityLinkingRequest
Sample Request
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "EntityLinking",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Pike place market is my favorite Seattle attraction."
}
]
}
}
Sample Response
{
"kind": "EntityLinkingResults",
"results": {
"documents": [
{
"entities": [
{
"dataSource": "Wikipedia",
"id": "Bill Gates",
"language": "en",
"matches": [
{
"confidenceScore": 0.52,
"length": 10,
"offset": 25,
"text": "Bill Gates"
}
],
"name": "Bill Gates",
"url": "https://en.wikipedia.org/wiki/Bill_Gates"
},
{
"dataSource": "Wikipedia",
"id": "Paul Allen",
"language": "en",
"matches": [
{
"confidenceScore": 0.54,
"length": 10,
"offset": 40,
"text": "Paul Allen"
}
],
"name": "Paul Allen",
"url": "https://en.wikipedia.org/wiki/Paul_Allen"
},
{
"dataSource": "Wikipedia",
"id": "Microsoft",
"language": "en",
"matches": [
{
"confidenceScore": 0.49,
"length": 9,
"offset": 0,
"text": "Microsoft"
}
],
"name": "Microsoft",
"url": "https://en.wikipedia.org/wiki/Microsoft"
}
],
"id": "1",
"warnings": []
},
{
"entities": [
{
"dataSource": "Wikipedia",
"id": "Pike Place Market",
"language": "en",
"matches": [
{
"confidenceScore": 0.86,
"length": 17,
"offset": 0,
"text": "Pike place market"
}
],
"name": "Pike Place Market",
"url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
},
{
"dataSource": "Wikipedia",
"id": "Seattle",
"language": "en",
"matches": [
{
"confidenceScore": 0.27,
"length": 7,
"offset": 33,
"text": "Seattle"
}
],
"name": "Seattle",
"url": "https://en.wikipedia.org/wiki/Seattle"
}
],
"id": "2",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-02-01"
}
}
SuccessfulEntityRecognitionRequest
Sample Request
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "EntityRecognition",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Pike place market is my favorite Seattle attraction."
}
]
}
}
Sample Response
{
"kind": "EntityRecognitionResults",
"results": {
"documents": [
{
"entities": [
{
"category": "Organization",
"confidenceScore": 0.84,
"length": 9,
"offset": 0,
"text": "Microsoft"
},
{
"category": "Person",
"confidenceScore": 0.85,
"length": 10,
"offset": 25,
"text": "Bill Gates"
},
{
"category": "Person",
"confidenceScore": 0.9,
"length": 10,
"offset": 40,
"text": "Paul Allen"
}
],
"id": "1",
"warnings": []
},
{
"entities": [
{
"category": "Location",
"confidenceScore": 0.55,
"length": 7,
"offset": 33,
"subcategory": "GPE",
"text": "Seattle"
}
],
"id": "2",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-04-01"
}
}
SuccessfulKeyPhraseExtractionRequest
Sample Request
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "KeyPhraseExtraction",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Text Analytics is one of the Azure Cognitive Services."
},
{
"id": "3",
"language": "en",
"text": "My cat might need to see a veterinarian."
}
]
}
}
Sample Response
{
"kind": "KeyPhraseExtractionResults",
"results": {
"documents": [
{
"id": "1",
"keyPhrases": [
"Bill Gates",
"Paul Allen",
"Microsoft"
],
"warnings": []
},
{
"id": "2",
"keyPhrases": [
"Azure Cognitive Services",
"Text Analytics"
],
"warnings": []
},
{
"id": "3",
"keyPhrases": [
"cat",
"veterinarian"
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-06-01"
}
}
SuccessfulLanguageDetectionRequest
Sample Request
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "LanguageDetection",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"text": "Hello world"
},
{
"id": "2",
"text": "Bonjour tout le monde"
},
{
"id": "3",
"text": "Hola mundo"
},
{
"id": "4",
"text": "Tumhara naam kya hai?"
}
]
}
}
Sample Response
{
"kind": "LanguageDetectionResults",
"results": {
"documents": [
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "en",
"name": "English"
},
"id": "1",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "fr",
"name": "French"
},
"id": "2",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "es",
"name": "Spanish"
},
"id": "3",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "hi",
"name": "Hindi"
},
"id": "4",
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-01-05"
}
}
SuccessfulPiiEntityRecognitionRequest
Sample Request
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "PiiEntityRecognition",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "My SSN is 859-98-0987"
},
{
"id": "2",
"language": "en",
"text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
},
{
"id": "3",
"language": "en",
"text": "Is 998.214.865-68 your Brazilian CPF number?"
}
]
}
}
Sample Response
{
"kind": "PiiEntityRecognitionResults",
"results": {
"documents": [
{
"id": "1",
"redactedText": "My SSN is ***********",
"entities": [
{
"category": "USSocialSecurityNumber",
"confidenceScore": 0.65,
"length": 11,
"offset": 28,
"text": "859-98-0987"
}
],
"warnings": []
},
{
"id": "2",
"redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
"entities": [
{
"category": "ABARoutingNumber",
"confidenceScore": 0.75,
"length": 9,
"offset": 18,
"text": "111000025"
}
],
"warnings": []
},
{
"id": "3",
"redactedText": "Is ************** your Brazilian CPF number?",
"entities": [
{
"category": "BRCPFNumber",
"confidenceScore": 0.85,
"length": 14,
"offset": 3,
"text": "998.214.865-68"
}
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-01-15"
}
}
SuccessfulSentimentAnalysisRequest
Sample Request
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "SentimentAnalysis",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
}
]
}
}
Sample Response
{
"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 |
---|---|
Analyze |
Contiene l'input di collegamento dell'entità di testo di analisi. |
Analyze |
Il riconoscimento dell'entità analizza la richiesta di attività di input di testo. |
Analyze |
Contiene l'input dell'attività Analyze text KeyPhraseExtraction. |
Analyze |
Contiene l'input dell'attività di analisi dei documenti di rilevamento della lingua. |
Analyze |
Contiene l'input dell'attività analizza testo PIIEntityRecognition. |
Analyze |
Contiene l'input dell'attività Analisi del testo SentimentAnalysis. |
Analyze |
Tipo di attività di analisi-testo supportate. |
Analyze |
Tipo dell'oggetto risposta restituito dall'attività analyze-text. |
Detected |
Contiene i dettagli della lingua rilevata per il testo. |
Document |
Contiene i dettagli degli errori rilevati durante l'esecuzione di un processo. |
Document |
Valutazione stimata per il documento (negativo, neutro, positivo o misto). |
Document |
se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento. |
Document |
Contiene l'oggetto avvisi con avvisi rilevati per il documento elaborato. |
Entities |
Contiene il risultato dell'attività di riconoscimento delle entità per il documento. |
Entities |
Contiene il risultato dell'attività di riconoscimento dell'entità. |
Entities |
Parametri supportati per un'attività Riconoscimento entità. |
Entities |
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. |
Entity |
Risultato del collegamento di entità. |
Entity |
Parametri supportati per un'attività Entity Linking. |
Entity |
Contiene il risultato dell'attività di collegamento dell'entità di testo di analisi. |
Error |
L'oggetto risposta di errore restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta. |
Error |
Codice di errore leggibile dall'utente. |
Error |
Risposta di errore. |
Inner |
Codice di errore leggibile dall'utente. |
Inner |
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Key |
Contiene keyPhraseResult. |
Key |
Contiene i risultati dell'estrazione delle frasi chiave per un documento. |
Key |
Parametri supportati per un'attività Estrazione frasi chiave. |
Key |
Contiene il risultato dell'attività Analyze text KeyPhraseExtraction. |
Language |
Contiene l'input di analisi del documento di rilevamento della lingua. |
Language |
Contiene il rilevamento della lingua per un documento. |
Language |
Contiene il risultato del rilevamento della lingua per la richiesta. |
Language |
Parametri supportati per un'attività Rilevamento lingua. |
Language |
Contiene il risultato dell'attività di rilevamento della lingua per la richiesta. |
Language |
Contiene l'input di rilevamento della lingua. |
Linked |
Risultato del documento di collegamento delle entità. |
Linked |
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. |
Multi |
Raccolta di documenti di input da analizzare dal servizio. |
Multi |
Contiene un documento di input da analizzare dal servizio. |
Pii |
(Facoltativo) descrive le categorie di dati personali da restituire |
Pii |
Dominio per l'attività PII |
Pii |
Contiene i risultati delle informazioni personali. |
Pii |
Contiene PiiResult. |
Pii |
Parametri supportati per un'attività Riconoscimento entità PII. |
Pii |
Contiene l'attività Analizza testo PIIEntityRecognition LRO. |
Request |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload della richiesta. |
Sentence |
Rappresenta una valutazione delle frasi e le valutazioni o gli oggetti di destinazione correlati. |
Sentence |
Sentiment della frase di un documento. |
Sentence |
Sentiment previsto per la frase. |
Sentence |
Rappresenta una destinazione di frase e le valutazioni o gli oggetti di destinazione correlati. |
Sentiment |
Parametri supportati per un'attività Analisi del sentiment. |
Sentiment |
Rappresenta i punteggi di attendibilità compresi tra 0 e 1 in tutte le classi di sentiment: positivo, neutro, negativo. |
Sentiment |
Oggetto che rappresenta i risultati dell'analisi del sentiment predefinita di ogni documento. |
Sentiment |
Risultati dell'analisi del sentiment per i documenti di input. |
Sentiment |
Contiene il risultato dell'attività Analisi sentimentAnalysis LRO. |
String |
Tipo di indice stringa |
Target |
Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo. |
Target |
Rappresenta la relazione tra valutazioni e/o destinazioni. |
Target |
Tipo correlato alla destinazione. |
Token |
Sentiment previsto per la frase. |
Warning |
Definisce l'elenco dei codici di avviso. |
AnalyzeTextEntityLinkingInput
Contiene l'input di collegamento dell'entità di testo di analisi.
Nome | Tipo | Descrizione |
---|---|---|
analysisInput |
Contiene l'input di analisi da gestire dal servizio. |
|
kind |
string:
Entity |
Tipo di attività da eseguire. |
parameters |
Parametri dell'attività. |
AnalyzeTextEntityRecognitionInput
Il riconoscimento dell'entità analizza la richiesta di attività di input di testo.
Nome | Tipo | Descrizione |
---|---|---|
analysisInput |
Input da analizzare. |
|
kind |
string:
Entity |
Tipo di attività da eseguire. |
parameters |
Parametri dell'attività. |
AnalyzeTextKeyPhraseExtractionInput
Contiene l'input dell'attività Analyze text KeyPhraseExtraction.
Nome | Tipo | Descrizione |
---|---|---|
analysisInput |
Contiene i documenti di input. |
|
kind |
string:
Key |
Tipo di attività da eseguire. |
parameters |
Parametri dell'attività di estrazione frasi chiave. |
AnalyzeTextLanguageDetectionInput
Contiene l'input dell'attività di analisi dei documenti di rilevamento della lingua.
Nome | Tipo | Descrizione |
---|---|---|
analysisInput |
Documenti da analizzare. |
|
kind |
string:
Language |
Tipo di attività da eseguire. |
parameters |
parametri dell'attività. |
AnalyzeTextPiiEntitiesRecognitionInput
Contiene l'input dell'attività analizza testo PIIEntityRecognition.
Nome | Tipo | Descrizione |
---|---|---|
analysisInput |
Contiene i documenti di input. |
|
kind |
string:
Pii |
Tipo di attività da eseguire. |
parameters |
Parametri dell'attività Pii. |
AnalyzeTextSentimentAnalysisInput
Contiene l'input dell'attività Analisi del testo SentimentAnalysis.
Nome | Tipo | Descrizione |
---|---|---|
analysisInput |
Contiene i documenti di input. |
|
kind |
string:
Sentiment |
Tipo di attività da eseguire. |
parameters |
Parametri dell'attività Analisi del sentiment. |
AnalyzeTextTaskKind
Tipo di attività di analisi-testo supportate.
Nome | Tipo | Descrizione |
---|---|---|
EntityLinking |
string |
Attività di collegamento delle entità |
EntityRecognition |
string |
Attività di riconoscimento delle entità |
KeyPhraseExtraction |
string |
Attività di estrazione frasi chiave |
LanguageDetection |
string |
Attività di rilevamento della lingua |
PiiEntityRecognition |
string |
Attività di riconoscimento delle entità PII |
SentimentAnalysis |
string |
Attività analisi del sentiment |
AnalyzeTextTaskResultsKind
Tipo dell'oggetto risposta restituito dall'attività analyze-text.
Nome | Tipo | Descrizione |
---|---|---|
EntityLinkingResults |
string |
Risultati del collegamento di entità |
EntityRecognitionResults |
string |
Risultati del riconoscimento delle entità |
KeyPhraseExtractionResults |
string |
Risultati dell'estrazione di frasi chiave |
LanguageDetectionResults |
string |
Risultati del rilevamento della lingua |
PiiEntityRecognitionResults |
string |
Risultati del riconoscimento delle entità piI |
SentimentAnalysisResults |
string |
Risultati dell'analisi del sentiment |
DetectedLanguage
Contiene i dettagli della lingua rilevata per il testo.
Nome | Tipo | Descrizione |
---|---|---|
confidenceScore |
number |
Punteggio di attendibilità compreso tra 0 e 1. I punteggi prossimi a 1 indicano con una certezza del 100% che la lingua identificata è true. |
iso6391Name |
string |
Rappresentazione di due lettere della lingua rilevata in base allo standard ISO 639-1 (ad esempio en, fr). |
name |
string |
Nome lungo di una lingua rilevata (ad esempio inglese, francese). |
DocumentError
Contiene i dettagli degli errori rilevati durante l'esecuzione di un processo.
Nome | Tipo | Descrizione |
---|---|---|
error |
Errore rilevato. |
|
id |
string |
ID del documento di input. |
DocumentSentimentValue
Valutazione stimata per il documento (negativo, neutro, positivo o misto).
Nome | Tipo | Descrizione |
---|---|---|
mixed |
string |
Istruzione mista |
negative |
string |
Istruzione negativa |
neutral |
string |
Istruzione neutrale |
positive |
string |
Dichiarazione positiva |
DocumentStatistics
se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload del documento.
Nome | Tipo | Descrizione |
---|---|---|
charactersCount |
integer |
Numero di elementi di testo riconosciuti nel documento. |
transactionsCount |
integer |
Numero di transazioni per il documento. |
DocumentWarning
Contiene l'oggetto avvisi con avvisi rilevati per il documento elaborato.
Nome | Tipo | Descrizione |
---|---|---|
code |
Codice di avviso. |
|
message |
string |
Messaggio di avviso. |
targetRef |
string |
Riferimento puntatore JSON che indica l'oggetto di destinazione. |
EntitiesDocumentResult
Contiene il risultato dell'attività di riconoscimento delle entità per il documento.
Nome | Tipo | Descrizione |
---|---|---|
entities |
Entity[] |
Entità riconosciute nel documento. |
id |
string |
Identificatore di documento univoco e non vuoto. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload del documento. |
|
warnings |
Avvisi rilevati durante l'elaborazione del documento. |
EntitiesResult
Contiene il risultato dell'attività di riconoscimento dell'entità.
Nome | Tipo | Descrizione |
---|---|---|
documents |
Risposta per documento |
|
errors |
Errori in base all'ID documento. |
|
modelVersion |
string |
Questo campo indica quale modello viene usato per l'assegnazione dei punteggi. |
statistics |
se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta. |
EntitiesTaskParameters
Parametri supportati per un'attività Riconoscimento entità.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
loggingOptOut |
boolean |
False |
rifiutare esplicitamente la registrazione |
modelVersion |
string |
latest |
versione del modello |
stringIndexType | TextElements_v8 |
(Facoltativo) parametro per specificare il tipo di indice stringa usato per interpretare gli offset di stringa. Il valore predefinito è TextElements (Graphemes). |
EntitiesTaskResult
Contiene l'attività dell'entità
Nome | Tipo | Descrizione |
---|---|---|
kind |
string:
Entity |
Tipo di risultato dell'attività. |
results |
Risultati per il riconoscimento delle entità. |
Entity
Definisce l'oggetto entità rilevato contenente la categoria di entità e il testo dell'entità rilevati e così via.
Nome | Tipo | Descrizione |
---|---|---|
category |
string |
Tipo di entità. |
confidenceScore |
number |
Punteggio di attendibilità compreso tra 0 e 1 dell'entità estratta. |
length |
integer |
Lunghezza per il testo dell'entità. L'uso di valori 'stringIndexType' diversi può influire sulla lunghezza restituita. |
offset |
integer |
Posizione iniziale per il testo dell'entità. L'uso di valori 'stringIndexType' diversi può influire sull'offset restituito. |
subcategory |
string |
(Facoltativo) Sottotipo entità. |
text |
string |
Testo dell'entità visualizzato nella richiesta. |
EntityLinkingResult
Risultato del collegamento di entità.
Nome | Tipo | Descrizione |
---|---|---|
documents |
Risposta per documento |
|
errors |
Errori in base all'ID documento. |
|
modelVersion |
string |
Questo campo indica quale modello viene usato per l'assegnazione dei punteggi. |
statistics |
se showStats=true è stato specificato nella richiesta, questo campo conterrà informazioni sul payload della richiesta. |
EntityLinkingTaskParameters
Parametri supportati per un'attività Entity Linking.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
loggingOptOut |
boolean |
False |
rifiutare esplicitamente la registrazione |
modelVersion |
string |
latest |
versione del modello |
stringIndexType | TextElements_v8 |
Parametro facoltativo per specificare il tipo di indice stringa usato per interpretare gli offset di stringa. Il valore predefinito è TextElements (Graphemes). |
EntityLinkingTaskResult
Contiene il risultato dell'attività di collegamento dell'entità di testo di analisi.
Nome | Tipo | Descrizione |
---|---|---|
kind |
string:
Entity |
Tipo di risultato dell'attività. |
results |
Risultato del collegamento di entità. |
Error
L'oggetto risposta di errore restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.
Nome | Tipo | Descrizione |
---|---|---|
code |
Uno dei set definiti dal server di codici di errore. |
|
details |
Error[] |
Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato. |
innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
message |
string |
Rappresentazione leggibile dell'errore. |
target |
string |
Destinazione dell'errore. |
ErrorCode
Codice di errore leggibile dall'utente.
Nome | Tipo | Descrizione |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
Ricerca cognitiva di Azure limite di indice raggiunto l'errore |
AzureCognitiveSearchIndexNotFound |
string |
Ricerca cognitiva di Azure indice non trovato |
AzureCognitiveSearchNotFound |
string |
Ricerca cognitiva di Azure errore non trovato |
AzureCognitiveSearchThrottling |
string |
Ricerca cognitiva di Azure errore di limitazione delle limitazioni |
Conflict |
string |
errore di conflitto |
Forbidden |
string |
Errore di accesso non consentito |
InternalServerError |
string |
Errore interno del server |
InvalidArgument |
string |
Errore di argomento non valido |
InvalidRequest |
string |
Errore di richiesta non valido |
NotFound |
string |
Errore non trovato |
OperationNotFound |
string |
Operazione non trovata |
ProjectNotFound |
string |
Errore del progetto non trovato |
QuotaExceeded |
string |
Errore di superamento della quota |
ServiceUnavailable |
string |
Errore non disponibile del servizio |
Timeout |
string |
Errore di timeout |
TooManyRequests |
string |
Errore di troppe richieste |
Unauthorized |
string |
Errore di accesso non autorizzato |
Warning |
string |
Errore di avviso |
ErrorResponse
Risposta di errore.
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
InnerErrorCode
Codice di errore leggibile dall'utente.
Nome | Tipo | Descrizione |
---|---|---|
AzureCognitiveSearchNotFound |
string |
Ricerca cognitiva di Azure errore non trovato |
AzureCognitiveSearchThrottling |
string |
Ricerca cognitiva di Azure errore di limitazione delle limitazioni |
EmptyRequest |
string |
Errore di richiesta vuota |
ExtractionFailure |
string |
Errore di estrazione |
InvalidCountryHint |
string |
Errore di suggerimento paese non valido |
InvalidDocument |
string |
Errore del documento non valido |
InvalidDocumentBatch |
string |
Errore del batch di documenti non valido |
InvalidParameterValue |
string |
Errore del valore del parametro non valido |
InvalidRequest |
string |
Errore di richiesta non valido |
InvalidRequestBodyFormat |
string |
Errore di formato del corpo della richiesta non valido |
KnowledgeBaseNotFound |
string |
Errore di Knowledge Base non trovato |
MissingInputDocuments |
string |
Errore dei documenti di input mancanti |
ModelVersionIncorrect |
string |
Errore di versione del modello non corretto |
UnsupportedLanguageCode |
string |
Errore di codice lingua non supportato |
InnerErrorModel
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nome | Tipo | Descrizione |
---|---|---|
code |
Uno di un set definito dal server di codici di errore. |
|
details |
object |
Dettagli degli errori. |
innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione errore. |
KeyPhraseResult
Contiene keyPhraseResult.
Nome | Tipo | Descrizione |
---|---|---|
documents |
Risposta per documento |
|
errors |
Errori in base all'ID documento. |
|
modelVersion |
string |
Questo campo indica quale modello viene usato per l'assegnazione dei punteggi. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload della richiesta. |
KeyPhrasesDocumentResult
Contiene i risultati dell'estrazione delle frasi chiave per un documento.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore di documento univoco e non vuoto. |
keyPhrases |
string[] |
Elenco di parole o frasi rappresentative. Il numero di frasi chiave restituite è proporzionale al numero di parole nel documento di input. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload del documento. |
|
warnings |
Avvisi rilevati durante l'elaborazione del documento. |
KeyPhraseTaskParameters
Parametri supportati per un'attività Estrazione frasi chiave.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
loggingOptOut |
boolean |
False |
rifiutare esplicitamente la registrazione |
modelVersion |
string |
latest |
versione del modello |
KeyPhraseTaskResult
Contiene il risultato dell'attività Analyze text KeyPhraseExtraction.
Nome | Tipo | Descrizione |
---|---|---|
kind |
string:
Key |
Tipo di risultato dell'attività. |
results |
Elenco dei risultati dell'estrazione di frasi chiave |
LanguageDetectionAnalysisInput
Contiene l'input di analisi del documento di rilevamento della lingua.
Nome | Tipo | Descrizione |
---|---|---|
documents |
Elenco di documenti da analizzare. |
LanguageDetectionDocumentResult
Contiene il rilevamento della lingua per un documento.
Nome | Tipo | Descrizione |
---|---|---|
detectedLanguage |
Lingua rilevata. |
|
id |
string |
Identificatore di documento univoco e non vuoto. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload del documento. |
|
warnings |
Avvisi rilevati durante l'elaborazione del documento. |
LanguageDetectionResult
Contiene il risultato del rilevamento della lingua per la richiesta.
Nome | Tipo | Descrizione |
---|---|---|
documents |
Enumerazione dei risultati del rilevamento della lingua per ogni documento di input. |
|
errors |
Errori in base all'ID documento. |
|
modelVersion |
string |
Questo campo indica quale modello viene usato per l'assegnazione dei punteggi. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload della richiesta. |
LanguageDetectionTaskParameters
Parametri supportati per un'attività Rilevamento lingua.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
loggingOptOut |
boolean |
False |
rifiutare esplicitamente la registrazione |
modelVersion |
string |
latest |
versione del modello |
LanguageDetectionTaskResult
Contiene il risultato dell'attività di rilevamento della lingua per la richiesta.
Nome | Tipo | Descrizione |
---|---|---|
kind |
string:
Language |
Tipo di risultato dell'attività. |
results |
Contiene i risultati del rilevamento della lingua. |
LanguageInput
Contiene l'input di rilevamento della lingua.
Nome | Tipo | Descrizione |
---|---|---|
countryHint |
string |
Suggerimento per il paese per facilitare il rilevamento della lingua del testo. |
id |
string |
Identificatore di documento univoco e non vuoto. |
text |
string |
Testo di input da elaborare. |
LinkedEntitiesDocumentResult
Risultato del documento di collegamento delle entità.
Nome | Tipo | Descrizione |
---|---|---|
entities |
Entità note riconosciute nel documento. |
|
id |
string |
Identificatore di documento univoco e non vuoto. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload del documento. |
|
warnings |
Avvisi rilevati durante l'elaborazione del documento. |
LinkedEntity
Oggetto LinkedEntity contenente l'entità rilevata con le origini/collegamenti associati.
Nome | Tipo | Descrizione |
---|---|---|
bingId |
string |
Identificatore univoco dell'API Ricerca entità Bing dell'entità riconosciuta. |
dataSource |
string |
Origine dati usata per estrarre il collegamento di entità, ad esempio Wiki/Bing e così via. |
id |
string |
Identificatore univoco dell'entità riconosciuta dall'origine dati. |
language |
string |
Lingua utilizzata nell'origine dati. |
matches |
Match[] |
L'elenco di istanze di questa entità viene visualizzato nel testo. |
name |
string |
Nome formale di Entity Linking. |
url |
string |
URL della pagina dell'entità dall'origine dati. |
Match
Oggetto Match contenente il testo dell'entità rilevata con l'offset e la lunghezza.
Nome | Tipo | Descrizione |
---|---|---|
confidenceScore |
number |
Se viene riconosciuto un elemento noto, verrà restituito un numero decimale che indica il livello di confidenza compreso tra 0 e 1. |
length |
integer |
Lunghezza per il testo della corrispondenza dell'entità. |
offset |
integer |
Posizione iniziale per il testo della corrispondenza dell'entità. |
text |
string |
Testo dell'entità visualizzato nella richiesta. |
MultiLanguageAnalysisInput
Raccolta di documenti di input da analizzare dal servizio.
Nome | Tipo | Descrizione |
---|---|---|
documents |
Documenti di input da analizzare. |
MultiLanguageInput
Contiene un documento di input da analizzare dal servizio.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
Identificatore di documento univoco e non vuoto. |
language |
string |
(Facoltativo) Si tratta della rappresentazione ISO 639-1 di 2 lettere di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo 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. |
PiiCategory
(Facoltativo) descrive le categorie di dati personali da restituire
Nome | Tipo | Descrizione |
---|---|---|
ABARoutingNumber |
string |
Numero di routing ABA |
ARNationalIdentityNumber |
string |
Numero di identità nazionale AR |
ATIdentityCard |
string |
Scheda identità AT |
ATTaxIdentificationNumber |
string |
Numero di identificazione fiscale AT |
ATValueAddedTaxNumber |
string |
Numero di imposta aggiunto al valore AT |
AUBankAccountNumber |
string |
Scheda identità AT |
AUBusinessNumber |
string |
Numero di business au |
AUCompanyNumber |
string |
Numero aziendale au |
AUDriversLicenseNumber |
string |
Numero di licenza di AU Driver |
AUMedicalAccountNumber |
string |
Numero di account medico au |
AUPassportNumber |
string |
Numero di passaporto AU |
AUTaxFileNumber |
string |
Numero di file fiscale AU |
Address |
string |
Indirizzo |
Age |
string |
Età |
All |
string |
Tutte le categorie di informazioni personali. |
AzureDocumentDBAuthKey |
string |
Chiave di autenticazione del database documenti di Azure |
AzureIAASDatabaseConnectionAndSQLString |
string |
Connessione al database IAAS di Azure e stringa SQL |
AzureIoTConnectionString |
string |
Stringa di connessione di Azure IoT |
AzurePublishSettingPassword |
string |
Password delle impostazioni di pubblicazione di Azure |
AzureRedisCacheString |
string |
Stringa di cache Redis di Azure |
AzureSAS |
string |
Azure SAS |
AzureServiceBusString |
string |
bus di servizio di Azure stringa |
AzureStorageAccountGeneric |
string |
Account di archiviazione di Azure Generico |
AzureStorageAccountKey |
string |
Chiave dell'account di archiviazione di Azure |
BENationalNumber |
string |
Numero nazionale BE |
BENationalNumberV2 |
string |
BE National Number V2 |
BEValueAddedTaxNumber |
string |
NUMERO DI IMPOSTA AGGIUNTO VALORE |
BGUniformCivilNumber |
string |
Numero civile uniforme BG |
BRCPFNumber |
string |
Numero CPF BR |
BRLegalEntityNumber |
string |
Numero di entità legale BR |
BRNationalIDRG |
string |
BR National ID RG |
CABankAccountNumber |
string |
Numero conto bancario CA |
CADriversLicenseNumber |
string |
Numero di licenza del driver CA |
CAHealthServiceNumber |
string |
Numero di servizio integrità CA |
CAPassportNumber |
string |
Numero di passaporto CA |
CAPersonalHealthIdentification |
string |
Identificazione dell'integrità personale della CA |
CASocialInsuranceNumber |
string |
CA Social Insurance Number |
CHSocialSecurityNumber |
string |
Numero di previdenza sociale CH |
CLIdentityCardNumber |
string |
Numero di carta di identità CL |
CNResidentIdentityCardNumber |
string |
Numero di carta di identità residente CN |
CYIdentityCard |
string |
Carta di identità CY |
CYTaxIdentificationNumber |
string |
Numero di identificazione fiscale CY |
CZPersonalIdentityNumber |
string |
NUMERO di identità personale DI CZ |
CZPersonalIdentityV2 |
string |
IDENTITÀ PERSONALE DI CZ V2 |
CreditCardNumber |
string |
Numero di carta di credito |
DEDriversLicenseNumber |
string |
Numero di licenza de driver |
DEIdentityCardNumber |
string |
Numero di carta di identità DE |
DEPassportNumber |
string |
NUMERO DI PASSAPORTO DE |
DETaxIdentificationNumber |
string |
Numero di identificazione fiscale DE |
DEValueAddedNumber |
string |
Numero aggiunto valore DE |
DKPersonalIdentificationNumber |
string |
Numero di identificazione personale DK |
DKPersonalIdentificationV2 |
string |
DK Personal Identification V2 |
Date |
string |
Data |
Default |
string |
Categorie di informazioni personali predefinite per la lingua. |
DrugEnforcementAgencyNumber |
string |
Numero dell'agenzia di imposizione delle droghe |
EEPersonalIdentificationCode |
string |
Codice di identificazione personale EE |
ESDNI |
string |
ES DNI |
ESSocialSecurityNumber |
string |
Numero di previdenza sociale ES |
ESTaxIdentificationNumber |
string |
Numero di identificazione fiscale ES |
EUDebitCardNumber |
string |
Numero di carta di debito UE |
EUDriversLicenseNumber |
string |
Numero di patente di guida EU |
EUGPSCoordinates |
string |
Coordinate GPS EU |
EUNationalIdentificationNumber |
string |
Numero documento di identità EU |
EUPassportNumber |
string |
Numero di passaporto EU |
EUSocialSecurityNumber |
string |
Numero di sicurezza sociale DELL'UE |
EUTaxIdentificationNumber |
string |
Numero di identificazione fiscale UE |
string |
|
|
FIEuropeanHealthNumber |
string |
FI European Health Number |
FINationalID |
string |
ID nazionale FI |
FINationalIDV2 |
string |
FI National ID V2 |
FIPassportNumber |
string |
Numero di passaporto FI |
FRDriversLicenseNumber |
string |
Numero di licenza del driver FR |
FRHealthInsuranceNumber |
string |
Numero di assicurazione sanitaria FR |
FRNationalID |
string |
ID nazionale FR |
FRPassportNumber |
string |
Numero di passaporto FR |
FRSocialSecurityNumber |
string |
Numero di previdenza sociale FR |
FRTaxIdentificationNumber |
string |
Numero di identificazione fiscale FR |
FRValueAddedTaxNumber |
string |
Numero di imposta aggiunto valore FR |
GRNationalIDCard |
string |
Carta ID nazionale GR |
GRNationalIDV2 |
string |
ID nazionale GR V2 |
GRTaxIdentificationNumber |
string |
Numero di identificazione fiscale GR |
HKIdentityCardNumber |
string |
Numero di carta di identità HK |
HRIdentityCardNumber |
string |
Numero di carta di identità HR |
HRNationalIDNumber |
string |
Numero ID nazionale HR |
HRPersonalIdentificationNumber |
string |
Numero di identificazione personale hr |
HRPersonalIdentificationOIBNumberV2 |
string |
Numero OIB di identificazione personale HR V2 |
HUPersonalIdentificationNumber |
string |
Numero di identificazione personale HU |
HUTaxIdentificationNumber |
string |
Numero di identificazione fiscale HU |
HUValueAddedNumber |
string |
Numero aggiunto valore HU |
IDIdentityCardNumber |
string |
Numero di carta di identità ID |
IEPersonalPublicServiceNumber |
string |
Numero di servizio pubblico personale IE |
IEPersonalPublicServiceNumberV2 |
string |
Numero di servizio pubblico personale IE V2 |
ILBankAccountNumber |
string |
Numero conto bancario IL |
ILNationalID |
string |
ID nazionale IL |
INPermanentAccount |
string |
Account permanente IN |
INUniqueIdentificationNumber |
string |
IN Numero di identificazione univoco |
IPAddress |
string |
Indirizzo IP |
ITDriversLicenseNumber |
string |
Numero di licenza del driver IT |
ITFiscalCode |
string |
Codice fiscale IT |
ITValueAddedTaxNumber |
string |
Numero di imposta aggiunto valore IT |
InternationalBankingAccountNumber |
string |
Numero di conto bancario internazionale |
JPBankAccountNumber |
string |
Numero di conto corrente bancario JP |
JPDriversLicenseNumber |
string |
Numero di licenza del driver JP |
JPMyNumberCorporate |
string |
JP My Number Corporate |
JPMyNumberPersonal |
string |
JP My Number Personal |
JPPassportNumber |
string |
Numero di passaporto JP |
JPResidenceCardNumber |
string |
Numero di carta di residenza JP |
JPResidentRegistrationNumber |
string |
Numero di registrazione residente JP |
JPSocialInsuranceNumber |
string |
JP Social Insurance Number |
KRResidentRegistrationNumber |
string |
KR Resident Registration Number |
LTPersonalCode |
string |
LT Personal Code |
LUNationalIdentificationNumberNatural |
string |
LU National Identification Number Natural |
LUNationalIdentificationNumberNonNatural |
string |
Numero di identificazione nazionale LU non naturale |
LVPersonalCode |
string |
Codice personale LV |
MTIdentityCardNumber |
string |
Numero di carta di identità MT |
MTTaxIDNumber |
string |
NUMERO DI PARTITA IVA MT |
MYIdentityCardNumber |
string |
MY Identity Card Number |
NLCitizensServiceNumber |
string |
NL Citizens Service Number |
NLCitizensServiceNumberV2 |
string |
NL Citizens Service Number V2 |
NLTaxIdentificationNumber |
string |
Numero di identificazione fiscale NL |
NLValueAddedTaxNumber |
string |
NL Value Added Tax Number |
NOIdentityNumber |
string |
NO Identity Number |
NZBankAccountNumber |
string |
Numero conto bancario NZ |
NZDriversLicenseNumber |
string |
Numero di licenza del driver NZ |
NZInlandRevenueNumber |
string |
NZ Inland Revenue Number |
NZMinistryOfHealthNumber |
string |
Numero di salute del Ministero della Sanità della NZ |
NZSocialWelfareNumber |
string |
NZ Social Welfare Number |
Organization |
string |
Organizzazione |
PHUnifiedMultiPurposeIDNumber |
string |
PH Unified Multi Purpose ID Number |
PLIdentityCard |
string |
PL Identity Card |
PLNationalID |
string |
PL National ID |
PLNationalIDV2 |
string |
PL National ID V2 |
PLPassportNumber |
string |
PL Passport Number |
PLREGONNumber |
string |
PL REGON Number |
PLTaxIdentificationNumber |
string |
PL Tax Identification Number |
PTCitizenCardNumber |
string |
PT Citizen Card Number |
PTCitizenCardNumberV2 |
string |
PT Citizen Card Number V2 |
PTTaxIdentificationNumber |
string |
Numero di identificazione fiscale PT |
Person |
string |
Persona |
PhoneNumber |
string |
Numero di telefono |
ROPersonalNumericalCode |
string |
Codice numerico personale RO |
RUPassportNumberDomestic |
string |
Numero di passaporto UR Nazionale |
RUPassportNumberInternational |
string |
UR Passport Number International |
SANationalID |
string |
ID nazionale SA |
SENationalID |
string |
SE National ID |
SENationalIDV2 |
string |
SE National ID V2 |
SEPassportNumber |
string |
SE Passport Number |
SETaxIdentificationNumber |
string |
SE Tax Identification Number |
SGNationalRegistrationIdentityCardNumber |
string |
SG National Registration Identity Card Number |
SITaxIdentificationNumber |
string |
SI Tax Identification Number |
SIUniqueMasterCitizenNumber |
string |
SI Unique Master Citizen Number |
SKPersonalNumber |
string |
SK Personal Number |
SQLServerConnectionString |
string |
Stringa di connessione di SQL Server |
SWIFTCode |
string |
Codice SWIFT |
THPopulationIdentificationCode |
string |
Codice di identificazione popolamento TH |
TRNationalIdentificationNumber |
string |
Numero di identificazione nazionale TR |
TWNationalID |
string |
ID nazionale TW |
TWPassportNumber |
string |
TW Passport Number |
TWResidentCertificate |
string |
Certificato residente TW |
UAPassportNumberDomestic |
string |
UA Passport Number Domestic |
UAPassportNumberInternational |
string |
UA Passport Number International |
UKDriversLicenseNumber |
string |
Numero di patente del conducente del Regno Unito |
UKElectoralRollNumber |
string |
Numero di rollforni elettorali del Regno Unito |
UKNationalHealthNumber |
string |
Numero di salute nazionale del Regno Unito |
UKNationalInsuranceNumber |
string |
UK National Insurance Number |
UKUniqueTaxpayerNumber |
string |
Numero univoco del contribuente britannico |
URL |
string |
URL |
USBankAccountNumber |
string |
Numero conto corrente bancario degli Stati Uniti |
USDriversLicenseNumber |
string |
US Driver's License Number |
USIndividualTaxpayerIdentification |
string |
Identificazione dei singoli contribuenti statunitensi |
USSocialSecurityNumber |
string |
Numero di previdenza sociale degli Stati Uniti |
USUKPassportNumber |
string |
US UK Passport Number |
ZAIdentificationNumber |
string |
Numero di identificazione ZA |
PiiDomain
Dominio per l'attività PII
Nome | Tipo | Descrizione |
---|---|---|
none |
string |
Indica che non è specificato alcun dominio. |
phi |
string |
Indica che le entità nel dominio Informazioni sull'integrità personale devono essere ridistribuite. |
PiiEntitiesDocumentResult
Contiene i risultati delle informazioni personali.
Nome | Tipo | Descrizione |
---|---|---|
entities |
Entity[] |
Entità riconosciute nel documento. |
id |
string |
Identificatore di documento univoco e non vuoto. |
redactedText |
string |
Restituisce testo redattito. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload del documento. |
|
warnings |
Avvisi rilevati durante l'elaborazione del documento. |
PiiResult
Contiene PiiResult.
Nome | Tipo | Descrizione |
---|---|---|
documents |
Risposta per documento |
|
errors |
Errori in base all'ID documento. |
|
modelVersion |
string |
Questo campo indica quale modello viene usato per l'assegnazione dei punteggi. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload della richiesta. |
PiiTaskParameters
Parametri supportati per un'attività Riconoscimento entità PII.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
domain | none |
Dominio per attività piI |
|
loggingOptOut |
boolean |
False |
rifiutare esplicitamente la registrazione |
modelVersion |
string |
latest |
versione del modello |
piiCategories |
Enumerazione delle categorie di informazioni personali da restituire nella risposta. |
||
stringIndexType | TextElements_v8 |
StringIndexType da utilizzare per l'analisi. |
PiiTaskResult
Contiene l'attività Analizza testo PIIEntityRecognition LRO.
Nome | Tipo | Descrizione |
---|---|---|
kind |
string:
Pii |
Tipo di risultato dell'attività. |
results |
Elenco dei risultati pii |
RequestStatistics
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload della richiesta.
Nome | Tipo | Descrizione |
---|---|---|
documentsCount |
integer |
Numero di documenti inviati nella richiesta. |
erroneousDocumentsCount |
integer |
Numero di documenti non validi. Include documenti di linguaggi vuoti, over-size o non supportati. |
transactionsCount |
integer |
Numero di transazioni per la richiesta. |
validDocumentsCount |
integer |
Numero di documenti validi. Ciò esclude documenti di linguaggi vuoti, over-size o non supportati. |
SentenceAssessment
Rappresenta una valutazione delle frasi e le valutazioni o gli oggetti di destinazione correlati.
Nome | Tipo | Descrizione |
---|---|---|
confidenceScores |
Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo. |
|
isNegated |
boolean |
Indicatore che rappresenta se la valutazione viene negata. |
length |
integer |
Lunghezza della destinazione. |
offset |
integer |
Offset di destinazione dall'inizio della frase. |
sentiment |
Sentiment della frase. |
|
text |
string |
Testo di destinazione rilevato. |
SentenceSentiment
Sentiment della frase di un documento.
Nome | Tipo | Descrizione |
---|---|---|
assessments |
Matrice di valutazioni per la frase. |
|
confidenceScores |
Punteggio di attendibilità del sentiment compreso tra 0 e 1 per la frase per tutte le classi. |
|
length |
integer |
Lunghezza della destinazione. |
offset |
integer |
Offset di destinazione dall'inizio della frase. |
sentiment |
Sentiment previsto per la frase. |
|
targets |
Matrice di destinazioni di frase per la frase. |
|
text |
string |
Testo della frase. |
SentenceSentimentValue
Sentiment previsto per la frase.
Nome | Tipo | Descrizione |
---|---|---|
negative |
string |
Sentiment negativo |
neutral |
string |
Sentiment neutrale |
positive |
string |
Sentiment positivo |
SentenceTarget
Rappresenta una destinazione di frase e le valutazioni o gli oggetti di destinazione correlati.
Nome | Tipo | Descrizione |
---|---|---|
confidenceScores |
Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo. |
|
length |
integer |
Lunghezza della destinazione. |
offset |
integer |
Offset di destinazione dall'inizio della frase. |
relations |
Matrice di oggetti di valutazione o di destinazione correlati alla destinazione. |
|
sentiment |
Sentiment della frase. |
|
text |
string |
Testo di destinazione rilevato. |
SentimentAnalysisTaskParameters
Parametri supportati per un'attività Analisi del sentiment.
Nome | Tipo | Valore predefinito | Descrizione |
---|---|---|---|
loggingOptOut |
boolean |
False |
rifiutare esplicitamente la registrazione |
modelVersion |
string |
latest |
versione del modello |
opinionMining |
boolean |
False |
Indica se utilizzare il opinion mining nella richiesta o meno. |
stringIndexType | TextElements_v8 |
Specifica il metodo utilizzato per interpretare gli offset di stringa. |
SentimentConfidenceScores
Rappresenta i punteggi di attendibilità compresi tra 0 e 1 in tutte le classi di sentiment: positivo, neutro, negativo.
Nome | Tipo | Descrizione |
---|---|---|
negative |
number |
Punteggio di attendibilità per il sentiment negativo |
neutral |
number |
Punteggio di attendibilità per il sentiment neutro |
positive |
number |
Punteggio di attendibilità per il sentiment positivo |
SentimentDocumentResult
Oggetto che rappresenta i risultati dell'analisi del sentiment predefinita di ogni documento.
Nome | Tipo | Descrizione |
---|---|---|
confidenceScores |
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 |
Sentiment delle frasi del documento. |
|
sentiment |
Sentiment stimato per il documento (Negativo, Neutrale, Positivo o Misto). |
|
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload del documento. |
|
warnings |
Avvisi rilevati durante l'elaborazione del documento. |
SentimentResponse
Risultati dell'analisi del sentiment per i documenti di input.
Nome | Tipo | Descrizione |
---|---|---|
documents |
L'analisi del sentiment restituisce i risultati di ogni documento nell'input. |
|
errors |
Errori in base all'ID documento. |
|
modelVersion |
string |
Questo campo indica quale modello viene usato per l'assegnazione dei punteggi. |
statistics |
se showStats=true è stato specificato nella richiesta questo campo conterrà informazioni sul payload della richiesta. |
SentimentTaskResult
Contiene il risultato dell'attività Analisi sentimentAnalysis LRO.
Nome | Tipo | Descrizione |
---|---|---|
kind |
string:
Sentiment |
Tipo di risultato dell'attività. |
results |
Risultati dell'analisi del sentiment |
StringIndexType
Tipo di indice stringa
Nome | Tipo | Descrizione |
---|---|---|
TextElements_v8 |
string |
I valori di offset e lunghezza restituiti corrispondono a TextElements (cluster Graphemes e Grapheme) che confermano lo standard Unicode 8.0.0. Usare questa opzione se l'applicazione è scritta in .Net Framework o .NET Core e si userà StringInfo. |
UnicodeCodePoint |
string |
I valori di offset e lunghezza restituiti corrispondono ai punti di codice Unicode. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio Python. |
Utf16CodeUnit |
string |
I valori di offset e lunghezza restituiti corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio JavaScript. |
TargetConfidenceScoreLabel
Rappresenta i punteggi di attendibilità in tutte le classi di sentiment: positivo e negativo.
Nome | Tipo | Descrizione |
---|---|---|
negative |
number |
Punteggio di attendibilità per il sentiment negativo |
positive |
number |
Punteggio di attendibilità per il sentiment positivo |
TargetRelation
Rappresenta la relazione tra valutazioni e/o destinazioni.
Nome | Tipo | Descrizione |
---|---|---|
ref |
string |
Puntatore JSON che indica l'oggetto collegato. |
relationType |
Tipo correlato alla destinazione. |
TargetRelationType
Tipo correlato alla destinazione.
Nome | Tipo | Descrizione |
---|---|---|
assessment |
string |
Relazione di valutazione. |
target |
string |
Relazione di destinazione. |
TokenSentimentValue
Sentiment previsto per la frase.
Nome | Tipo | Descrizione |
---|---|---|
mixed |
string |
Sentiment misto |
negative |
string |
Sentiment negativo |
positive |
string |
Sentiment positivo |
WarningCodeValue
Definisce l'elenco dei codici di avviso.
Nome | Tipo | Descrizione |
---|---|---|
DocumentTruncated |
string |
Avviso troncato del documento |
LongWordsInDocument |
string |
Parole lunghe nell'avviso del documento |