Text Analysis Runtime - Analyze Text

Referens

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Begär textanalys över en samling dokument.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
showStats	query		boolean	(Valfritt) om det är inställt på sant innehåller svaret statistik för begäran och dokumentnivå.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Brödtexten i begäran kan vara något av följande:

Name	Description
AnalyzeTextEntityLinkingInput	Innehåller analystexten Entity linking input (Entitetslänkningsindata).
AnalyzeTextEntityRecognitionInput	Entitetsigenkänningen analyserar begäran om textinmatningsaktivitet.
AnalyzeTextKeyPhraseExtractionInput	Innehåller indata från åtgärden KeyPhraseExtraction för att analysera texten.
AnalyzeTextLanguageDetectionInput	Innehåller indata för dokumentanalys för språkidentifiering.
AnalyzeTextPiiEntitiesRecognitionInput	Innehåller den analysera texten PIIEntityRecognition uppgiftsindata.
AnalyzeTextSentimentAnalysisInput	Innehåller den analysera texten SentimentAnalysis uppgiftsindata.

AnalyzeTextEntityLinkingInput

Innehåller analystexten Entity linking input (Entitetslänkningsindata).

Name	Obligatorisk	Typ	Description
kind	True	string: EntityLinking	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller de analysindata som ska hanteras av tjänsten.
parameters		EntityLinkingTaskParameters	Uppgiftsparametrar.

AnalyzeTextEntityRecognitionInput

Entitetsigenkänningen analyserar begäran om textinmatningsaktivitet.

Name	Obligatorisk	Typ	Description
kind	True	string: EntityRecognition	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	De indata som ska analyseras.
parameters		EntitiesTaskParameters	Uppgiftsparametrar.

AnalyzeTextKeyPhraseExtractionInput

Innehåller indata från åtgärden KeyPhraseExtraction för att analysera texten.

Name	Obligatorisk	Typ	Description
kind	True	string: KeyPhraseExtraction	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller indatadokumenten.
parameters		KeyPhraseTaskParameters	Parametrar för extrahering av nyckelfraser.

AnalyzeTextLanguageDetectionInput

Innehåller indata för dokumentanalys för språkidentifiering.

Name	Obligatorisk	Typ	Description
kind	True	string: LanguageDetection	Den typ av uppgift som ska utföras.
analysisInput		LanguageDetectionAnalysisInput	Dokument som ska analyseras.
parameters		LanguageDetectionTaskParameters	aktivitetsparametrar.

AnalyzeTextPiiEntitiesRecognitionInput

Innehåller den analysera texten PIIEntityRecognition uppgiftsindata.

Name	Obligatorisk	Typ	Description
kind	True	string: PiiEntityRecognition	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller indatadokumenten.
parameters		PiiTaskParameters	Pii-uppgiftsparametrar.

AnalyzeTextSentimentAnalysisInput

Innehåller den analysera texten SentimentAnalysis uppgiftsindata.

Name	Obligatorisk	Typ	Description
kind	True	string: SentimentAnalysis	Den typ av uppgift som ska utföras.
analysisInput		MultiLanguageAnalysisInput	Innehåller indatadokumenten.
parameters		SentimentAnalysisTaskParameters	Aktivitetsparametrar för attitydanalys.

Svar

Name	Typ	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Name

Typ

Description

200 OK

AnalyzeTextTaskResult:

EntitiesTaskResult
EntityLinkingTaskResult
KeyPhraseTaskResult
LanguageDetectionTaskResult
PiiTaskResult
SentimentTaskResult

Begäran har slutförts.

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Headers

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exempel

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

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


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

Sample Response

Status code:: 200

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

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:: 200

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

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:: 200

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

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:: 200

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

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:: 200

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

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

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


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

Sample Response

Status code:: 200

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

Definitioner

