Compartir a través de


Text Analysis Runtime - Analyze Text

Solicitar análisis de texto sobre una colección de documentos.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
Endpoint
path True

string

Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).

api-version
query True

string

Versión de la API que se va a usar para esta operación.

showStats
query

boolean

(Opcional) si se establece en true, la respuesta contendrá estadísticas de nivel de documento y solicitud.

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre Description
AnalyzeTextEntityLinkingInput

Contiene la entrada de vinculación de entidad de análisis de texto.

AnalyzeTextEntityRecognitionInput

El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.

AnalyzeTextKeyPhraseExtractionInput

Contiene la entrada de la tarea Analizar texto KeyPhraseExtraction.

AnalyzeTextLanguageDetectionInput

Contiene la entrada de la tarea de análisis de documentos de detección de idioma.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.

AnalyzeTextSentimentAnalysisInput

Contiene la entrada de la tarea Analyze Text SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Contiene la entrada de vinculación de entidad de análisis de texto.

Nombre Requerido Tipo Description
kind True string:

EntityLinking

Tipo de tarea que se va a realizar.

analysisInput

MultiLanguageAnalysisInput

Contiene la entrada de análisis que va a controlar el servicio.

parameters

EntityLinkingTaskParameters

Parámetros de tarea.

AnalyzeTextEntityRecognitionInput

El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.

Nombre Requerido Tipo Description
kind True string:

EntityRecognition

Tipo de tarea que se va a realizar.

analysisInput

MultiLanguageAnalysisInput

Entrada que se va a analizar.

parameters

EntitiesTaskParameters

Parámetros de tarea.

AnalyzeTextKeyPhraseExtractionInput

Contiene la entrada de la tarea Analizar texto KeyPhraseExtraction.

Nombre Requerido Tipo Description
kind True string:

KeyPhraseExtraction

Tipo de tarea que se va a realizar.

analysisInput

MultiLanguageAnalysisInput

Contiene los documentos de entrada.

parameters

KeyPhraseTaskParameters

Parámetros de la tarea de extracción de frases clave.

AnalyzeTextLanguageDetectionInput

Contiene la entrada de la tarea de análisis de documentos de detección de idioma.

Nombre Requerido Tipo Description
kind True string:

LanguageDetection

Tipo de tarea que se va a realizar.

analysisInput

LanguageDetectionAnalysisInput

Documentos que se van a analizar.

parameters

LanguageDetectionTaskParameters

parámetros de tarea.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.

Nombre Requerido Tipo Description
kind True string:

PiiEntityRecognition

Tipo de tarea que se va a realizar.

analysisInput

MultiLanguageAnalysisInput

Contiene los documentos de entrada.

parameters

PiiTaskParameters

Parámetros de la tarea Pii.

AnalyzeTextSentimentAnalysisInput

Contiene la entrada de la tarea Analyze Text SentimentAnalysis.

Nombre Requerido Tipo Description
kind True string:

SentimentAnalysis

Tipo de tarea que se va a realizar.

analysisInput

MultiLanguageAnalysisInput

Contiene los documentos de entrada.

parameters

SentimentAnalysisTaskParameters

Parámetros de la tarea Análisis de sentimiento.

Respuestas

Nombre Tipo Description
200 OK AnalyzeTextTaskResult:

La solicitud se ha realizado correctamente.

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre Description
https://cognitiveservices.azure.com/.default

Ejemplos

SuccessfulEntityLinkingRequest
SuccessfulEntityRecognitionExclusionRequest
SuccessfulEntityRecognitionInclusionRequest
SuccessfulEntityRecognitionInferenceOptionsRequest
SuccessfulEntityRecognitionOverlapPolicy
SuccessfulEntityRecognitionRequest
SuccessfulKeyPhraseExtractionRequest
SuccessfulLanguageDetectionRequest
SuccessfulPiiEntityRecognitionRequest
SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Solicitud de ejemplo

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

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

Respuesta de muestra

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

SuccessfulEntityRecognitionExclusionRequest

Solicitud de ejemplo

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Respuesta de muestra

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Solicitud de ejemplo

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Respuesta de muestra

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Solicitud de ejemplo

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Respuesta de muestra

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Solicitud de ejemplo

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Respuesta de muestra

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Solicitud de ejemplo

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Respuesta de muestra

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Solicitud de ejemplo

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

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

Respuesta de muestra

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

Solicitud de ejemplo

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

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

Respuesta de muestra

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

SuccessfulPiiEntityRecognitionRequest

Solicitud de ejemplo

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

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

Respuesta de muestra

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

Solicitud de ejemplo

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

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

Respuesta de muestra

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

Definiciones

Nombre Description
AgeMetadata

Representa el modelo de metadatos de entidad Age.

AgeUnit

Unidad de medición de edad

AllowOverlapEntityPolicyType

Representa la directiva de superposición de permitidos. No se aplicará ninguna lógica posterior al procesamiento para las entidades. Lo que prediga el modelo es lo que se devolverá al usuario. Esto permite al usuario obtener una vista completa de los posibles valores de cada modelo y aplicar su propia lógica personalizada en la selección de entidades.

AnalyzeTextEntityLinkingInput

Contiene la entrada de vinculación de entidad de análisis de texto.

AnalyzeTextEntityRecognitionInput

El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.

AnalyzeTextKeyPhraseExtractionInput

Contiene la entrada de la tarea Analizar texto KeyPhraseExtraction.

AnalyzeTextLanguageDetectionInput

Contiene la entrada de la tarea de análisis de documentos de detección de idioma.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.

AnalyzeTextSentimentAnalysisInput

Contiene la entrada de la tarea Analyze Text SentimentAnalysis.

AnalyzeTextTaskKind

Tipo de las tareas de análisis y texto admitidas.

AnalyzeTextTaskResultsKind

El tipo del objeto de respuesta devuelto por la tarea analyze-text.

AreaMetadata

Representa el modelo de metadatos de entidad de área.

AreaUnit

Unidad de medida de área.

CurrencyMetadata

Representa el modelo de metadatos de entidad Currency ).

DateMetadata

Metadatos para instancias de entidad de fecha.

DateTimeMetadata

Metadatos para instancias de entidad datetime.

DateValue

Representa el valor de fecha.

DetectedLanguage

Contiene los detalles del idioma detectado para el texto.

DocumentError

Contiene detalles de los errores detectados durante la ejecución de un trabajo.

DocumentSentimentValue

Opinión prevista para el documento (Negativo, Neutro, Positivo o Mixto).

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

DocumentWarning

Contiene el objeto warnings con advertencias detectadas para el documento procesado.

EntitiesDocumentResultWithMetadata

Los documentos de entidad dan como resultado metadatos.

EntitiesResult

Contiene el resultado de la tarea de reconocimiento de entidades.

EntitiesTaskParameters

Parámetros admitidos para una tarea reconocimiento de entidades.

EntitiesTaskResult

Contiene la tarea de entidad

Entity

Define el objeto de entidad detectado que contiene la categoría de entidad y el texto de entidad detectados, etc.

EntityCategory

Contiene todas las categorías de entidad detectadas por el reconocimiento de entidades.

EntityInferenceOptions

Clase que alberga las opciones de inferencia permitidas para el reconocimiento de entidades con nombre.

EntityLinkingResult

Resultado de la vinculación de entidades.

EntityLinkingTaskParameters

Parámetros admitidos para una tarea Entity Linking.

EntityLinkingTaskResult

Contiene el resultado de la tarea analizar la vinculación de entidades.

EntityTag

Objeto de etiqueta de entidad que contiene el nombre de las etiquetas abd cualquier puntuación de confianza asociada. Las etiquetas de entidad se usan para expresar algunas similitudes o afinidad entre entidades.

EntityWithMetadata

Objeto de entidad con etiquetas y metadatos.

Error

El objeto de respuesta de error devuelto cuando el servicio encuentra algunos errores durante el procesamiento de la solicitud.

ErrorCode

Código de error legible para personas.

ErrorResponse

Respuesta de error.

InformationMetadata

Representa el modelo de metadatos de entidad de información (datos).

InformationUnit

Unidad de medición de información (datos).

InnerErrorCode

Código de error legible para personas.

InnerErrorModel

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

KeyPhraseResult

Contiene KeyPhraseResult.

KeyPhrasesDocumentResult

Contiene los resultados de extracción de frases clave de un documento.

KeyPhraseTaskParameters

Parámetros admitidos para una tarea extracción de frases clave.

KeyPhraseTaskResult

Contiene el resultado de la tarea Analizar texto KeyPhraseExtraction.

LanguageDetectionAnalysisInput

Contiene la entrada de análisis de documentos de detección de idioma.

LanguageDetectionDocumentResult

Contiene la detección de idioma de un documento.

LanguageDetectionResult

Contiene el resultado de detección de idioma para la solicitud.

LanguageDetectionTaskParameters

Parámetros admitidos para una tarea detección de idioma.

LanguageDetectionTaskResult

Contiene el resultado de la tarea de detección de idioma para la solicitud.

LanguageInput

Contiene la entrada de detección de idioma.

LengthMetadata

Representa el modelo de metadatos de entidad length.

LengthUnit

Unidad de medida de longitud.

LinkedEntitiesDocumentResult

Resultado del documento de vinculación de entidades.

LinkedEntity

Objeto LinkedEntity que contiene la entidad detectada con los orígenes o vínculos asociados.

Match

Objeto Match que contiene el texto de la entidad detectada con el desplazamiento y la longitud.

MatchLongestEntityPolicyType

