Analyze Text Submit Job - Analyze Text Submit Job

Referencia

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Envía una colección de documentos de texto para su análisis. Especifica una o más tareas únicas que se van a ejecutar como operaciones de larga duración.

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

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 API que se usará para la operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
analysisInput	True	MultiLanguageAnalysisInput	Contiene la entrada que se va a analizar.
tasks	True	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	Lista de tareas que se van a realizar como parte del LRO.
displayName		string	Nombre de la tarea.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Respuesta de error inesperada. Headers x-ms-error-code: string

Nombre

Tipo

Description

202 Accepted

La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Respuesta de error inesperada.

Headers

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Ejemplos

SuccessfulAbstractiveSummarizationTaskSubmit

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

SuccessfulAbstractiveSummarizationTaskSubmit

Sample Request

HTTP

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


{
  "displayName": "Document Abstractive Summarization Task Example",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."
      }
    ]
  },
  "tasks": [
    {
      "kind": "AbstractiveSummarization",
      "taskName": "Document Abstractive Summarization Task 1",
      "parameters": {
        "sentenceCount": 1
      }
    }
  ]
}

Sample Response

Status code:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-01

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

Sample Request

HTTP

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


{
  "displayName": "Extracting Location & US Region",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "I had a wonderful trip to Seattle last week."
      },
      {
        "id": "2",
        "language": "en",
        "text": "I'm flying to NYC tomorrow. See you there."
      }
    ]
  },
  "tasks": [
    {
      "kind": "EntityRecognition",
      "taskName": "Recognize Entities",
      "parameters": {
        "modelVersion": "latest"
      }
    },
    {
      "kind": "CustomEntityRecognition",
      "taskName": "Recognize US Regions",
      "parameters": {
        "projectName": "MyProject",
        "deploymentName": "MyDeployment"
      }
    }
  ]
}

Sample Response

Status code:: 202