Name	Description
AnalyzeTextEntityLinkingInput	Innehåller analystexten Entity linking input (Entitetslänkningsindata).
AnalyzeTextEntityRecognitionInput	Entitetsigenkänningen analyserar begäran om textinmatningsaktivitet.
AnalyzeTextKeyPhraseExtractionInput	Innehåller indata från åtgärden KeyPhraseExtraction för att analysera texten.
AnalyzeTextLanguageDetectionInput	Innehåller indata för språkidentifieringsdokumentanalys.
AnalyzeTextPiiEntitiesRecognitionInput	Innehåller indata för uppgiften analyze text PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Innehåller indata för uppgiften Analysera text SentimentAnalysis.
AnalyzeTextTaskKind	Den typ av analys-text-uppgifter som stöds.
AnalyzeTextTaskResultsKind	Den typ av svarsobjekt som returneras av uppgiften analyze-text.
DetectedLanguage	Innehåller information om det identifierade språket för texten.
DocumentError	Innehåller information om fel som påträffas under en jobbkörning.
DocumentSentimentValue	Förutsagd attityd för dokument (negativ, neutral, positiv eller blandad).
DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
DocumentWarning	Innehåller varningsobjektet med varningar som påträffas för det bearbetade dokumentet.
EntitiesDocumentResult	Innehåller resultatet av entitetsigenkänningsaktiviteten för dokumentet.
EntitiesResult	Innehåller resultatet av entitetsigenkänningsaktiviteten.
EntitiesTaskParameters	Parametrar som stöds för en entitetsigenkänningsaktivitet.
EntitiesTaskResult	Innehåller entitetsaktiviteten
Entity	Definierar det identifierade entitetsobjektet som innehåller entitetskategorin och entitetstexten som identifieras osv.
EntityLinkingResult	Resultat av entitetslänkning.
EntityLinkingTaskParameters	Parametrar som stöds för en entitetslänkningsaktivitet.
EntityLinkingTaskResult	Innehåller analystexten Entitetslänkningsaktivitetsresultat.
Error	Felsvarsobjektet returnerades när tjänsten påträffar vissa fel under bearbetningen av begäran.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Innehåller KeyPhraseResult.
KeyPhrasesDocumentResult	Innehåller resultatet av extrahering av nyckelfraser för ett dokument.
KeyPhraseTaskParameters	Parametrar som stöds för en nyckelfrasextraheringsaktivitet.
KeyPhraseTaskResult	Innehåller resultatet av åtgärden Analysera text KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Innehåller indata för språkidentifieringsdokumentanalys.
LanguageDetectionDocumentResult	Innehåller språkidentifiering för ett dokument.
LanguageDetectionResult	Innehåller språkidentifieringsresultatet för begäran.
LanguageDetectionTaskParameters	Parametrar som stöds för en språkidentifieringsaktivitet.
LanguageDetectionTaskResult	Innehåller resultatet av språkidentifieringsaktiviteten för begäran.
LanguageInput	Innehåller indata för språkidentifiering.
LinkedEntitiesDocumentResult	Entitet som länkar dokumentresultat.
LinkedEntity	LinkedEntity-objektet som innehåller den identifierade entiteten med associerade källor/länkar.
Match	Match-objektet som innehåller den identifierade entitetstexten med förskjutningen och längden.
MultiLanguageAnalysisInput	Insamling av indatadokument som ska analyseras av tjänsten.
MultiLanguageInput	Innehåller ett indatadokument som ska analyseras av tjänsten.
PiiCategory	(Valfritt) beskriver PII-kategorierna som ska returneras
PiiDomain	Domän för PII-uppgift
PiiEntitiesDocumentResult	Innehåller PII-resultaten.
PiiResult	Innehåller PiiResult.
PiiTaskParameters	Parametrar som stöds för en PII-entitetsigenkänningsaktivitet.
PiiTaskResult	Innehåller LRO-uppgiften analysera text PIIEntityRecognition.
RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.
SentenceAssessment	Representerar en meningsutvärdering och de utvärderingar eller målobjekt som är relaterade till den.
SentenceSentiment	Ett dokuments meningssentiment.
SentenceSentimentValue	Den förutsagda attityden för meningen.
SentenceTarget	Representerar ett meningsmål och de utvärderingar eller målobjekt som är relaterade till det.
SentimentAnalysisTaskParameters	Parametrar som stöds för en attitydanalysaktivitet.
SentimentConfidenceScores	Representerar förtroendepoängen mellan 0 och 1 i alla sentimentklasser: positiva, neutrala, negativa.
SentimentDocumentResult	Ett objekt som representerar de färdiga sentimentanalysresultaten för varje dokument.
SentimentResponse	Sentimentanalysresultat för indatadokumenten.
SentimentTaskResult	Innehåller analystexten SentimentAnalysis LRO-uppgiftsresultat.
StringIndexType	Strängindextyp
TargetConfidenceScoreLabel	Representerar förtroendepoängen för alla sentimentklasser: positiva och negativa.
TargetRelation	Representerar relationen mellan utvärderingar och/eller mål.
TargetRelationType	Den typ som är relaterad till målet.
TokenSentimentValue	Den förutsagda attityden för meningen.
WarningCodeValue	Definierar listan över varningskoderna.

AnalyzeTextEntityLinkingInput

Innehåller analystexten Entity linking input (Entitetslänkningsindata).

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller de analysindata som ska hanteras av tjänsten.
kind	string: EntityLinking	Den typ av uppgift som ska utföras.
parameters	EntityLinkingTaskParameters	Uppgiftsparametrar.

AnalyzeTextEntityRecognitionInput

Entitetsigenkänningen analyserar begäran om textinmatningsaktivitet.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	De indata som ska analyseras.
kind	string: EntityRecognition	Den typ av uppgift som ska utföras.
parameters	EntitiesTaskParameters	Uppgiftsparametrar.

AnalyzeTextKeyPhraseExtractionInput

Innehåller indata från åtgärden KeyPhraseExtraction för att analysera texten.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller indatadokumenten.
kind	string: KeyPhraseExtraction	Den typ av uppgift som ska utföras.
parameters	KeyPhraseTaskParameters	Parametrar för extrahering av nyckelfraser.

AnalyzeTextLanguageDetectionInput

Innehåller indata för språkidentifieringsdokumentanalys.

Name	Typ	Description
analysisInput	LanguageDetectionAnalysisInput	Dokument som ska analyseras.
kind	string: LanguageDetection	Den typ av uppgift som ska utföras.
parameters	LanguageDetectionTaskParameters	aktivitetsparametrar.

AnalyzeTextPiiEntitiesRecognitionInput