Representa la directiva de superposición de coincidencia más larga. No se superponen entidades en la medida en que sea posible. 1. Si hay entidades superpuestas, se devolverá la más larga. 2. Si el conjunto de caracteres previsto para 2 o más entidades es exactamente el mismo, seleccione la entidad que tiene la puntuación de confianza más alta.3. Si las puntuaciones de entidad son idénticas, devuelva todas las entidades que siguen presentes después de aplicar las reglas anteriores. 3. Si hay superposición parcial (como en Hello Text Analytics), siga los pasos anteriores a partir de 1.

MetadataKind

Tipo de objeto Metadata de entidad.

MultiLanguageAnalysisInput

Colección de documentos de entrada que va a analizar el servicio.

MultiLanguageInput

Contiene un documento de entrada que el servicio va a analizar.

NumberKind

Tipo de la entidad numérica extraída.

NumberMetadata

Metadatos para instancias de entidad numéricas.

NumericRangeMetadata

representa los metadatos de intervalos numéricos.

OrdinalMetadata

Metadatos para instancias de entidad numéricas.

PiiCategory

(Opcional) describe las categorías de PII que se van a devolver.

PiiDomain

Dominio para la tarea PII

PiiEntitiesDocumentResult

Contiene los resultados de PII.

PiiResult

Contiene piiResult.

PiiTaskParameters

Parámetros admitidos para una tarea de reconocimiento de entidades de PII.

PiiTaskResult

Contiene la tarea LRO analizar texto PIIEntityRecognition.

RangeInclusivity

La inclusión de intervalo de esta propiedad.

RangeKind

Tipo de la entidad de intervalo de números.

RelativeTo

Punto de referencia que indica el número ordinal.

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

ScriptCode

Identifica el script del documento de entrada. Se asigna al código de script estándar ISO 15924.

ScriptKind

Identifica el script del documento de entrada. Se asigna al nombre formal estándar ISO 15924.

SentenceAssessment

Representa una evaluación de oraciones y las evaluaciones o los objetos de destino relacionados con ella.

SentenceSentiment

Opinión de frase de un documento.

SentenceSentimentValue

Opinión predicha para la frase.

SentenceTarget

Representa un destino de oración y las evaluaciones o los objetos de destino relacionados con él.

SentimentAnalysisTaskParameters

Parámetros admitidos para una tarea Análisis de sentimiento.

SentimentConfidenceScores

Representa las puntuaciones de confianza entre 0 y 1 en todas las clases de sentimiento: positivas, neutrales y negativas.

SentimentDocumentResult

Objeto que representa los resultados predefinidos del análisis de sentimiento de cada documento.

SentimentResponse

Resultados del análisis de sentimiento para los documentos de entrada.

SentimentTaskResult

Contiene el resultado de la tarea analizar SentimentAnalysis LRO.

SpeedMetadata

Representa el modelo de metadatos de entidad Speed.

SpeedUnit

Unidad de medida de velocidad

StringIndexType

Tipo de índice de cadena

TargetConfidenceScoreLabel

Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.

TargetRelation

Representa la relación entre evaluaciones o destinos.

TargetRelationType

Tipo relacionado con el destino.

TemperatureMetadata

Representa el modelo de metadatos de entidad de información.

TemperatureUnit

Unidad de medición de temperatura.

TemporalModifier

Un modificador opcional de una instancia de fecha y hora.

TemporalSetMetadata

Metadatos para instancias de entidad de conjunto temporal.

TemporalSpanMetadata

representa los metadatos de una fecha o intervalo de tiempo.

TemporalSpanValues

Objeto span temporal.

TimeMetadata

Metadatos para instancias de entidad de tiempo.

TokenSentimentValue

Opinión predicha para la frase.

VolumeMetadata

Representa el modelo de metadatos de entidad de volumen.

VolumeUnit

Unidad de volumen de medida

WarningCodeValue

Define la lista de códigos de advertencia.

WeightMetadata

Representa el modelo de metadatos de entidad Weight ).

WeightUnit

Unidad de medida de peso.

AgeMetadata

Representa el modelo de metadatos de entidad Age.

Nombre Tipo Description
metadataKind string:

AgeMetadata

Tipo de objeto Metadata de entidad.

unit

AgeUnit

Unidad de medida para la edad.

value

number

Valor numérico que indica el texto extraído.

AgeUnit

Unidad de medición de edad

Nombre Tipo Description
Day

string

Período de tiempo de un día

Month

string

Período de tiempo de un mes

Unspecified

string

Período de tiempo no especificado

Week

string

Período de tiempo de una semana

Year

string

Período de tiempo de un año

AllowOverlapEntityPolicyType

Representa la directiva de superposición de permitidos. No se aplicará ninguna lógica posterior al procesamiento para las entidades. Lo que prediga el modelo es lo que se devolverá al usuario. Esto permite al usuario obtener una vista completa de los posibles valores de cada modelo y aplicar su propia lógica personalizada en la selección de entidades.

Nombre Tipo Valor predeterminado Description
policyKind string:

allowOverlap

matchLongest

Tipo de objeto OverlapPolicy de entidad.

AnalyzeTextEntityLinkingInput

Contiene la entrada de vinculación de entidad de análisis de texto.

Nombre Tipo Description
analysisInput

MultiLanguageAnalysisInput

Contiene la entrada de análisis que va a controlar el servicio.

kind string:

EntityLinking

Tipo de tarea que se va a realizar.

parameters

EntityLinkingTaskParameters

Parámetros de tarea.

AnalyzeTextEntityRecognitionInput

El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.

Nombre Tipo Description
analysisInput

MultiLanguageAnalysisInput

Entrada que se va a analizar.

kind string:

EntityRecognition

Tipo de tarea que se va a realizar.

parameters

EntitiesTaskParameters

Parámetros de tarea.

AnalyzeTextKeyPhraseExtractionInput

Contiene la entrada de la tarea Analizar texto KeyPhraseExtraction.

Nombre Tipo Description
analysisInput

MultiLanguageAnalysisInput

Contiene los documentos de entrada.

kind string:

KeyPhraseExtraction

Tipo de tarea que se va a realizar.

parameters

KeyPhraseTaskParameters

Parámetros de la tarea de extracción de frases clave.

AnalyzeTextLanguageDetectionInput

Contiene la entrada de la tarea de análisis de documentos de detección de idioma.

Nombre Tipo Description
analysisInput

LanguageDetectionAnalysisInput

Documentos que se van a analizar.

kind string:

LanguageDetection

Tipo de tarea que se va a realizar.

parameters

LanguageDetectionTaskParameters

parámetros de tarea.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.

Nombre Tipo Description
analysisInput

MultiLanguageAnalysisInput

Contiene los documentos de entrada.

kind string:

PiiEntityRecognition

Tipo de tarea que se va a realizar.

parameters

PiiTaskParameters

Parámetros de la tarea Pii.

AnalyzeTextSentimentAnalysisInput

Contiene la entrada de la tarea Analyze Text SentimentAnalysis.

Nombre Tipo Description
analysisInput

MultiLanguageAnalysisInput

Contiene los documentos de entrada.

kind string:

SentimentAnalysis

Tipo de tarea que se va a realizar.

parameters

SentimentAnalysisTaskParameters

Parámetros de la tarea Análisis de sentimiento.

AnalyzeTextTaskKind

Tipo de las tareas de análisis y texto admitidas.

Nombre Tipo Description
EntityLinking

string

Tarea de vinculación de entidades

EntityRecognition

string

Tarea de reconocimiento de entidades

KeyPhraseExtraction

string

Tarea de extracción de frases clave

LanguageDetection

string

Tarea detección de idioma

PiiEntityRecognition

string

Tarea de reconocimiento de entidades PII

SentimentAnalysis

string

Tarea de análisis de sentimiento

AnalyzeTextTaskResultsKind

El tipo del objeto de respuesta devuelto por la tarea analyze-text.

Nombre Tipo Description
EntityLinkingResults

string

Resultados de vinculación de entidades

EntityRecognitionResults

string

Resultados del reconocimiento de entidades

KeyPhraseExtractionResults

string

Resultados de extracción de frases clave

LanguageDetectionResults

string

Resultados de detección de idioma

PiiEntityRecognitionResults

string

Resultados del reconocimiento de entidades PII

SentimentAnalysisResults

string

Resultados del análisis de sentimiento

AreaMetadata

Representa el modelo de metadatos de entidad de área.

Nombre Tipo Description
metadataKind string:

AreaMetadata

Tipo de objeto Metadata de entidad.

unit

AreaUnit

Unidad de medida para el área.

value

number

Valor numérico que indica el texto extraído.

AreaUnit

Unidad de medida de área.

Nombre Tipo Description
Acre

string

Unidad de área en acres

SquareCentimeter

string

Unidad de área en centímetros cuadrados

SquareDecameter

string

Unidad de área en descametros cuadrados

SquareDecimeter

string

Unidad de área en decimetros cuadrados

SquareFoot

string

Unidad de área en pies cuadrados

SquareHectometer

string

Unidad de área en hectómetros cuadrados

SquareInch

string

Unidad de área en pulgadas cuadradas

SquareKilometer

string

Unidad de área en kilómetros cuadrados

SquareMeter

string

Unidad de área en metros cuadrados

SquareMile

string

Unidad de área en millas cuadradas

SquareMillimeter

string

Unidad de área en milímetros cuadrados

SquareYard

string

Unidad de área en patios cuadrados

Unspecified

string

Unidad de área no especificada

CurrencyMetadata

Representa el modelo de metadatos de entidad Currency ).