Operation-Location: {endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-01

Definiciones

Nombre	Description
AbstractiveSummarizationLROTask	Objeto que representa la definición de tarea de una tarea Resumen abstracto.
AbstractiveSummarizationTaskParameters	Parámetros admitidos para la tarea pregenerada Resumen abstracto.
AnalyzeTextJobsInput	Objeto de entrada para el LRO de análisis de texto.
AnalyzeTextLROTaskKind	Tipo de las tareas de análisis de texto de larga duración admitidas.
CustomEntitiesLROTask	Contiene la tarea LRO de texto personalizado.
CustomEntitiesTaskParameters	Parámetros admitidos para una tarea Entidades personalizadas.
CustomMultiLabelClassificationLROTask	Uso de modelos personalizados para clasificar texto en taxonomía de varias etiquetas
CustomMultiLabelClassificationTaskParameters	Parámetros admitidos para una tarea Clasificación múltiple personalizada.
CustomSingleLabelClassificationLROTask	Uso de modelos personalizados para clasificar texto en taxonomía de una sola etiqueta
CustomSingleLabelClassificationTaskParameters	Parámetros admitidos para una tarea clasificación única personalizada.
EntitiesLROTask	Objeto que representa la definición de tarea de una tarea Reconocimiento de entidades.
EntitiesTaskParameters	Parámetros admitidos para una tarea de reconocimiento de entidades.
EntityLinkingLROTask	Contiene la tarea LRO de vinculación de entidad de análisis de texto.
EntityLinkingTaskParameters	Parámetros admitidos para una tarea De vinculación de entidades.
Error	Objeto de respuesta de error devuelto cuando el servicio encuentra algunos errores durante el procesamiento de la solicitud.
ErrorCode	Código de error legible.
ErrorResponse	Respuesta de error.
ExtractiveSummarizationLROTask	Objeto que representa la definición de tarea para una tarea De resumen extractivo.
ExtractiveSummarizationSortingCriteria	Especifica cómo ordenar los resúmenes extraídos.
ExtractiveSummarizationTaskParameters	Parámetros admitidos para una tarea De resumen extractivo.
HealthcareLROTask	Tarea de larga duración que va a realizar el servicio en los documentos de entrada de atención sanitaria.
HealthcareTaskParameters	Parámetros admitidos para una tarea de atención sanitaria.
InnerErrorCode	Código de error legible.
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.
KeyPhraseLROTask	Objeto que representa la definición de tarea de una tarea Extracción de frases clave.
KeyPhraseTaskParameters	Parámetros admitidos para una tarea extracción de frases clave.
MultiLanguageAnalysisInput	Colección de documentos de entrada que el servicio va a analizar.
MultiLanguageInput	Contiene un documento de entrada que el servicio va a analizar.
PiiCategory	(Opcional) describe las categorías de PII que se van a devolver.
PiiDomain	Dominio para la tarea PII
PiiLROTask	Contiene la tarea LRO piIEntityRecognition de texto de análisis.
PiiTaskParameters	Parámetros admitidos para una tarea de reconocimiento de entidades de PII.
SentimentAnalysisLROTask	Objeto que representa la definición de tarea de una tarea Análisis de sentimiento.
SentimentAnalysisTaskParameters	Parámetros admitidos para una tarea Análisis de sentimiento.
StringIndexType	Tipo de índice de cadena

AbstractiveSummarizationLROTask

Objeto que representa la definición de tarea de una tarea Resumen abstracto.

Nombre	Tipo	Description
kind	string: AbstractiveSummarization	Tipo de tarea que se va a realizar.
parameters	AbstractiveSummarizationTaskParameters	Parámetros de la tarea Resumen abstracto.
taskName	string	nombre de la tarea

AbstractiveSummarizationTaskParameters

Parámetros admitidos para la tarea pregenerada Resumen abstracto.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	no participar en el registro
modelVersion	string	latest	versión del modelo
sentenceCount	integer		Controla el número aproximado de oraciones en los resúmenes de salida.
stringIndexType	StringIndexType	TextElements_v8	Tipo de índice de cadena

AnalyzeTextJobsInput

Objeto de entrada para el LRO de análisis de texto.

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contiene la entrada que se va a analizar.
displayName	string	Nombre de la tarea.
tasks	AnalyzeTextLROTask[]: AbstractiveSummarizationLROTask[] CustomEntitiesLROTask[] CustomMultiLabelClassificationLROTask[] CustomSingleLabelClassificationLROTask[] EntitiesLROTask[] EntityLinkingLROTask[] ExtractiveSummarizationLROTask[] HealthcareLROTask[] KeyPhraseLROTask[] PiiLROTask[] SentimentAnalysisLROTask[]	Lista de tareas que se van a realizar como parte del LRO.

AnalyzeTextLROTaskKind

Tipo de las tareas de análisis de texto de larga duración admitidas.

Nombre	Tipo	Description
AbstractiveSummarization	string	Tarea de resumen abstracto
CustomEntityRecognition	string	Tarea de reconocimiento de entidades personalizadas
CustomMultiLabelClassification	string	Tarea personalizada de clasificación de varias etiquetas
CustomSingleLabelClassification	string	Tarea personalizada de clasificación de etiquetas únicas
EntityLinking	string	Tarea de vinculación de entidades
EntityRecognition	string	Tarea de reconocimiento de entidades
ExtractiveSummarization	string	Tarea de resumen extractivo
Healthcare	string	Tarea de atención sanitaria
KeyPhraseExtraction	string	Tarea de extracción de frases clave
PiiEntityRecognition	string	Tarea de reconocimiento de entidades PII
SentimentAnalysis	string	Tarea de análisis de sentimiento

CustomEntitiesLROTask

Contiene la tarea LRO de texto personalizado.

Nombre	Tipo	Description
kind	string: CustomEntityRecognition	Tipo de tarea que se va a realizar.
parameters	CustomEntitiesTaskParameters	parámetros de tarea.
taskName	string	nombre de la tarea

CustomEntitiesTaskParameters

Parámetros admitidos para una tarea Entidades personalizadas.

Nombre	Tipo	Valor predeterminado	Description
deploymentName	string		Este campo indica el nombre de implementación del modelo.
loggingOptOut	boolean	False	no participar en el registro
projectName	string		Este campo indica el nombre del proyecto para el 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).

CustomMultiLabelClassificationLROTask

Uso de modelos personalizados para clasificar texto en taxonomía de varias etiquetas

Nombre	Tipo	Description
kind	string: CustomMultiLabelClassification	Tipo de tarea que se va a realizar.
parameters	CustomMultiLabelClassificationTaskParameters	Parámetros de tarea.
taskName	string	nombre de la tarea

CustomMultiLabelClassificationTaskParameters

Parámetros admitidos para una tarea Clasificación múltiple personalizada.

Nombre	Tipo	Valor predeterminado	Description
deploymentName	string		Este campo indica el nombre de implementación del modelo.
loggingOptOut	boolean	False	no participar en el registro
projectName	string		Este campo indica el nombre del proyecto para el modelo.

CustomSingleLabelClassificationLROTask

Uso de modelos personalizados para clasificar texto en taxonomía de una sola etiqueta

Nombre	Tipo	Description
kind	string: CustomSingleLabelClassification	Tipo de tarea que se va a realizar.
parameters	CustomSingleLabelClassificationTaskParameters	Parámetros de tareas
taskName	string	nombre de la tarea

CustomSingleLabelClassificationTaskParameters

Parámetros admitidos para una tarea clasificación única personalizada.