Innehåller indata för uppgiften analyze text PIIEntityRecognition.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller indatadokumenten.
kind	string: PiiEntityRecognition	Den typ av uppgift som ska utföras.
parameters	PiiTaskParameters	Pii-aktivitetsparametrar.

AnalyzeTextSentimentAnalysisInput

Innehåller indata för uppgiften Analysera text SentimentAnalysis.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Innehåller indatadokumenten.
kind	string: SentimentAnalysis	Den typ av uppgift som ska utföras.
parameters	SentimentAnalysisTaskParameters	Aktivitetsparametrar för attitydanalys.

AnalyzeTextTaskKind

Den typ av analys-text-uppgifter som stöds.

Name	Typ	Description
EntityLinking	string	Entitetslänkningsaktivitet
EntityRecognition	string	Entitetsigenkänningsaktivitet
KeyPhraseExtraction	string	Extraheringsuppgift för nyckelfraser
LanguageDetection	string	Språkidentifieringsuppgift
PiiEntityRecognition	string	PII-entitetsigenkänningsaktivitet
SentimentAnalysis	string	Attitydanalysuppgift

AnalyzeTextTaskResultsKind

Den typ av svarsobjekt som returneras av uppgiften analyze-text.

Name	Typ	Description
EntityLinkingResults	string	Entitetslänkningsresultat
EntityRecognitionResults	string	Entitetsigenkänningsresultat
KeyPhraseExtractionResults	string	Resultat av extrahering av nyckelfraser
LanguageDetectionResults	string	Språkidentifieringsresultat
PiiEntityRecognitionResults	string	PII-entitetsigenkänningsresultat
SentimentAnalysisResults	string	Resultat av attitydanalys

DetectedLanguage

Innehåller information om det identifierade språket för texten.

Name	Typ	Description
confidenceScore	number	En konfidenspoäng mellan 0 och 1. Poäng nära 1 anger 100 % säkerhet om att det identifierade språket är sant.
iso6391Name	string	En tvåbokstavsrepresentation av det identifierade språket enligt ISO 639-1-standarden (t.ex. en, fr).
name	string	Långt namn på ett identifierat språk (t.ex. engelska, franska).

DocumentError

Innehåller information om fel som påträffas under en jobbkörning.

Name	Typ	Description
error	Error	Ett fel påträffades.
id	string	ID för indatadokumentet.

DocumentSentimentValue

Förutsagd attityd för dokument (negativ, neutral, positiv eller blandad).

Name	Typ	Description
mixed	string	Blandat uttryck
negative	string	Negativ instruktion
neutral	string	Neutralt uttryck
positive	string	Positiv instruktion

DocumentStatistics

om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.

Name	Typ	Description
charactersCount	integer	Antal textelement som identifieras i dokumentet.
transactionsCount	integer	Antal transaktioner för dokumentet.

DocumentWarning

Innehåller varningsobjektet med varningar som påträffas för det bearbetade dokumentet.

Name	Typ	Description
code	WarningCodeValue	Varningskod.
message	string	Varningsmeddelande.
targetRef	string	En JSON-pekarreferens som anger målobjektet.

EntitiesDocumentResult

Innehåller resultatet av entitetsigenkänningsaktiviteten för dokumentet.

Name	Typ	Description
entities	Entity[]	Identifierade entiteter i dokumentet.
id	string	Unikt, icke-tomt dokument-ID.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

EntitiesResult

Innehåller resultatet av entitetsigenkänningsaktiviteten.