Nombre Tipo Description
iso4217

string

El código alfabético basado en otro estándar ISO, ISO 3166, que enumera los códigos de los nombres de país. Las dos primeras letras del código de tres letras ISO 4217 son las mismas que el código del nombre del país y, siempre que sea posible, la tercera letra corresponde a la primera letra del nombre de moneda.

metadataKind string:

CurrencyMetadata

Tipo de objeto Metadata de entidad.

unit

string

Unidad de moneda.

value

number

Valor numérico que indica el texto extraído.

DateMetadata

Metadatos para instancias de entidad de fecha.

Nombre Tipo Description
dateValues

DateValue[]

Lista de valores de fecha.

metadataKind string:

DateMetadata

Tipo de objeto Metadata de entidad.

DateTimeMetadata

Metadatos para instancias de entidad datetime.

Nombre Tipo Description
dateValues

DateValue[]

Lista de valores de fecha.

metadataKind string:

DateTimeMetadata

Tipo de objeto Metadata de entidad.

DateValue

Representa el valor de fecha.

Nombre Tipo Description
modifier

TemporalModifier

Modificador para datetime para indicar el punto de referencia como antes, después, etc.

timex

string

Representación extendida de fecha y hora ISO 8601 como se describe en (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)

value

string

Tiempo real que indica el texto extraído.

DetectedLanguage

Contiene los detalles del idioma detectado para el texto.

Nombre Tipo Description
confidenceScore

number

Puntuación de confianza entre 0 y 1. Las puntuaciones cercanas a 1 indican 100% certeza de que el idioma identificado es true.

iso6391Name

string

Una representación de dos letras del idioma detectado según el estándar ISO 639-1 (por ejemplo, en, fr).

name

string

Nombre largo de un idioma detectado (por ejemplo, inglés, francés).

scriptIso15924Code

ScriptCode

Identifica el código de script del documento de entrada según el estándar ISO 15924.

scriptName

ScriptKind

Identifica el nombre del script del documento de entrada según el estándar ISO 15924.

DocumentError

Contiene detalles de los errores detectados durante la ejecución de un trabajo.

Nombre Tipo Description
error

Error

Error encontrado.

id

string

Identificador del documento de entrada.

DocumentSentimentValue

Opinión prevista para el documento (Negativo, Neutro, Positivo o Mixto).

Nombre Tipo Description
mixed

string

Instrucción mixta

negative

string

Instrucción Negativa

neutral

string

Instrucción neutral

positive

string

Instrucción positiva

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

Nombre Tipo Description
charactersCount

integer

Número de elementos de texto reconocidos en el documento.

transactionsCount

integer

Número de transacciones del documento.

DocumentWarning

Contiene el objeto warnings con advertencias detectadas para el documento procesado.

Nombre Tipo Description
code

WarningCodeValue

Código de advertencia.

message

string

Mensaje de advertencia.

targetRef

string

Referencia de puntero JSON que indica el objeto de destino.

EntitiesDocumentResultWithMetadata

Los documentos de entidad dan como resultado metadatos.

Nombre Tipo Description
entities

EntityWithMetadata[]

Entidades reconocidas en el documento.

id

string

Identificador de documento único y no vacío.

statistics

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

warnings

DocumentWarning[]

Advertencias detectadas al procesar el documento.

EntitiesResult

Contiene el resultado de la tarea de reconocimiento de entidades.

Nombre Tipo Description
documents

EntitiesDocumentResultWithMetadata[]

Respuesta por documento

errors

DocumentError[]

Errores por identificador de documento.

modelVersion

string

Este campo indica qué modelo se usa para la puntuación.

statistics

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

EntitiesTaskParameters

Parámetros admitidos para una tarea reconocimiento de entidades.

Nombre Tipo Valor predeterminado Description
exclusionList

EntityCategory[]

(Opcional) parámetro de solicitud que filtra las entidades que se incluyen excludeList. Cuando un usuario especifica una excludeList, no puede obtener una predicción devuelta con una entidad de esa lista. Aplicaremos inclusionList antes de exclusionList

inclusionList

EntityCategory[]

(Opcional) parámetro de solicitud que limita la salida a los tipos de entidad solicitados incluidos en esta lista. Aplicaremos inclusionList antes de exclusionList

inferenceOptions

EntityInferenceOptions

(Opcional) parámetro de solicitud que permite al usuario proporcionar la configuración para ejecutar la inferencia.

loggingOptOut

boolean

False

no participar en el registro

modelVersion

string

latest

versión del modelo

overlapPolicy BaseEntityOverlapPolicy:

(Opcional) describe el tipo de directiva de superposición que se va a aplicar a la salida del ner.

stringIndexType

StringIndexType

TextElements_v8

(Opcional) parámetro para proporcionar el tipo de índice de cadena usado para interpretar los desplazamientos de cadena. El valor predeterminado es TextElements (Graphemes).

EntitiesTaskResult

Contiene la tarea de entidad

Nombre Tipo Description
kind string:

EntityRecognitionResults

El tipo de resultado de la tarea.

results

EntitiesResult

Resultados para el reconocimiento de entidades.

Entity

Define el objeto de entidad detectado que contiene la categoría de entidad y el texto de entidad detectados, etc.

Nombre Tipo Description
category

string

Tipo de entidad.

confidenceScore

number

Puntuación de confianza entre 0 y 1 de la entidad extraída.

length

integer

Longitud del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar a la longitud devuelta.

offset

integer

Posición inicial del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar al desplazamiento devuelto.

subcategory

string

(Opcional) Subtipo de entidad.

text

string

Texto de entidad como aparece en la solicitud.

EntityCategory

Contiene todas las categorías de entidad detectadas por el reconocimiento de entidades.

Nombre Tipo Description
Address

string

Menciones específicas de nivel de calle de ubicaciones: números de vivienda/edificio, calles, avenidas, autopistas, intersecciones a las que se hace referencia por nombre.

Age

string

Valores relacionados con la edad.

Airport

string

Aeropuertos.

Area

string

Área de un objeto.

City

string

Valores relacionados con la ciudad.

ComputingProduct

string

Productos informáticos.

Continent

string

Valores relacionados con el continente.

CountryRegion

string

Valores relacionados con el país o región.

CulturalEvent

string

Valores relacionados con eventos culturales.

Currency

string

Valores relacionados con monedas.

Date

string

Fechas del calendario.

DateRange

string

Intervalo de fechas.

DateTime

string

Fechas del calendario con hora.

DateTimeRange

string

Intervalo de fecha y hora.

Dimension

string

Dimensión de las medidas

Duration

string

Duración del tiempo.

Email

string

Direcciones de correo electrónico.

Event

string

Social, deportivo, empresarial, político, educativo, natural, histórico, criminal, violento, legal, eventos militares con un período de tiempo.

GPE

string

Ciudades, países o regiones, estados.

Geological

string

Características geográficas y naturales, como ríos, océanos y desiertos.

Height

string

Alto de un objeto.

IP

string

direcciones IP de red.

Information

string

Unidad de medida para la información digital.

Length

string

Longitud de un objeto.

Location

string

Punto o lugar concretos en el espacio físico.

NaturalEvent

string

Valores naturales relacionados con eventos.

Number

string

Números sin una unidad

NumberRange

string

Intervalo de números

Numeric

string

Valores numéricos, incluidos dígitos y palabras numéricas.

Ordinal

string

Números ordinales.

Organization

string

Corporaciones, agencias y otros grupos de personas definidos por alguna estructura organizativa establecida. Estas etiquetas pueden incluir empresas, partidos políticos/movimientos, bandas musicales, clubes deportivos, organismos gubernamentales y organizaciones públicas. Las nacionalidades o religiones no son organización.

OrganizationMedical

string

Empresas y grupos médicos.

OrganizationSports

string

Organizaciones relacionadas con el deporte.

OrganizationStockExchange

string

Grupos de bolsa.

Percentage

string

Valores relacionados con porcentajes.

Person

string

Primero, último y segundo nombre, nombres de caracteres ficticios y alias. Títulos, como "Señor". o "Presidente", no se consideran parte de la entidad con nombre.

PersonType

string

Roles humanos clasificados por una pertenencia a grupos.

PhoneNumber

string

Números de teléfono (solo números de teléfono de EE. UU. y UE).

Product

string

Único o grupo de objetos comerciales, consumibles, electrónica, vehículos, grupos de alimentos.

SetTemporal

string

Conjunto de valores relacionados con el tiempo.

Skill

string

Funcionalidad, aptitud o experiencia.

Speed

string

Velocidad de un objeto.

SportsEvent

string

Valores relacionados con eventos deportivos.

State

string

Valores relacionados con el estado.

Structural

string

Estructuras hechas a mano.

Temperature

string

Valores relacionados con la temperatura.

Temporal

string

Elementos relacionados con el tiempo.

Time

string

Momentos del día.

TimeRange

string

Intervalo de horas.

URL

string

Direcciones URL a sitios web.

Volume

string

Volumen de un objeto.

Weight

string

Peso de un objeto.

EntityInferenceOptions

Clase que alberga las opciones de inferencia permitidas para el reconocimiento de entidades con nombre.

Nombre Tipo Valor predeterminado Description
excludeNormalizedValues

boolean

False

Opción para incluir o excluir los valores de entidad detectados que se van a normalizar e incluir en los metadatos. Los tipos de entidad numérica y temporal admiten la normalización de valores.

EntityLinkingResult

Resultado de la vinculación de entidades.

Nombre Tipo Description
documents

LinkedEntitiesDocumentResult[]