Nombre	Tipo	Valor predeterminado	Description
deploymentName	string		Este campo indica el nombre de implementación del modelo.
loggingOptOut	boolean	False	no participar en el registro
projectName	string		Este campo indica el nombre del proyecto para el modelo.

EntitiesLROTask

Objeto que representa la definición de tarea de una tarea Reconocimiento de entidades.

Nombre	Tipo	Description
kind	string: EntityRecognition	Tipo de tarea que se va a realizar.
parameters	EntitiesTaskParameters	Parámetros de tarea.
taskName	string	nombre de la tarea

EntitiesTaskParameters

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

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	no participar en el registro
modelVersion	string	latest	versión del modelo
stringIndexType	StringIndexType	TextElements_v8	(Opcional) parámetro para proporcionar el tipo de índice de cadena utilizado para interpretar los desplazamientos de cadena. El valor predeterminado es TextElements (Graphemes).

EntityLinkingLROTask

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

Nombre	Tipo	Description
kind	string: EntityLinking	Tipo de tarea que se va a realizar.
parameters	EntityLinkingTaskParameters	Parámetros de tarea.
taskName	string	nombre de la tarea

EntityLinkingTaskParameters

Parámetros admitidos para una tarea De vinculación de entidades.

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).

Error

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 los conjuntos de códigos de error definidos por el servidor.
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.

Nombre	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string	error de Azure Cognitive Search límite de índice alcanzado
AzureCognitiveSearchIndexNotFound	string	error de Azure Cognitive Search índice no encontrado
AzureCognitiveSearchNotFound	string	Azure Cognitive Search error no encontrado
AzureCognitiveSearchThrottling	string	Azure Cognitive Search error de limitación
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 encontrada
ProjectNotFound	string	Error de proyecto no encontrado
QuotaExceeded	string	Cuota de errores 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.

ExtractiveSummarizationLROTask

Objeto que representa la definición de tarea para una tarea De resumen extractivo.

Nombre	Tipo	Description
kind	string: ExtractiveSummarization	Tipo de tarea que se va a realizar.
parameters	ExtractiveSummarizationTaskParameters	Parámetros de la tarea Resumen extractivo.
taskName	string	nombre de la tarea

ExtractiveSummarizationSortingCriteria

Especifica cómo ordenar los resúmenes extraídos.

Nombre	Tipo	Description
Offset	string	Indica que los resultados deben ordenarse en orden de apariencia en el texto.
Rank	string	Indica que los resultados deben ordenarse en orden de importancia (es decir, puntuación de clasificación) según el modelo.

ExtractiveSummarizationTaskParameters

Parámetros admitidos para una tarea De resumen extractivo.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	no participar en el registro
modelVersion	string	latest	versión del modelo
sentenceCount	integer	3	Especifica el número de oraciones del resumen extraído.
sortBy	ExtractiveSummarizationSortingCriteria	Offset	Especifica cómo ordenar los resúmenes extraídos.
stringIndexType	StringIndexType	TextElements_v8	Especifica el método utilizado para interpretar los desplazamientos de cadena.

HealthcareLROTask

Tarea de larga duración que va a realizar el servicio en los documentos de entrada de atención sanitaria.

Nombre	Tipo	Description
kind	string: Healthcare	Tipo de tarea que se va a realizar.
parameters	HealthcareTaskParameters	Parámetros de la tarea Healthcare.
taskName	string	nombre de la tarea

HealthcareTaskParameters

Parámetros admitidos para una tarea de atención sanitaria.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	no participar en el registro
modelVersion	string	latest	versión del modelo
stringIndexType	StringIndexType	TextElements_v8	Especifica el método utilizado para interpretar los desplazamientos de cadena.

InnerErrorCode

Código de error legible.

Nombre	Tipo	Description
AzureCognitiveSearchNotFound	string	Azure Cognitive Search error no encontrado
AzureCognitiveSearchThrottling	string	Azure Cognitive Search error de limitación
EmptyRequest	string	Error de solicitud vacía
ExtractionFailure	string	Error de 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 por lotes de documentos 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 la 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 los conjuntos de códigos de error definidos por el servidor.
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.

KeyPhraseLROTask

Objeto que representa la definición de tarea de una tarea Extracción de frases clave.

Nombre	Tipo	Description
kind	string: KeyPhraseExtraction	Tipo de tarea que se va a realizar.
parameters	KeyPhraseTaskParameters	Parámetros de la tarea de extracción de frases clave.
taskName	string	nombre de la tarea

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