Name	Typ	Description
documents	EntitiesDocumentResult[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

EntitiesTaskParameters

Parametrar som stöds för en entitetsigenkänningsaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
stringIndexType	StringIndexType	TextElements_v8	(Valfritt) parameter för att ange strängindextypen som används för att tolka strängförskjutningar. Standardvärdet är TextElements (Graphemes).

EntitiesTaskResult

Innehåller entitetsaktiviteten

Name	Typ	Description
kind	string: EntityRecognitionResults	Typ av aktivitetsresultat.
results	EntitiesResult	Resultat för entitetsigenkänning.

Entity

Definierar det identifierade entitetsobjektet som innehåller entitetskategorin och entitetstexten som identifieras osv.

Name	Typ	Description
category	string	Entitetstyp.
confidenceScore	number	Konfidenspoäng mellan 0 och 1 av den extraherade entiteten.
length	integer	Entitetstextens längd. Användningen av olika "stringIndexType"-värden kan påverka längden som returneras.
offset	integer	Startposition för entitetstexten. Användning av olika "stringIndexType"-värden kan påverka den returnerade förskjutningen.
subcategory	string	(Valfritt) Entitetsundertyp.
text	string	Entitetstext som visas i begäran.

EntityLinkingResult

Resultat av entitetslänkning.

Name	Typ	Description
documents	LinkedEntitiesDocumentResult[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

EntityLinkingTaskParameters

Parametrar som stöds för en entitetslänkningsaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
stringIndexType	StringIndexType	TextElements_v8	Valfri parameter för att ange strängindextypen som används för att tolka strängförskjutningar. Standardvärdet är TextElements (Graphemes).

EntityLinkingTaskResult

Innehåller analystexten Entitetslänkningsaktivitetsresultat.

Name	Typ	Description
kind	string: EntityLinkingResults	Typ av aktivitetsresultat.
results	EntityLinkingResult	Resultat av entitetslänkning.

Error

Felsvarsobjektet returnerades när tjänsten påträffar vissa fel under bearbetningen av begäran.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

Name	Typ	Description
AzureCognitiveSearchIndexLimitReached	string	fel Azure Cognitive Search indexgränsen har nåtts
AzureCognitiveSearchIndexNotFound	string	fel Azure Cognitive Search index hittades inte
AzureCognitiveSearchNotFound	string	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	string	Azure Cognitive Search begränsningsfel
Conflict	string	Konfliktfel
Forbidden	string	Fel om förbjuden åtkomst
InternalServerError	string	Internt serverfel
InvalidArgument	string	Ogiltigt argumentfel
InvalidRequest	string	Ogiltigt begärandefel
NotFound	string	Det gick inte att hitta felet
OperationNotFound	string	Det gick inte att hitta åtgärden
ProjectNotFound	string	Det gick inte att hitta projektet
QuotaExceeded	string	Fel om överskriden kvot
ServiceUnavailable	string	Fel om att tjänsten inte är tillgänglig
Timeout	string	Timeout-fel
TooManyRequests	string	Fel om för många begäranden
Unauthorized	string	Fel om obehörig åtkomst
Warning	string	Varningsfel

ErrorResponse

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Felkod som kan läsas av människor.

Name	Typ	Description
AzureCognitiveSearchNotFound	string	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	string	Azure Cognitive Search begränsningsfel
EmptyRequest	string	Fel vid tom begäran
ExtractionFailure	string	Fel vid extraheringsfel
InvalidCountryHint	string	Ogiltigt landstipsfel
InvalidDocument	string	Ogiltigt dokumentfel
InvalidDocumentBatch	string	Ogiltigt dokumentbatchfel
InvalidParameterValue	string	Ogiltigt parametervärdefel
InvalidRequest	string	Ogiltigt begärandefel
InvalidRequestBodyFormat	string	Ogiltigt fel i brödtextformat för begäran
KnowledgeBaseNotFound	string	Det gick inte att hitta kunskapsbasen
MissingInputDocuments	string	Fel i indatadokument saknas
ModelVersionIncorrect	string	Fel i modellversion
UnsupportedLanguageCode	string	Fel med språkkod som inte stöds

InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

KeyPhraseResult

Innehåller KeyPhraseResult.

Name	Typ	Description
documents	KeyPhrasesDocumentResult[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

KeyPhrasesDocumentResult

Innehåller resultatet av extrahering av nyckelfraser för ett dokument.

Name	Typ	Description
id	string	Unikt, icke-tomt dokument-ID.
keyPhrases	string[]	En lista över representativa ord eller fraser. Antalet nyckelfraser som returneras är proportionellt mot antalet ord i indatadokumentet.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

KeyPhraseTaskParameters

Parametrar som stöds för en nyckelfrasextraheringsaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion

KeyPhraseTaskResult

Innehåller resultatet av åtgärden Analysera text KeyPhraseExtraction.

Name	Typ	Description
kind	string: KeyPhraseExtractionResults	Typ av aktivitetsresultat.
results	KeyPhraseResult	Listan över resultat för extrahering av nyckelfraser

LanguageDetectionAnalysisInput

Innehåller indata för språkidentifieringsdokumentanalys.

Name	Typ	Description
documents	LanguageInput[]	Lista över dokument som ska analyseras.

LanguageDetectionDocumentResult

Innehåller språkidentifiering för ett dokument.

Name	Typ	Description
detectedLanguage	DetectedLanguage	Identifierat språk.
id	string	Unikt, icke-tomt dokument-ID.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

LanguageDetectionResult

Innehåller språkidentifieringsresultatet för begäran.

Name	Typ	Description
documents	LanguageDetectionDocumentResult[]	Uppräkning av språkidentifieringsresultat för varje indatadokument.
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

LanguageDetectionTaskParameters

Parametrar som stöds för en språkidentifieringsaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion

LanguageDetectionTaskResult

Innehåller resultatet av språkidentifieringsaktiviteten för begäran.

Name	Typ	Description
kind	string: LanguageDetectionResults	Typ av aktivitetsresultat.
results	LanguageDetectionResult	Innehåller språkidentifieringsresultatet.

LanguageInput

Innehåller indata för språkidentifiering.

Name	Typ	Description
countryHint	string	Landtipset för att hjälpa till med språkidentifiering av texten.
id	string	En unik, icke-tom dokumentidentifierare.
text	string	Den indatatext som ska bearbetas.

LinkedEntitiesDocumentResult

Entitet som länkar dokumentresultat.

Name	Typ	Description
entities	LinkedEntity[]	Identifierade välkända entiteter i dokumentet.
id	string	Unikt, icke-tomt dokument-ID.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

LinkedEntity

LinkedEntity-objektet som innehåller den identifierade entiteten med associerade källor/länkar.

Name	Typ	Description
bingId	string	Unik identifierare för den identifierade entiteten i API:et för entitetssökning i Bing.
dataSource	string	Datakälla som används för att extrahera entitetslänkning, till exempel Wiki/Bing osv.
id	string	Unik identifierare för den identifierade entiteten från datakällan.
language	string	Språk som används i datakällan.
matches	Match[]	Lista över instanser som den här entiteten visas i texten.
name	string	Entitetslänkning av formellt namn.
url	string	URL för entitetens sida från datakällan.

Match

Match-objektet som innehåller den identifierade entitetstexten med förskjutningen och längden.

Name	Typ	Description
confidenceScore	number	Om ett välkänt objekt identifieras returneras ett decimaltal som anger konfidensnivån mellan 0 och 1.
length	integer	Längden för entitetens matchningstext.
offset	integer	Startposition för entitetens matchningstext.
text	string	Entitetstext som visas i begäran.

MultiLanguageAnalysisInput

Insamling av indatadokument som ska analyseras av tjänsten.

Name	Typ	Description
documents	MultiLanguageInput[]	De indatadokument som ska analyseras.

MultiLanguageInput

Innehåller ett indatadokument som ska analyseras av tjänsten.

Name	Typ	Description
id	string	En unik, icke-tom dokumentidentifierare.
language	string	(Valfritt) Det här är 2-bokstaven ISO 639-1-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om det inte anges använder du "en" för engelska som standard. (Följande gäller endast för förhandsversionen 2023-04-15 och senare) För Automatisk språkidentifiering använder du "auto". Om det inte anges använder du "en" för engelska som standard.
text	string	Den indatatext som ska bearbetas.

PiiCategory

(Valfritt) beskriver PII-kategorierna som ska returneras

Name	Typ	Description
ABARoutingNumber	string	ABA-routningsnummer
ARNationalIdentityNumber	string	Nationellt AR-identitetsnummer
ATIdentityCard	string	AT Identity Card
ATTaxIdentificationNumber	string	AT Skatteidentifieringsnummer
ATValueAddedTaxNumber	string	AT Value Added Tax Number
AUBankAccountNumber	string	AT Identity Card
AUBusinessNumber	string	AU Business Number
AUCompanyNumber	string	AU-företagsnummer
AUDriversLicenseNumber	string	AU-körkortsnummer
AUMedicalAccountNumber	string	AU Medical Account Number
AUPassportNumber	string	AU Passport-nummer
AUTaxFileNumber	string	AU-skattefilnummer
Address	string	Adress
Age	string	Ålder
All	string	Alla PII-kategorier.
AzureDocumentDBAuthKey	string	Azure Document DB-autentiseringsnyckel
AzureIAASDatabaseConnectionAndSQLString	string	Azure Iaas-databasanslutning och SQL-sträng
AzureIoTConnectionString	string	Azure IoT-anslutningssträng
AzurePublishSettingPassword	string	Lösenord för Azure-publiceringsinställning
AzureRedisCacheString	string	Azure Redis Cache String
AzureSAS	string	Azure SAS
AzureServiceBusString	string	Azure Service Bus sträng
AzureStorageAccountGeneric	string	Allmänt Azure Storage-konto
AzureStorageAccountKey	string	Azure Storage-kontonyckel
BENationalNumber	string	NATIONELLT BE-nummer
BENationalNumberV2	string	BE National Number V2
BEValueAddedTaxNumber	string	BE-momsnummer
BGUniformCivilNumber	string	Civilnummer för BG-uniform
BRCPFNumber	string	BR CPF-nummer
BRLegalEntityNumber	string	BR-nummer för juridisk person
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	CA-bankkontonummer
CADriversLicenseNumber	string	CA-körkortsnummer
CAHealthServiceNumber	string	CA-hälsotjänstnummer
CAPassportNumber	string	CA Passport-nummer
CAPersonalHealthIdentification	string	Ca Personlig hälsoidentifiering
CASocialInsuranceNumber	string	CA Socialförsäkringsnummer
CHSocialSecurityNumber	string	CH Socialförsäkringsnummer
CLIdentityCardNumber	string	CL-identitetskortnummer
CNResidentIdentityCardNumber	string	CN Resident Identity Card-nummer
CYIdentityCard	string	CY-identitetskort
CYTaxIdentificationNumber	string	CY-skatteidentifieringsnummer
CZPersonalIdentityNumber	string	Personnummer för CZ
CZPersonalIdentityV2	string	CZ Personlig identitet V2
CreditCardNumber	string	Kreditkortsnummer
DEDriversLicenseNumber	string	DE-körkortsnummer
DEIdentityCardNumber	string	DE-identitetskortnummer
DEPassportNumber	string	DE Passport-nummer
DETaxIdentificationNumber	string	DE-skatteidentifieringsnummer
DEValueAddedNumber	string	DE-värde tillagt tal
DKPersonalIdentificationNumber	string	Personidentifieringsnummer för DK
DKPersonalIdentificationV2	string	DK Personlig identifiering V2
Date	string	Date
Default	string	Standard-PII-kategorier för språket.
DrugEnforcementAgencyNumber	string	Nummer på drug enforcement agency
EEPersonalIdentificationCode	string	EE-kod för personlig identifiering
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	ES Socialförsäkringsnummer
ESTaxIdentificationNumber	string	ES Skatteidentifieringsnummer
EUDebitCardNumber	string	EU-betalkortsnummer
EUDriversLicenseNumber	string	EU-körkortsnummer
EUGPSCoordinates	string	EU GPS-koordinater
EUNationalIdentificationNumber	string	NATIONELLT ID-nummer för EU
EUPassportNumber	string	EU-passnummer
EUSocialSecurityNumber	string	EU:s personnummer
EUTaxIdentificationNumber	string	EU-skatteidentifieringsnummer
Email	string	E-post
FIEuropeanHealthNumber	string	FI European Health Number
FINationalID	string	FI-nationellt ID
FINationalIDV2	string	FI National ID V2
FIPassportNumber	string	FI-passnummer
FRDriversLicenseNumber	string	FR-körkortsnummer
FRHealthInsuranceNumber	string	FR Sjukförsäkringsnummer
FRNationalID	string	NATIONELLT ID FÖR FR
FRPassportNumber	string	FR Passport-nummer
FRSocialSecurityNumber	string	FR Socialförsäkringsnummer
FRTaxIdentificationNumber	string	FR Skatteidentifieringsnummer
FRValueAddedTaxNumber	string	Fr Momsnummer
GRNationalIDCard	string	GR Nationellt ID-kort
GRNationalIDV2	string	GR Nationellt ID V2
GRTaxIdentificationNumber	string	GR-skatteidentifieringsnummer
HKIdentityCardNumber	string	HK-identitetskortnummer
HRIdentityCardNumber	string	HR-identitetskortnummer
HRNationalIDNumber	string	HR Nationellt ID-nummer
HRPersonalIdentificationNumber	string	Personalidentifieringsnummer för HR
HRPersonalIdentificationOIBNumberV2	string	HR-personidentifiering OIB-nummer V2
HUPersonalIdentificationNumber	string	PERSONLIGT ID-nummer för HU
HUTaxIdentificationNumber	string	HU-skatteidentifieringsnummer
HUValueAddedNumber	string	HU-värde tillagt tal
IDIdentityCardNumber	string	ID-identitetskortnummer
IEPersonalPublicServiceNumber	string	IE Personligt public service-nummer
IEPersonalPublicServiceNumberV2	string	IE Personligt public service-nummer V2
ILBankAccountNumber	string	IL-bankkontonummer
ILNationalID	string	IL National ID
INPermanentAccount	string	I permanent konto
INUniqueIdentificationNumber	string	I unikt identifieringsnummer
IPAddress	string	IP-adress
ITDriversLicenseNumber	string	IT-körkortsnummer
ITFiscalCode	string	IT-räkenskapskod
ITValueAddedTaxNumber	string	Momsnummer för IT-mervärde
InternationalBankingAccountNumber	string	International Banking Account Number
JPBankAccountNumber	string	JP-bankkontonummer
JPDriversLicenseNumber	string	JP-körkortsnummer
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	JP Passport-nummer
JPResidenceCardNumber	string	JP Residence-kortnummer
JPResidentRegistrationNumber	string	JP Resident Registration Number
JPSocialInsuranceNumber	string	JP Socialförsäkringsnummer
KRResidentRegistrationNumber	string	Registreringsnummer för KR Resident
LTPersonalCode	string	LT-personlig kod
LUNationalIdentificationNumberNatural	string	LU Nationellt ID-nummer Naturligt
LUNationalIdentificationNumberNonNatural	string	LU Nationellt ID-nummer icke naturligt
LVPersonalCode	string	Personlig LV-kod
MTIdentityCardNumber	string	MT-identitetskortnummer
MTTaxIDNumber	string	MT-skatte-ID-nummer
MYIdentityCardNumber	string	MITT identitetskortnummer
NLCitizensServiceNumber	string	Servicenummer för NL-medborgare
NLCitizensServiceNumberV2	string	NL Citizens Service Nummer V2
NLTaxIdentificationNumber	string	NL Skatteidentifieringsnummer
NLValueAddedTaxNumber	string	Nl-momsnummer
NOIdentityNumber	string	INGET identitetsnummer
NZBankAccountNumber	string	NZ Bankkontonummer
NZDriversLicenseNumber	string	NZ-körkortsnummer
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	NZ Ministry Of Health Number
NZSocialWelfareNumber	string	NZ Social Welfare Number
Organization	string	Organisation
PHUnifiedMultiPurposeIDNumber	string	PH Unified Multi Purpose ID Number
PLIdentityCard	string	PL-identitetskort
PLNationalID	string	PL Nationellt ID
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	PL Passport-nummer
PLREGONNumber	string	PL REGON-nummer
PLTaxIdentificationNumber	string	Pl Skatteidentifieringsnummer
PTCitizenCardNumber	string	PT-personkortsnummer
PTCitizenCardNumberV2	string	PT Citizen Card Number V2
PTTaxIdentificationNumber	string	PT Skatteidentifieringsnummer
Person	string	Person
PhoneNumber	string	Telefonnummer
ROPersonalNumericalCode	string	RO Personal Numerical Code
RUPassportNumberDomestic	string	RU-passnummer Inrikes
RUPassportNumberInternational	string	RU Passport Number International
SANationalID	string	NATIONELLT ID för SA
SENationalID	string	SE Nationellt ID
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	SE Passport-nummer
SETaxIdentificationNumber	string	SE Skatteidentifieringsnummer
SGNationalRegistrationIdentityCardNumber	string	SG National Registration Identity Card-nummer
SITaxIdentificationNumber	string	SI-skatteidentifieringsnummer
SIUniqueMasterCitizenNumber	string	SI Unique Master Citizen Number
SKPersonalNumber	string	PERSONLIGT SK-nummer
SQLServerConnectionString	string	SQL Server anslutningssträng
SWIFTCode	string	SWIFT-kod
THPopulationIdentificationCode	string	Identifieringskod för TH-population
TRNationalIdentificationNumber	string	Nationellt ID-nummer för TR
TWNationalID	string	TW-nationellt ID
TWPassportNumber	string	TW-passnummer
TWResidentCertificate	string	TW Resident Certificate
UAPassportNumberDomestic	string	UA Passport-nummer Inrikes
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	UK Driver's License Number
UKElectoralRollNumber	string	Röstlängdsnummer i Storbritannien
UKNationalHealthNumber	string	UK National Health Number
UKNationalInsuranceNumber	string	UK National Insurance Number
UKUniqueTaxpayerNumber	string	UK Unique Taxpayer Number
URL	string	URL
USBankAccountNumber	string	Amerikanskt bankkontonummer
USDriversLicenseNumber	string	Amerikanskt körkortsnummer
USIndividualTaxpayerIdentification	string	Identifiering av enskilda skattebetalare i USA
USSocialSecurityNumber	string	Amerikanskt personnummer
USUKPassportNumber	string	US UK Passport-nummer
ZAIdentificationNumber	string	ZA-identifieringsnummer

PiiDomain

Domän för PII-uppgift

Name	Typ	Description
none	string	Anger att ingen domän har angetts.
phi	string	Anger att entiteter i domänen personlig hälsoinformation ska redigeras.

PiiEntitiesDocumentResult

Innehåller PII-resultaten.

Name	Typ	Description
entities	Entity[]	Identifierade entiteter i dokumentet.
id	string	Unikt, icke-tomt dokument-ID.
redactedText	string	Returnerar redigerad text.
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

PiiResult

Innehåller PiiResult.

Name	Typ	Description
documents	PiiEntitiesDocumentResult[]	Svar efter dokument
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

PiiTaskParameters

Parametrar som stöds för en PII-entitetsigenkänningsaktivitet.

Name	Typ	Standardvärde	Description
domain	PiiDomain	none	Domän för PII-uppgift
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
piiCategories	PiiCategory[]		Uppräkning av PII-kategorier som ska returneras i svaret.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType som ska användas för analys.

PiiTaskResult

Innehåller LRO-uppgiften analysera text PIIEntityRecognition.

Name	Typ	Description
kind	string: PiiEntityRecognitionResults	Typ av aktivitetsresultat.
results	PiiResult	Listan över pii-resultat

RequestStatistics

om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

Name	Typ	Description
documentsCount	integer	Antal dokument som skickats i begäran.
erroneousDocumentsCount	integer	Antal ogiltiga dokument. Detta inkluderar tomma dokument med överstorleksgräns eller språk som inte stöds.
transactionsCount	integer	Antal transaktioner för begäran.
validDocumentsCount	integer	Antal giltiga dokument. Detta utesluter tomma dokument, överstorleksgränser eller språk som inte stöds.

SentenceAssessment

Representerar en meningsutvärdering och de utvärderingar eller målobjekt som är relaterade till den.

Name	Typ	Description
confidenceScores	TargetConfidenceScoreLabel	Representerar förtroendepoängen för alla sentimentklasser: positiva och negativa.
isNegated	boolean	Indikatorn som representerar om utvärderingen negeras.
length	integer	Målets längd.
offset	integer	Målförskjutningen från början av meningen.
sentiment	TokenSentimentValue	Meningens sentiment.
text	string	Måltexten har identifierats.

SentenceSentiment

Ett dokuments meningssentiment.

Name	Typ	Description
assessments	SentenceAssessment[]	Matrisen med utvärderingar för meningen.
confidenceScores	SentimentConfidenceScores	Sentimentkonfidenspoängen mellan 0 och 1 för meningen för alla klasser.
length	integer	Målets längd.
offset	integer	Målförskjutningen från början av meningen.
sentiment	SentenceSentimentValue	Den förutsagda attityden för meningen.
targets	SentenceTarget[]	Matrisen med meningsmål för meningen.
text	string	Meningstexten.

SentenceSentimentValue

Den förutsagda attityden för meningen.

Name	Typ	Description
negative	string	Negativ attityd
neutral	string	Neutral sentiment
positive	string	Positiv attityd

SentenceTarget

Representerar ett meningsmål och de utvärderingar eller målobjekt som är relaterade till det.

Name	Typ	Description
confidenceScores	TargetConfidenceScoreLabel	Representerar förtroendepoängen för alla sentimentklasser: positiva och negativa.
length	integer	Målets längd.
offset	integer	Målförskjutningen från början av meningen.
relations	TargetRelation[]	Matrisen med antingen utvärderings- eller målobjekt som är relaterade till målet.
sentiment	TokenSentimentValue	Meningens sentiment.
text	string	Måltexten har identifierats.

SentimentAnalysisTaskParameters

Parametrar som stöds för en attitydanalysaktivitet.

Name	Typ	Standardvärde	Description
loggingOptOut	boolean	False	avregistrera loggning
modelVersion	string	latest	modellversion
opinionMining	boolean	False	Om du vill använda åsiktsutvinning i begäran eller inte.
stringIndexType	StringIndexType	TextElements_v8	Anger den metod som används för att tolka strängförskjutningar.

SentimentConfidenceScores

Representerar förtroendepoängen mellan 0 och 1 i alla sentimentklasser: positiva, neutrala, negativa.

Name	Typ	Description
negative	number	Förtroendepoäng för negativ attityd
neutral	number	Förtroendepoäng för neutral sentiment
positive	number	Förtroendepoäng för positiv attityd

SentimentDocumentResult

Ett objekt som representerar de färdiga sentimentanalysresultaten för varje dokument.

Name	Typ	Description
confidenceScores	SentimentConfidenceScores	Sentimentkonfidenspoängen mellan 0 och 1 för meningen för alla klasser.
id	string	Unikt, icke-tomt dokument-ID.
sentences	SentenceSentiment[]	Dokumentets meningar attityd.
sentiment	DocumentSentimentValue	Förutsagd attityd för dokument (negativ, neutral, positiv eller blandad).
statistics	DocumentStatistics	om showStats=true angavs i begäran innehåller det här fältet information om dokumentets nyttolast.
warnings	DocumentWarning[]	Varningar påträffades när dokumentet bearbetas.

SentimentResponse

Sentimentanalysresultat för indatadokumenten.

Name	Typ	Description
documents	SentimentDocumentResult[]	Sentimentanalysresultaten för varje dokument i indata.
errors	DocumentError[]	Fel efter dokument-ID.
modelVersion	string	Det här fältet anger vilken modell som används för bedömning.
statistics	RequestStatistics	om showStats=true angavs i begäran innehåller det här fältet information om nyttolasten för begäran.

SentimentTaskResult

Innehåller analystexten SentimentAnalysis LRO-uppgiftsresultat.

Name	Typ	Description
kind	string: SentimentAnalysisResults	Typ av aktivitetsresultat.
results	SentimentResponse	Resultatet av attitydanalysen

StringIndexType

Strängindextyp

Name	Typ	Description
TextElements_v8	string	Returnerade förskjutnings- och längdvärden motsvarar TextElements (Graphemes- och Grapheme-kluster) som bekräftar till Unicode 8.0.0-standarden. Använd det här alternativet om ditt program är skrivet i .Net Framework eller .Net Core och du kommer att använda StringInfo.
UnicodeCodePoint	string	Returnerade förskjutnings- och längdvärden motsvarar Unicode-kodpunkter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Python.
Utf16CodeUnit	string	Returnerade förskjutnings- och längdvärden motsvarar UTF-16-kodenheter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Java, JavaScript.

TargetConfidenceScoreLabel

Representerar förtroendepoängen för alla sentimentklasser: positiva och negativa.

Name	Typ	Description
negative	number	Förtroendepoäng för negativ attityd
positive	number	Förtroendepoäng för positiv attityd

TargetRelation

Representerar relationen mellan utvärderingar och/eller mål.

Name	Typ	Description
ref	string	JSON-pekaren som anger det länkade objektet.
relationType	TargetRelationType	Den typ som är relaterad till målet.

TargetRelationType

Den typ som är relaterad till målet.

Name	Typ	Description
assessment	string	Utvärderingsrelation.
target	string	Målrelation.

TokenSentimentValue

Den förutsagda attityden för meningen.

Name	Typ	Description
mixed	string	Blandade sentiment
negative	string	Negativ attityd
positive	string	Positiv attityd

WarningCodeValue

Definierar listan över varningskoderna.

Name	Typ	Description
DocumentTruncated	string	Varning om trunkerat dokument
LongWordsInDocument	string	Långa ord i dokumentvarning

Dela via

Text Analysis Runtime - Analyze Text

URI-parametrar

Begärandehuvud

Begärandetext

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

SuccessfulEntityLinkingRequest

Sample Request

Sample Response

SuccessfulEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulKeyPhraseExtractionRequest

Sample Request

Sample Response

SuccessfulLanguageDetectionRequest

Sample Request

Sample Response

SuccessfulPiiEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulSentimentAnalysisRequest

Sample Request

Sample Response

Definitioner

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

AnalyzeTextTaskKind

AnalyzeTextTaskResultsKind

DetectedLanguage

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResult

EntitiesResult

EntitiesTaskParameters

EntitiesTaskResult

Entity

EntityLinkingResult

EntityLinkingTaskParameters

EntityLinkingTaskResult

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

KeyPhraseResult

KeyPhrasesDocumentResult

KeyPhraseTaskParameters

KeyPhraseTaskResult

LanguageDetectionAnalysisInput

LanguageDetectionDocumentResult

LanguageDetectionResult

LanguageDetectionTaskParameters

LanguageDetectionTaskResult

LanguageInput

LinkedEntitiesDocumentResult

LinkedEntity

Match

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategory

PiiDomain

PiiEntitiesDocumentResult

PiiResult

PiiTaskParameters