Respuesta por documento

errors

DocumentError[]

Errores por identificador de documento.

modelVersion

string

Este campo indica qué modelo se usa para la puntuación.

statistics

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

EntityLinkingTaskParameters

Parámetros admitidos para una tarea Entity Linking.

Nombre Tipo Valor predeterminado Description
loggingOptOut

boolean

False

no participar en el registro

modelVersion

string

latest

versión del modelo

stringIndexType

StringIndexType

TextElements_v8

Parámetro opcional para proporcionar el tipo de índice de cadena usado para interpretar los desplazamientos de cadena. El valor predeterminado es TextElements (Graphemes).

EntityLinkingTaskResult

Contiene el resultado de la tarea analizar la vinculación de entidades.

Nombre Tipo Description
kind string:

EntityLinkingResults

El tipo de resultado de la tarea.

results

EntityLinkingResult

Resultado de la vinculación de entidades.

EntityTag

Objeto de etiqueta de entidad que contiene el nombre de las etiquetas abd cualquier puntuación de confianza asociada. Las etiquetas de entidad se usan para expresar algunas similitudes o afinidad entre entidades.

Nombre Tipo Description
confidenceScore

number

Puntuación de detección entre 0 y 1 de la entidad extraída.

name

string

Nombre de la etiqueta. Los nombres de las etiquetas de entidad serán únicos globalmente.

EntityWithMetadata

Objeto de entidad con etiquetas y metadatos.

Nombre Tipo Description
category

string

Tipo de entidad.

confidenceScore

number

Puntuación de confianza entre 0 y 1 de la entidad extraída.

length

integer

Longitud del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar a la longitud devuelta.

metadata BaseMetadata:

Objeto de metadatos de entidad.

offset

integer

Posición inicial del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar al desplazamiento devuelto.

subcategory

string

(Opcional) Subtipo de entidad.

tags

EntityTag[]

Lista de etiquetas de entidad. Las etiquetas son para expresar algunas similitudes o afinidad entre entidades.

text

string

Texto de entidad como aparece en la solicitud.

type

string

Un tipo de entidad es la granularidad más baja (o más fina) en la que se ha detectado la entidad. El tipo se asigna a los atributos de metadatos específicos asociados a la entidad detectada.

Error

El objeto de respuesta de error devuelto cuando el servicio encuentra algunos errores durante el procesamiento de la solicitud.

Nombre Tipo Description
code

ErrorCode

Uno de un conjunto definido por el servidor de códigos de error.

details

Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.

innererror

InnerErrorModel

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Representación legible del error.

target

string

Destino del error.

ErrorCode

Código de error legible para personas.

Nombre Tipo Description
AzureCognitiveSearchIndexLimitReached

string

Error alcanzado el límite de índices de Azure Cognitive Search

AzureCognitiveSearchIndexNotFound

string

Error no encontrado en el índice de Azure Cognitive Search

AzureCognitiveSearchNotFound

string

Error no encontrado de Azure Cognitive Search

AzureCognitiveSearchThrottling

string

Error de limitación de Azure Cognitive Search

Conflict

string

Error de conflicto

Forbidden

string

Error de acceso prohibido

InternalServerError

string

Error interno del servidor

InvalidArgument

string

Error de argumento no válido

InvalidRequest

string

Error de solicitud no válido

NotFound

string

Error no encontrado

OperationNotFound

string

Error de operación no encontrado

ProjectNotFound

string

Error de proyecto no encontrado

QuotaExceeded

string

Error de cuota superada

ServiceUnavailable

string

Error de servicio no disponible

Timeout

string

Error de tiempo de espera

TooManyRequests

string

Error de demasiadas solicitudes

Unauthorized

string

Error de acceso no autorizado

Warning

string

Error de advertencia

ErrorResponse

Respuesta de error.

Nombre Tipo Description
error

Error

Objeto de error.

InformationMetadata

Representa el modelo de metadatos de entidad de información (datos).

Nombre Tipo Description
metadataKind string:

InformationMetadata

Tipo de objeto Metadata de entidad.

unit

InformationUnit

Unidad de medida para obtener información.

value

number

Valor numérico que indica el texto extraído.

InformationUnit

Unidad de medición de información (datos).

Nombre Tipo Description
Bit

string

Unidad de tamaño de datos en bits

Byte

string

Unidad de tamaño de datos en bytes

Gigabit

string

Unidad de tamaño de datos en gigabits

Gigabyte

string

Unidad de tamaño de datos en gigabytes

Kilobit

string

Unidad de tamaño de datos en kilobits

Kilobyte

string

Unidad de tamaño de datos en kilobytes

Megabit

string

Unidad de tamaño de datos en megabits

Megabyte

string

Unidad de tamaño de datos en megabytes

Petabit

string

Unidad de tamaño de datos en petabits

Petabyte

string

Unidad de tamaño de datos en petabytes

Terabit

string

Unidad de tamaño de datos en terabits

Terabyte

string

Unidad de tamaño de datos en terabytes

Unspecified

string

Unidad de tamaño de datos no especificada

InnerErrorCode

Código de error legible para personas.

Nombre Tipo Description
AzureCognitiveSearchNotFound

string

Error no encontrado de Azure Cognitive Search

AzureCognitiveSearchThrottling

string

Error de limitación de Azure Cognitive Search

EmptyRequest

string

Error de solicitud vacía

ExtractionFailure

string

Error de extracción

InvalidCountryHint

string

Error de sugerencia de país no válido

InvalidDocument

string

Error de documento no válido

InvalidDocumentBatch

string

Error de lote de documento no válido

InvalidParameterValue

string

Error de valor de parámetro no válido

InvalidRequest

string

Error de solicitud no válido

InvalidRequestBodyFormat

string

Error de formato de cuerpo de solicitud no válido

KnowledgeBaseNotFound

string

Error de base de conocimiento no encontrado

MissingInputDocuments

string

Error de documentos de entrada que faltan

ModelVersionIncorrect

string

Error incorrecto de la versión del modelo

UnsupportedLanguageCode

string

Error de código de idioma no admitido

InnerErrorModel

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre Tipo Description
code

InnerErrorCode

Uno de un conjunto definido por el servidor de códigos de error.

details

object

Detalles del error.

innererror

InnerErrorModel

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Mensaje de error.

target

string

Destino de error.

KeyPhraseResult

Contiene KeyPhraseResult.

Nombre Tipo Description
documents

KeyPhrasesDocumentResult[]

Respuesta por documento

errors

DocumentError[]

Errores por identificador de documento.

modelVersion

string

Este campo indica qué modelo se usa para la puntuación.

statistics

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

KeyPhrasesDocumentResult

Contiene los resultados de extracción de frases clave de un documento.

Nombre Tipo Description
id

string

Identificador de documento único y no vacío.

keyPhrases

string[]

Lista de palabras o frases representativas. El número de frases clave devueltas es proporcional al número de palabras del documento de entrada.

statistics

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

warnings

DocumentWarning[]

Advertencias detectadas al procesar el documento.

KeyPhraseTaskParameters

Parámetros admitidos para una tarea extracción de frases clave.

Nombre Tipo Valor predeterminado Description
loggingOptOut

boolean

False

no participar en el registro

modelVersion

string

latest

versión del modelo

KeyPhraseTaskResult

Contiene el resultado de la tarea Analizar texto KeyPhraseExtraction.

Nombre Tipo Description
kind string:

KeyPhraseExtractionResults

El tipo de resultado de la tarea.

results

KeyPhraseResult

Lista de resultados de extracción de frases clave

LanguageDetectionAnalysisInput

Contiene la entrada de análisis de documentos de detección de idioma.

Nombre Tipo Description
documents

LanguageInput[]

Lista de documentos que se van a analizar.

LanguageDetectionDocumentResult

Contiene la detección de idioma de un documento.

Nombre Tipo Description
detectedLanguage

DetectedLanguage

Idioma detectado.

id

string

Identificador de documento único y no vacío.

statistics

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

warnings

DocumentWarning[]

Advertencias detectadas al procesar el documento.

LanguageDetectionResult

Contiene el resultado de detección de idioma para la solicitud.

Nombre Tipo Description
documents

LanguageDetectionDocumentResult[]

Enumeración de los resultados de detección de idioma para cada documento de entrada.

errors

DocumentError[]

Errores por identificador de documento.

modelVersion

string

Este campo indica qué modelo se usa para la puntuación.

statistics

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

LanguageDetectionTaskParameters

Parámetros admitidos para una tarea detección de idioma.

Nombre Tipo Valor predeterminado Description
loggingOptOut

boolean

False

no participar en el registro

modelVersion

string

latest

versión del modelo

LanguageDetectionTaskResult

Contiene el resultado de la tarea de detección de idioma para la solicitud.

Nombre Tipo Description
kind string:

LanguageDetectionResults

El tipo de resultado de la tarea.

results

LanguageDetectionResult

Contiene los resultados de detección de idioma.

LanguageInput

Contiene la entrada de detección de idioma.

Nombre Tipo Description
countryHint

string

Sugerencia de país para ayudar con la detección de idioma del texto.

id

string

Identificador de documento único y no vacío.

text

string

Texto de entrada que se va a procesar.

LengthMetadata

Representa el modelo de metadatos de entidad length.

Nombre Tipo Description
metadataKind string:

LengthMetadata

Tipo de objeto Metadata de entidad.

unit

LengthUnit

Unidad de medida para la longitud.

value

number

Valor numérico que indica el texto extraído.

LengthUnit

Unidad de medida de longitud.