MultiLanguageAnalysisInput

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

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. (Solo se aplica a 2023-04-15-preview y versiones posteriores) Para 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.

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	AT Tax Identification Number
ATValueAddedTaxNumber	string	Número fiscal de AT Value Added
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 au
AUTaxFileNumber	string	Número de archivo fiscal au
Address	string	Dirección
Age	string	Age
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	SAS de Azure
AzureServiceBusString	string	cadena de Azure Service Bus
AzureStorageAccountGeneric	string	Genérico de la cuenta de Azure Storage
AzureStorageAccountKey	string	Clave de la 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 de conducir de CA
CAHealthServiceNumber	string	Número de 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 seguridad social de CH
CLIdentityCardNumber	string	Número de tarjeta de identidad de 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 la 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
DETaxIdentificationNumber	string	Número de identificación fiscal DE
DEValueAddedNumber	string	Número agregado de valor de DE
DKPersonalIdentificationNumber	string	Número de identificación personal de DK
DKPersonalIdentificationV2	string	Identificación personal de DK V2
Date	string	Fecha
Default	string	Categorías de PII predeterminadas para el idioma.
DrugEnforcementAgencyNumber	string	Número de agencia de cumplimiento 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 permiso 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 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 de salud de FR
FRNationalID	string	Id. nacional de FR
FRPassportNumber	string	Número de pasaporte de FR
FRSocialSecurityNumber	string	Número de seguro 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	Id. nacional de GR 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	Número OIB de identificación personal de RR. HH. V2
HUPersonalIdentificationNumber	string	Número de identificación personal de 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 de valor añadido 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 Mi número 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	Número de seguro social jp
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 de MT
MTTaxIDNumber	string	Número de identificación fiscal de 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 de impuesto de valor añadido 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	Person
PhoneNumber	string	Número de teléfono
ROPersonalNumericalCode	string	Código numérico personal de RO
RUPassportNumberDomestic	string	Número de pasaporte de RU nacional
RUPassportNumberInternational	string	Número de pasaporte ru internacional
SANationalID	string	Id. nacional de SA
SENationalID	string	SE National ID
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Número de pasaporte se
SETaxIdentificationNumber	string	Número de identificación fiscal SE
SGNationalRegistrationIdentityCardNumber	string	Número de tarjeta de identidad del registro nacional de SG
SITaxIdentificationNumber	string	Número de identificación fiscal de SI
SIUniqueMasterCitizenNumber	string	Número 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	TR National Identification Number
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 de salud nacional del Reino Unido
UKNationalInsuranceNumber	string	Número de seguro nacional del Reino Unido
UKUniqueTaxpayerNumber	string	Número de contribuyente único 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 de contribuyentes individuales 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.

PiiLROTask

Contiene la tarea LRO piIEntityRecognition de texto de análisis.

Nombre	Tipo	Description
kind	string: PiiEntityRecognition	Tipo de tarea que se va a realizar.
parameters	PiiTaskParameters	Parámetros de la tarea Pii.
taskName	string	nombre de la tarea

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 devolverán en la respuesta.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType que se va a usar para el análisis.

SentimentAnalysisLROTask

Objeto que representa la definición de tarea de una tarea Análisis de sentimiento.

Nombre	Tipo	Description
kind	string: SentimentAnalysis	Tipo de tarea que se va a realizar.
parameters	SentimentAnalysisTaskParameters	Parámetros de la tarea Análisis de sentimiento.
taskName	string	nombre de la tarea

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.

StringIndexType

Tipo de índice de cadena

Nombre	Tipo	Description
TextElements_v8	string	Los valores de desplazamiento y longitud devueltos corresponden a TextElements (clústeres de Graphemes y Grapheme) que confirman al 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 corresponderán 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 se corresponden con 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.

Compartir a través de

Analyze Text Submit Job - Analyze Text Submit Job

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

SuccessfulAbstractiveSummarizationTaskSubmit

Sample Request

Sample Response

SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest

Sample Request

Sample Response

Definiciones

AbstractiveSummarizationLROTask

AbstractiveSummarizationTaskParameters

AnalyzeTextJobsInput

AnalyzeTextLROTaskKind

CustomEntitiesLROTask

CustomEntitiesTaskParameters

CustomMultiLabelClassificationLROTask

CustomMultiLabelClassificationTaskParameters

CustomSingleLabelClassificationLROTask

CustomSingleLabelClassificationTaskParameters

EntitiesLROTask

EntitiesTaskParameters

EntityLinkingLROTask

EntityLinkingTaskParameters

Error

ErrorCode

ErrorResponse

ExtractiveSummarizationLROTask

ExtractiveSummarizationSortingCriteria

ExtractiveSummarizationTaskParameters

HealthcareLROTask

HealthcareTaskParameters

InnerErrorCode

InnerErrorModel

KeyPhraseLROTask

KeyPhraseTaskParameters

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategory

PiiDomain

PiiLROTask

PiiTaskParameters

SentimentAnalysisLROTask

SentimentAnalysisTaskParameters

StringIndexType

Recursos adicionales