Nombre Tipo Description
Centimeter

string

Unidad de longitud en centímetros.

Decameter

string

Unidad de longitud en decametros.

Decimeter

string

Unidad de longitud en decimetros.

Foot

string

Unidad de longitud en pies.

Hectometer

string

Unidad de longitud en hectómetros.

Inch

string

Unidad de longitud en pulgadas.

Kilometer

string

Unidad de longitud en kilómetros.

LightYear

string

Unidad de longitud en años ligeros.

Meter

string

Unidad de longitud en metros.

Micrometer

string

Unidad de longitud en micrometros.

Mile

string

Unidad de longitud en millas.

Millimeter

string

Unidad de longitud en milímetros.

Nanometer

string

Unidad de longitud en nanometros.

Picometer

string

Unidad de longitud en picometros.

Point

string

Unidad de longitud en puntos.

Unspecified

string

Unidad de longitud no especificada.

Yard

string

Unidad de longitud en patios.

LinkedEntitiesDocumentResult

Resultado del documento de vinculación de entidades.

Nombre Tipo Description
entities

LinkedEntity[]

Entidades conocidas reconocidas en el documento.

id

string

Identificador de documento único y no vacío.

statistics

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

warnings

DocumentWarning[]

Advertencias detectadas al procesar el documento.

LinkedEntity

Objeto LinkedEntity que contiene la entidad detectada con los orígenes o vínculos asociados.

Nombre Tipo Description
bingId

string

Identificador único de Bing Entity Search API de la entidad reconocida.

dataSource

string

Origen de datos usado para extraer la vinculación de entidades, como Wiki/Bing, etc.

id

string

Identificador único de la entidad reconocida del origen de datos.

language

string

Idioma usado en el origen de datos.

matches

Match[]

Lista de instancias de esta entidad aparece en el texto.

name

string

Nombre formal de vinculación de entidad.

url

string

Dirección URL de la página de la entidad desde el origen de datos.

Match

Objeto Match que contiene el texto de la entidad detectada con el desplazamiento y la longitud.

Nombre Tipo Description
confidenceScore

number

Si se reconoce un elemento conocido, se devolverá un número decimal que indica el nivel de confianza entre 0 y 1.

length

integer

Longitud del texto de coincidencia de entidad.

offset

integer

Posición inicial del texto de coincidencia de entidad.

text

string

Texto de entidad como aparece en la solicitud.

MatchLongestEntityPolicyType

Representa la directiva de superposición de coincidencia más larga. No se superponen entidades en la medida en que sea posible. 1. Si hay entidades superpuestas, se devolverá la más larga. 2. Si el conjunto de caracteres previsto para 2 o más entidades es exactamente el mismo, seleccione la entidad que tiene la puntuación de confianza más alta.3. Si las puntuaciones de entidad son idénticas, devuelva todas las entidades que siguen presentes después de aplicar las reglas anteriores. 3. Si hay superposición parcial (como en Hello Text Analytics), siga los pasos anteriores a partir de 1.

Nombre Tipo Valor predeterminado Description
policyKind string:

matchLongest

matchLongest

Tipo de objeto OverlapPolicy de entidad.

MetadataKind

Tipo de objeto Metadata de entidad.

Nombre Tipo Description
AgeMetadata

string

Metadatos para valores relacionados con la antigüedad.

AreaMetadata

string

Metadatos para los valores relacionados con el área.

CurrencyMetadata

string

Metadatos para valores relacionados con monedas.

DateMetadata

string

Metadatos para los valores relacionados con la fecha.

DateTimeMetadata

string

Metadatos para valores relacionados con la fecha y hora.

InformationMetadata

string

Metadatos para valores relacionados con la información.

LengthMetadata

string

Metadatos para valores relacionados con la longitud.

NumberMetadata

string

Metadatos para valores numéricos.

NumericRangeMetadata

string

Metadatos para los valores de intervalo numérico.

OrdinalMetadata

string

Metadatos de números ordinales.

SpeedMetadata

string

Metadatos para valores relacionados con la velocidad.

TemperatureMetadata

string

Metadatos para los valores relacionados con la temperatura.

TemporalSetMetadata

string

Metadatos para el conjunto de valores relacionados con el tiempo.

TemporalSpanMetadata

string

Metadatos para los valores de intervalo temporal.

TimeMetadata

string

Metadatos para valores relacionados con el tiempo.

VolumeMetadata

string

Metadatos para los valores relacionados con el volumen.

WeightMetadata

string

Metadatos para valores relacionados con el peso.

MultiLanguageAnalysisInput

Colección de documentos de entrada que va a analizar el servicio.

Nombre Tipo Description
documents

MultiLanguageInput[]

Documentos de entrada que se van a analizar.

MultiLanguageInput

Contiene un documento de entrada que el servicio va a analizar.

Nombre Tipo Description
id

string

Identificador de documento único y no vacío.

language

string

(Opcional) Esta es la representación ISO 639-1 de dos letras de un idioma. Por ejemplo, use "en" para inglés; "es" para español, etc. Si no se establece, use "en" para inglés como valor predeterminado. (Después solo se aplica a 2023-04-15-preview y versiones posteriores) En Detección automática de idioma, use "auto". Si no se establece, use "en" para inglés como valor predeterminado.

text

string

Texto de entrada que se va a procesar.

NumberKind

Tipo de la entidad numérica extraída.

Nombre Tipo Description
Decimal

string

Número decimal

Fraction

string

Número de fracción

Integer

string

Número entero

Percent

string

Número de porcentaje

Power

string

Número de energía

Unspecified

string

Tipo de número no especificado

NumberMetadata

Metadatos para instancias de entidad numéricas.

Nombre Tipo Description
metadataKind string:

NumberMetadata

Tipo de objeto Metadata de entidad.

numberKind

NumberKind

Tipo del tipo de número.

value

number

Representación numérica de lo que indica el texto extraído.

NumericRangeMetadata

representa los metadatos de intervalos numéricos.

Nombre Tipo Description
maximum

number

Valor final del intervalo.

metadataKind string:

NumericRangeMetadata

Tipo de objeto Metadata de entidad.

minimum

number

Valor inicial del intervalo.

rangeInclusivity

RangeInclusivity

La inclusión de este intervalo.

rangeKind

RangeKind

Tipo de intervalos numéricos admitidos, como Número, Velocidad, etc.

OrdinalMetadata

Metadatos para instancias de entidad numéricas.

Nombre Tipo Description
metadataKind string:

OrdinalMetadata

Tipo de objeto Metadata de entidad.

offset

string

Desplazamiento con respecto a la referencia (por ejemplo, desplazamiento = -1 indica el segundo al último)

relativeTo

RelativeTo

Punto de referencia que indica el número ordinal.

value

string

Expresión aritmética simple que denota el ordinal.

PiiCategory

(Opcional) describe las categorías de PII que se van a devolver.

Nombre Tipo Description
ABARoutingNumber

string

Número de enrutamiento de ABA

ARNationalIdentityNumber

string

Número de identidad nacional de AR

ATIdentityCard

string

TARJETA de identidad AT

ATTaxIdentificationNumber

string

Número de identificación fiscal AT

ATValueAddedTaxNumber

string

Número fiscal agregado de AT

AUBankAccountNumber

string

TARJETA de identidad AT

AUBusinessNumber

string

Número de negocio de AU

AUCompanyNumber

string

Número de empresa de AU

AUDriversLicenseNumber

string

Número de licencia de conducir de AU

AUMedicalAccountNumber

string

Número de cuenta médica de AU

AUPassportNumber

string

Número de pasaporte de AU

AUTaxFileNumber

string

Número de archivo fiscal au

Address

string

Dirección

Age

string

Edad

All

string

Todas las categorías de PII.

AzureDocumentDBAuthKey

string

Clave de autenticación de Azure Document DB

AzureIAASDatabaseConnectionAndSQLString

string

Conexión de base de datos IAAS de Azure y cadena SQL

AzureIoTConnectionString

string

Cadena de conexión de Azure IoT

AzurePublishSettingPassword

string

Contraseña de configuración de publicación de Azure

AzureRedisCacheString

string

Cadena de azure Redis Cache

AzureSAS

string

Azure SAS

AzureServiceBusString

string

Cadena de Azure Service Bus

AzureStorageAccountGeneric

string

Cuenta de Azure Storage genérica

AzureStorageAccountKey

string

Clave de cuenta de Azure Storage

BENationalNumber

string

BE National Number

BENationalNumberV2

string

BE National Number V2

BEValueAddedTaxNumber

string

BE Value Added Tax Number

BGUniformCivilNumber

string

Número civil uniforme de BG

BRCPFNumber

string

Número CPF de BR

BRLegalEntityNumber

string

Número de entidad jurídica br

BRNationalIDRG

string

BR National ID RG

CABankAccountNumber

string

Número de cuenta bancaria de CA

CADriversLicenseNumber

string

Número de licencia del controlador de CA

CAHealthServiceNumber

string

Número del servicio de mantenimiento de CA

CAPassportNumber

string

Número de pasaporte de CA

CAPersonalHealthIdentification

string

Identificación de estado personal de CA

CASocialInsuranceNumber

string

Número de seguro social de CA

CHSocialSecurityNumber

string

Número de seguro social de CH

CLIdentityCardNumber

string

Número de tarjeta de identidad cl

CNResidentIdentityCardNumber

string

Número de tarjeta de identidad residente de CN

CYIdentityCard

string

Tarjeta de identidad cy

CYTaxIdentificationNumber

string

Número de identificación fiscal cy

CZPersonalIdentityNumber

string

Número de identidad personal de CZ

CZPersonalIdentityV2

string

CZ Personal Identity V2

CreditCardNumber

string

Número de tarjeta de crédito

DEDriversLicenseNumber

string

Número de licencia de conducir de DE

DEIdentityCardNumber

string

Número de tarjeta de identidad de DE

DEPassportNumber

string

Número de pasaporte de DE

DETaxIdentificationNumber

string

Número de identificación fiscal DE

DEValueAddedNumber

string

Número agregado de valor DE

DKPersonalIdentificationNumber

string

Número de identificación personal de DK

DKPersonalIdentificationV2

string

DK Personal Identification V2

Date

string

Fecha

Default

string

Categorías de PII predeterminadas para el idioma.

DrugEnforcementAgencyNumber

string

Número de la Agencia de Control de Drogas

EEPersonalIdentificationCode

string

Código de identificación personal EE

ESDNI

string

ES DNI

ESSocialSecurityNumber

string

Número de seguridad social de ES

ESTaxIdentificationNumber

string

Número de identificación fiscal de ES

EUDebitCardNumber

string

Número de tarjeta de débito de la UE

EUDriversLicenseNumber

string

Número de licencia de conducir de la UE

EUGPSCoordinates

string

Coordenadas GPS de la UE

EUNationalIdentificationNumber

string

Número de identificación nacional de la UE

EUPassportNumber

string

Número de pasaporte de la UE

EUSocialSecurityNumber

string

Número de seguro social de la UE

EUTaxIdentificationNumber

string

Número de identificación fiscal de la UE

Email

string

Correo electrónico

FIEuropeanHealthNumber

string

Número de salud europea de FI

FINationalID

string

Id. nacional de FI

FINationalIDV2

string

FI National ID V2

FIPassportNumber

string

Número de pasaporte FI

FRDriversLicenseNumber

string

Número de licencia de conducir de FR

FRHealthInsuranceNumber

string

Número de seguro médico de FR

FRNationalID

string

Id. nacional de FR

FRPassportNumber

string

Número de pasaporte de FR

FRSocialSecurityNumber

string

Número de seguridad social de FR

FRTaxIdentificationNumber

string

Número de identificación fiscal de FR

FRValueAddedTaxNumber

string

Número de impuesto sobre el valor añadido de FR

GRNationalIDCard

string

Tarjeta de identificación nacional gr

GRNationalIDV2

string

GR National ID V2

GRTaxIdentificationNumber

string

Número de identificación fiscal gr

HKIdentityCardNumber

string

Número de tarjeta de identidad hk

HRIdentityCardNumber

string

Número de tarjeta de identidad de RR. HH.

HRNationalIDNumber

string

Número de identificación nacional de RR. HH.

HRPersonalIdentificationNumber

string

Número de identificación personal de RR. HH.

HRPersonalIdentificationOIBNumberV2

string

Identificación personal de RR. HH. número OIB V2

HUPersonalIdentificationNumber

string

Número de identificación personal hu

HUTaxIdentificationNumber

string

Número de identificación fiscal HU

HUValueAddedNumber

string

Número agregado de valor HU

IDIdentityCardNumber

string

Id. Número de tarjeta de identidad

IEPersonalPublicServiceNumber

string

Número de servicio público personal de IE

IEPersonalPublicServiceNumberV2

string

Número de servicio público personal de IE V2

ILBankAccountNumber

string

Número de cuenta bancaria il

ILNationalID

string

Id. nacional de IL

INPermanentAccount

string

IN Permanent Account

INUniqueIdentificationNumber

string

NÚMERO de identificación único EN

IPAddress

string

Dirección IP

ITDriversLicenseNumber

string

Número de licencia de conducir de TI

ITFiscalCode

string

Código fiscal de TI

ITValueAddedTaxNumber

string

Número fiscal agregado de valor de TI

InternationalBankingAccountNumber

string

Número de cuenta bancaria internacional

JPBankAccountNumber

string

Número de cuenta bancaria de JP

JPDriversLicenseNumber

string

Número de licencia de conducir de JP

JPMyNumberCorporate

string

JP My Number Corporate

JPMyNumberPersonal

string

JP My Number Personal

JPPassportNumber

string

Número de pasaporte jp

JPResidenceCardNumber

string

Número de tarjeta de residencia JP

JPResidentRegistrationNumber

string

Número de registro residente de JP

JPSocialInsuranceNumber

string

JP Social Insurance Number

KRResidentRegistrationNumber

string

Número de registro residente de KR

LTPersonalCode

string

Código personal LT

LUNationalIdentificationNumberNatural

string

Número de identificación nacional de LU Natural

LUNationalIdentificationNumberNonNatural

string

Número de identificación nacional de LU no natural

LVPersonalCode

string

Código personal de LV

MTIdentityCardNumber

string

Número de tarjeta de identidad mt

MTTaxIDNumber

string

Número de identificación fiscal mt

MYIdentityCardNumber

string

Mi número de tarjeta de identidad

NLCitizensServiceNumber

string

Número de servicio de ciudadanos de NL

NLCitizensServiceNumberV2

string

Número de servicio de ciudadanos de NL V2

NLTaxIdentificationNumber

string

Número de identificación fiscal nl

NLValueAddedTaxNumber

string

Número fiscal añadido de valor NL

NOIdentityNumber

string

No hay número de identidad

NZBankAccountNumber

string

Número de cuenta bancaria de NZ

NZDriversLicenseNumber

string

Número de licencia de conducir de NZ

NZInlandRevenueNumber

string

NZ Inland Revenue Number

NZMinistryOfHealthNumber

string

Número de NZ Ministerio de Salud

NZSocialWelfareNumber

string

NZ Social Welfare Number

Organization

string

Organización

PHUnifiedMultiPurposeIDNumber

string

Número de id. de varios propósitos unificado de PH

PLIdentityCard

string

Tarjeta de identidad de PL

PLNationalID

string

ID nacional de PL

PLNationalIDV2

string

PL National ID V2

PLPassportNumber

string

Número de pasaporte de PL

PLREGONNumber

string

Número REGON de PL

PLTaxIdentificationNumber

string

Número de identificación fiscal de PL

PTCitizenCardNumber

string

Número de tarjeta de ciudadano PT

PTCitizenCardNumberV2

string

Número de tarjeta de ciudadano PT V2

PTTaxIdentificationNumber

string

Número de identificación fiscal PT

Person

string

Persona

PhoneNumber

string

Número de teléfono

ROPersonalNumericalCode

string

Código numérico personal de RO

RUPassportNumberDomestic

string

Número de pasaporte ru nacional

RUPassportNumberInternational

string

Número de pasaporte ru internacional

SANationalID

string

Identificador nacional de SA

SENationalID

string

SE National ID

SENationalIDV2

string

SE National ID V2

SEPassportNumber

string

Número de PASAPORTE DE SE

SETaxIdentificationNumber

string

Número de identificación fiscal SE

SGNationalRegistrationIdentityCardNumber

string

Número de tarjeta de identidad del registro nacional sg

SITaxIdentificationNumber

string

Número de identificación fiscal SI

SIUniqueMasterCitizenNumber

string

Número de ciudadano maestro único de SI

SKPersonalNumber

string

SK Personal Number

SQLServerConnectionString

string

Cadena de conexión de SQL Server

SWIFTCode

string

Código SWIFT

THPopulationIdentificationCode

string

Código de identificación de población TH

TRNationalIdentificationNumber

string

Número de identificación nacional tr

TWNationalID

string

Id. nacional de TW

TWPassportNumber

string

Número de pasaporte de TW

TWResidentCertificate

string

Certificado residente de TW

UAPassportNumberDomestic

string

Número de pasaporte nacional de UA

UAPassportNumberInternational

string

Número de pasaporte internacional de UA

UKDriversLicenseNumber

string

Número de licencia de conducir del Reino Unido

UKElectoralRollNumber

string

Número de lista electoral del Reino Unido

UKNationalHealthNumber

string

Número nacional de salud del Reino Unido

UKNationalInsuranceNumber

string

Número de seguro nacional del Reino Unido

UKUniqueTaxpayerNumber

string

Número único de contribuyentes del Reino Unido

URL

string

URL

USBankAccountNumber

string

Número de cuenta bancaria de EE. UU.

USDriversLicenseNumber

string

Número de licencia de conducir de EE. UU.

USIndividualTaxpayerIdentification

string

Identificación individual de contribuyentes de EE. UU.

USSocialSecurityNumber

string

Número de seguridad social de EE. UU.

USUKPassportNumber

string

Número de pasaporte del Reino Unido de EE. UU.

ZAIdentificationNumber

string

Número de identificación de ZA

PiiDomain

Dominio para la tarea PII

Nombre Tipo Description
none

string

Indica que no se especifica ningún dominio.

phi

string

Indica que se deben censurar las entidades del dominio información de salud personal.

PiiEntitiesDocumentResult

Contiene los resultados de PII.

Nombre Tipo Description
entities

Entity[]

Entidades reconocidas en el documento.

id

string

Identificador de documento único y no vacío.

redactedText

string

Devuelve texto censurado.

statistics

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

warnings

DocumentWarning[]

Advertencias detectadas al procesar el documento.

PiiResult

Contiene piiResult.

Nombre Tipo Description
documents

PiiEntitiesDocumentResult[]

Respuesta por documento

errors

DocumentError[]

Errores por identificador de documento.

modelVersion

string

Este campo indica qué modelo se usa para la puntuación.

statistics

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

PiiTaskParameters

Parámetros admitidos para una tarea de reconocimiento de entidades de PII.

Nombre Tipo Valor predeterminado Description
domain

PiiDomain

none

Dominio para la tarea PII

loggingOptOut

boolean

False

no participar en el registro

modelVersion

string

latest

versión del modelo

piiCategories

PiiCategory[]

Enumeración de categorías de PII que se van a devolver en la respuesta.

stringIndexType

StringIndexType

TextElements_v8

StringIndexType que se va a usar para el análisis.

PiiTaskResult

Contiene la tarea LRO analizar texto PIIEntityRecognition.

Nombre Tipo Description
kind string:

PiiEntityRecognitionResults

El tipo de resultado de la tarea.

results

PiiResult

Lista de resultados de pii

RangeInclusivity

La inclusión de intervalo de esta propiedad.

Nombre Tipo Description
LeftInclusive

string

Incluido en el lado izquierdo

LeftRightInclusive

string

Ambos lados inclusive

NoneInclusive

string

No hay inclusividad

RightInclusive

string

Lado derecho inclusivo

RangeKind

Tipo de la entidad de intervalo de números.

Nombre Tipo Description
Age

string

Intervalo de edad

Area

string

Intervalo de áreas

Currency

string

Intervalo de moneda

Information

string

Intervalo de información

Length

string

Intervalo de longitud

Number

string

Intervalo de números

Speed

string

Intervalo de velocidad

Temperature

string

Intervalo de temperatura

Volume

string

Intervalo de volúmenes

Weight

string

Rango de peso

RelativeTo

Punto de referencia que indica el número ordinal.

Nombre Tipo Description
Current

string

Estado o posición actual

End

string

Estado final o posición

Start

string

Estado o posición de inicio

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

Nombre Tipo Description
documentsCount

integer

Número de documentos enviados en la solicitud.

erroneousDocumentsCount

integer

Número de documentos no válidos. Esto incluye documentos vacíos, de límite de tamaño excesivo o de idiomas no admitidos.

transactionsCount

integer

Número de transacciones de la solicitud.

validDocumentsCount

integer

Número de documentos válidos. Esto excluye documentos vacíos, de límite de tamaño excesivo o de idiomas no admitidos.

ScriptCode

Identifica el script del documento de entrada. Se asigna al código de script estándar ISO 15924.

Nombre Tipo Description
Arab

string

Código de script para el script árabe.

Armn

string

Código de script para el script armenio.

Beng

string

Código de script para el script bangla.

Cans

string

Código de script para el script UnifiedCanadianAboriginalSyllabics.

Cyrl

string

Código de script para el script cirílico.

Deva

string

Código de script para el script Devanagari.

Ethi

string

Código de script para el script Ethiopic.

Geor

string

Código de script para el script georgiano.

Grek

string

Código de script para el script griego.

Gujr

string

Código de script para el script de Gujarati.

Guru

string

Código de script para el script de Gurmukhi.

Hang

string

Código de script para el script de Hangul.

Hani

string

Código de script para el script de HanLiteral.

Hans

string

Código de script para el script hanSimplified.

Hant

string

Código de script para el script hanTraditional.

Hebr

string

Código de script para el script hebreo.

Jpan

string

Código de script para el script japonés.

Khmr

string

Código de script para el script Khmer.

Knda

string

Código de script para el script kannada.

Laoo

string

Código de script para el script Lao.

Latn

string

Código de script para el script latino.

Mlym

string

Código de script para el script malayalam.

Mong

string

Código de script para el script de Mongolia.

Mtei

string

Código de script para el script Meitei.

Mymr

string

Código de script para el script de Myanmar.

Olck

string

Código de script para el script de Santali.

Orya

string

Código de script para el script Odia.

Shrd

string

Código de script para el script sharada.

Sinh

string

Código de script para el script de Sinhala.

Taml

string

Código de script para el script de Tamil.

Telu

string

Código de script para el script Telugu.

Thaa

string

Código de script para el script thaana.

Thai

string

Código de script para el script tailandés.

Tibt

string

Código de script para el script tibetano.

ScriptKind

Identifica el script del documento de entrada. Se asigna al nombre formal estándar ISO 15924.

Nombre Tipo Description
Arabic

string

Nombre del script para el script árabe.

Armenian

string

Nombre del script para el script armenio.

Bangla

string

Nombre del script para el script de Bangla.

Cyrillic

string

Nombre del script para el script cirílico.

Devanagari

string

Nombre del script para el script Devanagari.

Ethiopic

string

Nombre del script para el script Ethiopic.

Georgian

string

Nombre del script para el script georgiano.

Greek

string

Nombre del script para el alfabeto griego.

Gujarati

string

Nombre del script para el script de Gujarati.

Gurmukhi

string

Nombre del script para el script de Gurmukhi.

HanLiteral

string

Nombre del script para el script hanLiteral.

HanSimplified

string

Nombre del script para el script hanSimplified.

HanTraditional

string

Nombre del script para el script hanTraditional.

Hangul

string

Nombre del script para el script de Hangul.

Hebrew

string

Nombre del script para el script hebreo.

Japanese

string

Nombre del script para el script japonés.

Kannada

string

Nombre del script para el script kannada.

Khmer

string

Nombre del script para el script khmer.

Lao

string

Nombre del script para el script Lao.

Latin

string

Nombre del script para el script latino.

Malayalam

string

Nombre del script para el script malayalam.

Meitei

string

Nombre del script para el script Meitei.

Mongolian

string

Nombre del script para el script de Mongolia.

Myanmar

string

Nombre del script para el script de Myanmar.

Odia

string

Nombre del script para el script odia.

Santali

string

Nombre del script para el script de Santali.

Sharada

string

Nombre del script para el script sharada.

Sinhala

string

Nombre del script para el script de Sinhala.

Tamil

string

Nombre del script para el script de Tamil.

Telugu

string

Nombre del script para el script Telugu.

Thaana

string

Nombre del script para el script thaana.

Thai

string

Nombre del script para el script tailandés.

Tibetan

string

Nombre del script para la escritura tibetana.

UnifiedCanadianAboriginalSyllabics

string

Nombre del script para el script UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

Representa una evaluación de oraciones y las evaluaciones o los objetos de destino relacionados con ella.

Nombre Tipo Description
confidenceScores

TargetConfidenceScoreLabel

Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.

isNegated

boolean

Indicador que representa si la evaluación está negada.

length

integer

Longitud del destino.

offset

integer

Desplazamiento de destino desde el principio de la oración.

sentiment

TokenSentimentValue

Opinión de la frase.

text

string

Se detectó el texto de destino.

SentenceSentiment

Opinión de frase de un documento.

Nombre Tipo Description
assessments

SentenceAssessment[]

Matriz de evaluaciones para la oración.

confidenceScores

SentimentConfidenceScores

Puntuación de confianza de sentimiento entre 0 y 1 para la oración para todas las clases.

length

integer

Longitud del destino.

offset

integer

Desplazamiento de destino desde el principio de la oración.

sentiment

SentenceSentimentValue

Opinión predicha para la frase.

targets

SentenceTarget[]

Matriz de destinos de oración para la oración.

text

string

Texto de la frase.

SentenceSentimentValue

Opinión predicha para la frase.

Nombre Tipo Description
negative

string

Opinión negativa

neutral

string

Opinión neutra

positive

string

Opinión positiva

SentenceTarget

Representa un destino de oración y las evaluaciones o los objetos de destino relacionados con él.

Nombre Tipo Description
confidenceScores

TargetConfidenceScoreLabel

Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.

length

integer

Longitud del destino.

offset

integer

Desplazamiento de destino desde el principio de la oración.

relations

TargetRelation[]

Matriz de objetos de evaluación o de destino relacionados con el destino.

sentiment

TokenSentimentValue

Opinión de la frase.

text

string

Se detectó el texto de destino.

SentimentAnalysisTaskParameters

Parámetros admitidos para una tarea Análisis de sentimiento.

Nombre Tipo Valor predeterminado Description
loggingOptOut

boolean

False

no participar en el registro

modelVersion

string

latest

versión del modelo

opinionMining

boolean

False

Si se va a usar la minería de opiniones en la solicitud o no.

stringIndexType

StringIndexType

TextElements_v8

Especifica el método utilizado para interpretar los desplazamientos de cadena.

SentimentConfidenceScores

Representa las puntuaciones de confianza entre 0 y 1 en todas las clases de sentimiento: positivas, neutrales y negativas.

Nombre Tipo Description
negative

number

Puntuación de confianza para opiniones negativas

neutral

number

Puntuación de confianza para opiniones neutrales

positive

number

Puntuación de confianza para opiniones positivas

SentimentDocumentResult

Objeto que representa los resultados predefinidos del análisis de sentimiento de cada documento.

Nombre Tipo Description
confidenceScores

SentimentConfidenceScores

Puntuación de confianza de sentimiento entre 0 y 1 para la oración para todas las clases.

id

string

Identificador de documento único y no vacío.

sentences

SentenceSentiment[]

Opinión de las oraciones del documento.

sentiment

DocumentSentimentValue

Opinión prevista para el documento (Negativo, Neutro, Positivo o Mixto).

statistics

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

warnings

DocumentWarning[]

Advertencias detectadas al procesar el documento.

SentimentResponse

Resultados del análisis de sentimiento para los documentos de entrada.

Nombre Tipo Description
documents

SentimentDocumentResult[]

Los resultados del análisis de sentimiento para cada documento de la entrada.

errors

DocumentError[]

Errores por identificador de documento.

modelVersion

string

Este campo indica qué modelo se usa para la puntuación.

statistics

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

SentimentTaskResult

Contiene el resultado de la tarea analizar SentimentAnalysis LRO.

Nombre Tipo Description
kind string:

SentimentAnalysisResults

El tipo de resultado de la tarea.

results

SentimentResponse

Resultados del análisis de sentimiento

SpeedMetadata

Representa el modelo de metadatos de entidad Speed.

Nombre Tipo Description
metadataKind string:

SpeedMetadata

Tipo de objeto Metadata de entidad.

unit

SpeedUnit

Unidad de medida para la velocidad.

value

number

Valor numérico que indica el texto extraído.

SpeedUnit

Unidad de medida de velocidad

Nombre Tipo Description
CentimetersPerMillisecond

string

Unidad de velocidad en centímetros por milisegundo.

FeetPerMinute

string

Unidad de velocidad en pies por minuto.

FeetPerSecond

string

Unidad de velocidad en pies por segundo.

KilometersPerHour

string

Unidad de velocidad en kilómetros por hora.

KilometersPerMillisecond

string

Unidad de velocidad en kilómetros por milisegundos.

KilometersPerMinute

string

Unidad de velocidad en kilómetros por minuto.

KilometersPerSecond

string

Unidad de velocidad en kilómetros por segundo.

Knots

string

Unidad de velocidad en nudos.

MetersPerMillisecond

string

Unidad de velocidad en metros por milisegundos.

MetersPerSecond

string

Unidad de velocidad en metros por segundo.

MilesPerHour

string

Unidad de velocidad en millas por hora.

Unspecified

string

Unidad de velocidad no especificada.

YardsPerMinute

string

Unidad de velocidad en yardas por minuto.

YardsPerSecond

string

Unidad de velocidad en yardas por segundo.

StringIndexType

Tipo de índice de cadena

Nombre Tipo Description
TextElements_v8

string

Los valores de desplazamiento y longitud devueltos se corresponden con TextElements (clústeres de Graphemes y Grapheme) que confirman el estándar Unicode 8.0.0. Use esta opción si la aplicación está escrita en .Net Framework o .Net Core y usará StringInfo.

UnicodeCodePoint

string

Los valores de desplazamiento y longitud devueltos se corresponden con los puntos de código Unicode. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo, Python.

Utf16CodeUnit

string

Los valores de desplazamiento y longitud devueltos corresponden a unidades de código UTF-16. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo Java, JavaScript.

TargetConfidenceScoreLabel

Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.

Nombre Tipo Description
negative

number

Puntuación de confianza para opiniones negativas

positive

number

Puntuación de confianza para opiniones positivas

TargetRelation

Representa la relación entre evaluaciones o destinos.

Nombre Tipo Description
ref

string

Puntero JSON que indica el objeto vinculado.

relationType

TargetRelationType

Tipo relacionado con el destino.

TargetRelationType

Tipo relacionado con el destino.

Nombre Tipo Description
assessment

string

Relación de evaluación.

target

string

Relación de destino.

TemperatureMetadata

Representa el modelo de metadatos de entidad de información.

Nombre Tipo Description
metadataKind string:

TemperatureMetadata

Tipo de objeto Metadata de entidad.

unit

TemperatureUnit

Unidad de medida para la temperatura.

value

number

Valor numérico que indica el texto extraído.

TemperatureUnit

Unidad de medición de temperatura.

Nombre Tipo Description
Celsius

string

Unidad de temperatura en Celsius

Fahrenheit

string

Unidad de temperatura en Fahrenheit

Kelvin

string

Unidad de temperatura en Kelvin

Rankine

string

Unidad de temperatura en Rankine

Unspecified

string

Unidad de temperatura no especificada

TemporalModifier

Un modificador opcional de una instancia de fecha y hora.

Nombre Tipo Description
After

string

Después de una hora específica

AfterApprox

string

Después de un tiempo aproximado

AfterMid

string

Después del medio de un período de tiempo

AfterStart

string

Después del inicio de un período de tiempo

Approx

string

Aproximadamente en un momento específico

Before

string

Antes de una hora específica

BeforeApprox

string

Antes de una hora aproximada

BeforeEnd

string

Antes del final de un período de tiempo

BeforeStart

string

Antes del inicio de un período de tiempo

End

string

Al final de un período de tiempo

Less

string

Menor que un tiempo específico

Mid

string

En medio de un período de tiempo

More

string

Más que una hora específica

ReferenceUndefined

string

Referencia a una hora no definida

Since

string

Desde una hora específica

SinceEnd

string

Desde el final de un período de tiempo

Start

string

Al principio de un período de tiempo

Until

string

Hasta una hora específica

TemporalSetMetadata

Metadatos para instancias de entidad de conjunto temporal.

Nombre Tipo Description
dateValues

DateValue[]

Lista de valores de fecha.

metadataKind string:

TemporalSetMetadata

Tipo de objeto Metadata de entidad.

TemporalSpanMetadata

representa los metadatos de una fecha o intervalo de tiempo.

Nombre Tipo Description
metadataKind string:

TemporalSpanMetadata

Tipo de objeto Metadata de entidad.

spanValues

TemporalSpanValues[]

Lista de intervalos temporales detectados.

TemporalSpanValues

Objeto span temporal.

Nombre Tipo Description
begin

string

Valor inicial del intervalo.

duration

string

Valor de duración opcional con formato basado en iso 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)

end

string

Valor final del intervalo.

modifier

TemporalModifier

Modificador para datetime para indicar el punto de referencia como antes, después, etc.

timex

string

Un triplete opcional que contiene el principio, el final y la duración indicados como cadenas con formato ISO 8601.

TimeMetadata

Metadatos para instancias de entidad de tiempo.

Nombre Tipo Description
dateValues

DateValue[]

Lista de valores de fecha.

metadataKind string:

TimeMetadata

Tipo de objeto Metadata de entidad.

TokenSentimentValue

Opinión predicha para la frase.

Nombre Tipo Description
mixed

string

Opinión mixta

negative

string

Opinión negativa

positive

string

Opinión positiva

VolumeMetadata

Representa el modelo de metadatos de entidad de volumen.

Nombre Tipo Description
metadataKind string:

VolumeMetadata

Tipo de objeto Metadata de entidad.

unit

VolumeUnit

Unidad de medida para el volumen.

value

number

Valor numérico que indica el texto extraído.

VolumeUnit

Unidad de volumen de medida

Nombre Tipo Description
Barrel

string

Unidad de volumen en barricas.

Bushel

string

Unidad de volumen en carretes.

Centiliter

string

Unidad de volumen en centilitros.

Cord

string

Unidad de volumen en cables.

CubicCentimeter

string

Unidad de volumen en centímetros cúbicos.

CubicFoot

string

Unidad de volumen en pies cúbicos.

CubicInch

string

Unidad de volumen en pulgadas cúbicas.

CubicMeter

string

Unidad de volumen en metros cúbicos.

CubicMile

string

Unidad de volumen en millas cúbicas.

CubicMillimeter

string

Unidad de volumen en milímetros cúbicos.

CubicYard

string

Unidad de volumen en patios cúbicos.

Cup

string

Unidad de volumen en tazas.

Decaliter

string

Unidad de volumen en descalificadores.

FluidDram

string

Unidad de volumen en drams fluidos.

FluidOunce

string

Unidad de volumen en onzas fluidas.

Gill

string

Unidad de volumen en gilles.

Hectoliter

string

Unidad de volumen en hectoliters.

Hogshead

string

Unidad de volumen en hogsheads.

Liter

string

Unidad de volumen en litros.

Milliliter

string

Unidad de volumen en mililitros.

Minim

string

Unidad de volumen en minim.

Peck

string

Unidad de volumen en cuellos.

Pinch

string

Unidad de volumen en pellizcos.

Pint

string

Unidad de volumen en pints.

Quart

string

Unidad de volumen en cuartos.

Tablespoon

string

Unidad de volumen en cucharadas.

Teaspoon

string

Unidad de volumen en cucharas.

Unspecified

string

Unidad de volumen no especificada.

WarningCodeValue

Define la lista de códigos de advertencia.

Nombre Tipo Description
DocumentTruncated

string

Advertencia truncada del documento

LongWordsInDocument

string

Palabras largas en la advertencia del documento

WeightMetadata

Representa el modelo de metadatos de entidad Weight ).

Nombre Tipo Description
metadataKind string:

WeightMetadata

Tipo de objeto Metadata de entidad.

unit

WeightUnit

Unidad de medida para el peso.

value

number

Valor numérico que indica el texto extraído.

WeightUnit

Unidad de medida de peso.

Nombre Tipo Description
Dram

string

Unidad de peso en drams

Gallon

string

Unidad de volumen en galones

Grain

string

Unidad de peso en granos

Gram

string

Unidad de peso en gramos

Kilogram

string

Unidad de peso en kilogramos

LongTonBritish

string

Unidad de peso en toneladas largas (británicas)

MetricTon

string

Unidad de peso en toneladas métricas

Milligram

string

Unidad de peso en miligramos

Ounce

string

Unidad de peso en onzas

PennyWeight

string

Unidad de peso en pennyweights

Pound

string

Unidad de peso en libras

ShortHundredWeightUS

string

Unidad de peso en cien pesos cortos (EE. UU.)

ShortTonUS

string

Unidad de peso en toneladas cortas (EE. UU.)

Stone

string

Unidad de peso en piedras

Ton

string

Unidad de peso en toneladas

Unspecified

string

Unidad de peso no especificada