Skillsets - Get
Recupera un conjunto de aptitudes en un servicio de búsqueda.
GET {endpoint}/skillsets('{skillsetName}')?api-version=2025-08-01-preview
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
La dirección URL del punto de conexión del servicio de búsqueda. |
|
skillset
|
path | True |
string |
El nombre del conjunto de aptitudes que se va a recuperar. |
|
api-version
|
query | True |
string |
Versión de la API del cliente. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
El identificador de seguimiento enviado con la solicitud para ayudar con la depuración. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
El conjunto de aptitudes se devuelve correctamente. |
|
| Other Status Codes |
Respuesta de error. |
Ejemplos
SearchServiceGetSkillset
Solicitud de ejemplo
GET https://previewexampleservice.search.windows.net/skillsets('myskillset')?api-version=2025-08-01-preview
Respuesta de muestra
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "myskillset",
"description": "Skillset for extracting entities and more",
"skills": [
{
"@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
"name": "skill2",
"context": "/document",
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "countryHint",
"source": "/document/countryHint",
"inputs": []
}
],
"outputs": [
{
"name": "languageCode",
"targetName": "languageCode"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Text.SplitSkill",
"name": "skill3",
"context": "/document",
"defaultLanguageCode": "en",
"textSplitMode": "pages",
"maximumPageLength": 4000,
"pageOverlapLength": 0,
"maximumPagesToTake": 0,
"unit": "azureOpenAITokens",
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "languageCode",
"source": "/document/languageCode",
"inputs": []
}
],
"outputs": [
{
"name": "textItems",
"targetName": "pages"
}
],
"azureOpenAITokenizerParameters": {
"encoderModelName": "cl100k_base",
"allowedSpecialTokens": [
"[START]",
"[END]"
]
}
},
{
"@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
"name": "skill4",
"context": "/document/pages/*",
"defaultLanguageCode": "en",
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "languageCode",
"source": "/document/languageCode",
"inputs": []
}
],
"outputs": [
{
"name": "keyPhrases",
"targetName": "keyPhrases"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
"name": "skill5",
"context": "/document",
"uri": "https://contoso.example.org/",
"httpMethod": "POST",
"timeout": "PT5S",
"batchSize": 1000,
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "languageCode",
"source": "/document/languageCode",
"inputs": []
}
],
"outputs": [
{
"name": "customresult",
"targetName": "result"
}
],
"httpHeaders": {}
},
{
"@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
"name": "docIntelligenceLayoutSkill",
"context": "/document",
"outputMode": "oneToMany",
"markdownHeaderDepth": "h3",
"outputFormat": "markdown",
"extractionOptions": [],
"inputs": [
{
"name": "file_data",
"source": "/document/content",
"inputs": []
}
],
"outputs": [
{
"name": "markdown_document",
"targetName": "markdown_document"
}
]
},
{
"@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
"name": "docIntelligenceLayoutSkill#2",
"context": "/document",
"outputMode": "oneToMany",
"outputFormat": "text",
"extractionOptions": [
"images",
"locationMetadata"
],
"inputs": [
{
"name": "file_data",
"source": "/document/content",
"inputs": []
}
],
"outputs": [
{
"name": "text_sections",
"targetName": "text_sections"
},
{
"name": "normalized_images",
"targetName": "normalized_images"
}
],
"chunkingProperties": {
"unit": "characters",
"maximumLength": 500,
"overlapLength": 50
}
},
{
"@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
"name": "chatCompletionSkill",
"context": "/document/normalized_images/*",
"uri": "https://azs-grok-aoai.openai.azure.com/openai/deployments/azs-grok-gpt-4o/chat/completions",
"httpMethod": "POST",
"timeout": "PT30S",
"batchSize": 1,
"degreeOfParallelism": 5,
"apiKey": "<redacted>",
"extraParametersBehavior": "error",
"inputs": [
{
"name": "text",
"source": "/document/content",
"inputs": []
},
{
"name": "systemMessage",
"source": "/document/system_message",
"inputs": []
},
{
"name": "userMessage",
"source": "/document/user_message",
"inputs": []
},
{
"name": "image",
"source": "/document/normalized_images/*",
"inputs": []
},
{
"name": "imageDetail",
"source": "/document/detail",
"inputs": []
}
],
"outputs": [
{
"name": "response",
"targetName": "response"
}
],
"httpHeaders": {},
"commonModelParameters": {
"model": "gpt-4o",
"frequencyPenalty": 0,
"presencePenalty": 0,
"maxTokens": 0,
"temperature": 0,
"seed": 0,
"stop": []
},
"extraParameters": {
"safe_mode": true
},
"responseFormat": {
"type": "jsonSchema",
"jsonSchemaProperties": {
"name": "Some Name",
"description": "Some Description",
"strict": true,
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"steps",
"answer"
],
"properties": "{\"steps\": {\"type\": \"array\", \"description\": \"A list of reasoning steps.\", \"items\": {\"type\": \"string\"}}, \"answer\": {\"type\": \"string\", \"description\": \"The final answer.\"}}"
}
}
}
}
]
}
Definiciones
| Nombre | Description |
|---|---|
|
AIServices |
Cuenta de varias regiones de un recurso de Azure AI Service asociado a un conjunto de aptitudes. |
|
AIServices |
Clave de cuenta de un recurso de Azure AI Service asociado a un conjunto de aptitudes, que se usará con el subdominio del recurso. |
|
Aml |
La aptitud AML permite ampliar el enriquecimiento de IA con un modelo personalizado de Azure Machine Learning (AML). Una vez que se entrena e implementa un modelo AML, una habilidad AML lo integra en el enriquecimiento de IA. |
|
Azure |
Credenciales de una aplicación registrada creada para el servicio de búsqueda, usadas para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault. |
|
Azure |
Permite generar una inserción vectorial para una entrada de texto determinada mediante el recurso de Azure OpenAI. |
|
Azure |
Nombre del modelo de Azure Open AI al que se llamará. |
|
Azure |
|
|
Chat |
Parámetros comunes del modelo de lenguaje para las finalizaciones de chat. Si se omite, se utilizan los valores predeterminados. |
|
Chat |
Especifica cómo Azure AI Foundry debe controlar "extraParameters". El valor predeterminado es 'error'. |
|
Chat |
Determina cómo se debe serializar la respuesta del modelo de lenguaje. El valor predeterminado es 'texto'. |
|
Chat |
Especifica cómo el LLM debe dar formato a la respuesta. Valores posibles: 'text' (cadena sin formato), 'json_object' (JSON arbitrario) o 'json_schema' (se adhiere al esquema proporcionado). |
|
Chat |
Objeto que define el esquema personalizado que usará el modelo para estructurar su salida. |
|
Chat |
Una aptitud que llama a un modelo de lenguaje a través del punto de conexión de finalización de chat de Azure AI Foundry. |
|
Cognitive |
Clave de cuenta de varias regiones de un recurso de Azure AI Service asociado a un conjunto de aptitudes. |
|
Conditional |
Una aptitud que permite escenarios que requieren una operación booleana para determinar los datos que se van a asignar a una salida. |
|
Custom |
Objeto que contiene información sobre las coincidencias encontradas y los metadatos relacionados. |
|
Custom |
Un objeto complejo que se puede usar para especificar ortografías alternativas o sinónimos al nombre de la entidad raíz. |
|
Custom |
Una aptitud busca texto de una lista personalizada de palabras y frases definida por el usuario. |
|
Custom |
Los códigos de idioma admitidos para el texto de entrada por CustomEntityLookupSkill. |
|
Default |
Objeto vacío que representa el recurso predeterminado del servicio Azure AI para un conjunto de aptitudes. |
|
Document |
Aptitud que extrae contenido de un archivo dentro de la canalización de enriquecimiento. |
|
Document |
Una aptitud que extrae información de contenido y diseño, a través de Azure AI Services, de los archivos de la canalización de enriquecimiento. |
|
Document |
Controla la cardinalidad para fragmentar el contenido. |
|
Document |
Controla la cardinalidad de la unidad de fragmentos. El valor predeterminado es 'personajes' |
|
Document |
Controla la cardinalidad del contenido extraído del documento por la aptitud. |
|
Document |
La profundidad de los encabezados en la salida de Markdown. El valor predeterminado es h6. |
|
Document |
Controla la cardinalidad del formato de salida. El valor predeterminado es 'markdown'. |
|
Document |
Controla la cardinalidad de la salida producida por la aptitud. El valor predeterminado es 'oneToMany'. |
|
Entity |
Una cadena que indica qué categorías de entidad devolver. |
|
Entity |
Con la API de Text Analytics, extrae entidades vinculadas del texto. |
|
Entity |
Esta habilidad está obsoleta. Utilice el V3. EntityRecognitionSkill en su lugar. |
|
Entity |
Deprecated. Los códigos de idioma admitidos para el texto de entrada por EntityRecognitionSkill. |
|
Entity |
Con la API de Text Analytics, extrae entidades de diferentes tipos del texto. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta de error |
|
Image |
Una aptitud que analiza archivos de imagen. Extrae un amplio conjunto de características visuales basadas en el contenido de la imagen. |
|
Image |
Los códigos de idioma admitidos para la entrada de ImageAnalysisSkill. |
|
Image |
Una cadena que indica qué detalles específicos del dominio se van a devolver. |
|
Index |
Define el comportamiento de las proyecciones de índice en relación con el resto del indexador. |
|
Input |
Asignación de campos de entrada para una aptitud. |
|
Json |
Diccionario abierto para propiedades extendidas. Obligatorio si 'type' == 'json_schema' |
|
Key |
Una aptitud que utiliza el análisis de texto para la extracción de frases clave. |
|
Key |
Los códigos de idioma admitidos para el texto de entrada por KeyPhraseExtractionSkill. |
|
Language |
Una aptitud que detecta el idioma del texto de entrada e informa de un único código de idioma para cada documento enviado en la solicitud. El código de idioma se combina con una puntuación que indica la confianza del análisis. |
|
Line |
Define la secuencia de caracteres que se utilizarán entre las líneas de texto reconocidas por la aptitud de OCR. El valor predeterminado es "espacio". |
|
Merge |
Una habilidad para fusionar dos o más cadenas en una sola cadena unificada, con un delimitador opcional definido por el usuario que separa cada parte componente. |
|
Ocr |
Una aptitud que extrae texto de archivos de imagen. |
|
Ocr |
Los códigos de idioma admitidos para la entrada de OcrSkill. |
|
Output |
Asignación de campos de salida para una aptitud. |
|
PIIDetection |
Con la API de Text Analytics, extrae información personal de un texto de entrada y le da la opción de enmascararlo. |
|
PIIDetection |
Una cadena que indica qué maskingMode usar para enmascarar la información personal detectada en el texto de entrada. |
|
Search |
Borra la propiedad de identidad de un origen de datos. |
|
Search |
Especifica la identidad de un origen de datos que se va a utilizar. |
|
Search |
Definición de proyecciones adicionales a índices de búsqueda secundarios. |
|
Search |
Descripción de los datos que se van a almacenar en el índice de búsqueda designado. |
|
Search |
Diccionario de propiedades de configuración específicas de proyección de índice. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo. |
|
Search |
Definición de proyecciones adicionales en blobs, tablas o archivos de Azure de datos enriquecidos. |
|
Search |
Definición de proyección de los datos que se van a almacenar en Azure Files. |
|
Search |
Definición de proyección de los datos que se van a almacenar en Azure Blob. |
|
Search |
Diccionario de propiedades de configuración específicas del almacén de conocimiento. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo. |
|
Search |
Objeto contenedor para varios selectores de proyección. |
|
Search |
Descripción de los datos que se van a almacenar en Azure Tables. |
|
Search |
Una lista de habilidades. |
|
Search |
Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos. |
|
Sentiment |
Esta habilidad está obsoleta. Utilice el V3. SentimentSkill en su lugar. |
|
Sentiment |
Deprecated. Los códigos de idioma admitidos para el texto de entrada por SentimentSkill. |
|
Sentiment |
Con la API de Text Analytics, evalúa el texto no estructurado y, para cada registro, proporciona etiquetas de opinión (como "negativo", "neutro" y "positivo") en función de la puntuación de confianza más alta encontrada por el servicio en un nivel de oración y documento. |
|
Shaper |
Una habilidad para remodelar los resultados. Crea un tipo complejo para admitir campos compuestos (también conocidos como campos multiparte). |
|
Split |
Una habilidad para dividir una cadena en trozos de texto. |
|
Split |
Solo se aplica si la unidad está establecida en azureOpenAITokens. Las opciones incluyen 'R50k_base', 'P50k_base', 'P50k_edit' y 'CL100k_base'. El valor predeterminado es 'CL100k_base'. |
|
Split |
Los códigos de idioma admitidos para el texto de entrada por SplitSkill. |
|
Split |
Un valor que indica qué unidad usar. |
|
Text |
Un valor que indica qué modo de división realizar. |
|
Text |
Una habilidad para traducir texto de un idioma a otro. |
|
Text |
Los códigos de idioma admitidos para el texto de entrada por TextTranslationSkill. |
|
Vision |
Permite generar una inserción vectorial para una entrada de imagen o texto determinada mediante la API de vectorización de visión de Azure AI Services. |
|
Visual |
Las cadenas que indican qué tipos de características visuales se van a devolver. |
|
Web |
Una aptitud que puede llamar a un punto de conexión de API web, lo que le permite ampliar un conjunto de aptitudes haciendo que llame al código personalizado. |
AIServicesAccountIdentity
Cuenta de varias regiones de un recurso de Azure AI Service asociado a un conjunto de aptitudes.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de recurso de Azure AI Service asociado a un conjunto de aptitudes. |
| description |
string |
Descripción del recurso de servicio Azure AI asociado a un conjunto de aptitudes. |
| identity | SearchIndexerDataIdentity: |
La identidad administrada asignada por el usuario que se usa para las conexiones a AI Service. Si no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del conjunto de aptitudes, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad. |
| subdomainUrl |
string |
La URL del subdominio para el servicio de IA correspondiente. |
AIServicesAccountKey
Clave de cuenta de un recurso de Azure AI Service asociado a un conjunto de aptitudes, que se usará con el subdominio del recurso.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de recurso de Azure AI Service asociado a un conjunto de aptitudes. |
| description |
string |
Descripción del recurso de servicio Azure AI asociado a un conjunto de aptitudes. |
| key |
string |
Clave usada para aprovisionar el recurso de Azure AI Service asociado a un conjunto de aptitudes. |
| subdomainUrl |
string |
La URL del subdominio para el servicio de IA correspondiente. |
AmlSkill
La aptitud AML permite ampliar el enriquecimiento de IA con un modelo personalizado de Azure Machine Learning (AML). Una vez que se entrena e implementa un modelo AML, una habilidad AML lo integra en el enriquecimiento de IA.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| degreeOfParallelism |
integer (int32) |
(Opcional) Cuando se especifica, indica el número de llamadas que el indexador realizará en paralelo al punto de conexión que ha proporcionado. Puede disminuir este valor si el punto de conexión produce un error con una carga de solicitudes demasiado alta o aumentarlo si el punto de conexión puede aceptar más solicitudes y desea aumentar el rendimiento del indexador. Si no se establece, se utiliza un valor predeterminado de 5. El degreeOfParallelism se puede establecer en un máximo de 10 y un mínimo de 1. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| key |
string |
(Necesario para la autenticación de claves) La clave para el servicio AML. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| region |
string |
(Opcional para la autenticación de tokens). La región en la que se implementa el servicio AML. |
| resourceId |
string |
(Necesario para la autenticación de tokens). El identificador de recurso de Azure Resource Manager del servicio AML. Debe tener el formato subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. |
| timeout |
string (duration) |
(Opcional) Cuando se especifica, indica el tiempo de espera para el cliente http que realiza la llamada API. |
| uri |
string (uri) |
(Necesario para la autenticación sin clave o sin autenticación) El URI de puntuación del servicio AML al que se enviará la carga JSON. Solo se permite el esquema de URI https. |
AzureActiveDirectoryApplicationCredentials
Credenciales de una aplicación registrada creada para el servicio de búsqueda, usadas para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault.
| Nombre | Tipo | Description |
|---|---|---|
| applicationId |
string |
Un identificador de aplicación de AAD al que se concedieron los permisos de acceso necesarios a Azure Key Vault que se usará al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el identificador de objeto de la aplicación de AAD. |
| applicationSecret |
string |
Clave de autenticación de la aplicación de AAD especificada. |
AzureOpenAIEmbeddingSkill
Permite generar una inserción vectorial para una entrada de texto determinada mediante el recurso de Azure OpenAI.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| apiKey |
string |
Clave de API del recurso de Azure OpenAI designado. |
| authIdentity | SearchIndexerDataIdentity: |
La identidad administrada asignada por el usuario que se usa para las conexiones salientes. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| deploymentId |
string |
Identificador de la implementación del modelo de Azure OpenAI en el recurso designado. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| dimensions |
integer (int32) |
Número de dimensiones que deben tener las incrustaciones de salida resultantes. Solo se admite en text-embedding-3 y modelos posteriores. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| modelName |
Nombre del modelo de incrustación que se implementa en la ruta deploymentId proporcionada. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| resourceUri |
string (uri) |
URI del recurso de Azure OpenAI. |
AzureOpenAIModelName
Nombre del modelo de Azure Open AI al que se llamará.
| Valor | Description |
|---|---|
| text-embedding-ada-002 | |
| text-embedding-3-large | |
| text-embedding-3-small | |
| gpt-4o | |
| gpt-4o-mini | |
| gpt-4.1 | |
| gpt-4.1-mini | |
| gpt-4.1-nano |
AzureOpenAITokenizerParameters
| Nombre | Tipo | Description |
|---|---|---|
| allowedSpecialTokens |
string[] |
(Opcional) Solo se aplica si la unidad está establecida en azureOpenAITokens. Este parámetro define una colección de tokens especiales que se permiten dentro del proceso de tokenización. |
| encoderModelName |
Solo se aplica si la unidad está establecida en azureOpenAITokens. Las opciones incluyen 'R50k_base', 'P50k_base', 'P50k_edit' y 'CL100k_base'. El valor predeterminado es 'CL100k_base'. |
ChatCompletionCommonModelParameters
Parámetros comunes del modelo de lenguaje para las finalizaciones de chat. Si se omite, se utilizan los valores predeterminados.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| frequencyPenalty |
number |
0 |
Un float en el rango [-2,2] que reduce o aumenta la probabilidad de tokens repetidos. El valor predeterminado es 0. |
| maxTokens |
integer (int32) |
Número máximo de tokens a generar. |
|
| model |
string |
El nombre del modelo que se va a utilizar (por ejemplo, 'gpt-4o', etc.). El valor predeterminado es null si no se especifica. |
|
| presencePenalty |
number |
0 |
Un float en el rango [-2,2] que penaliza a los nuevos tokens en función de su presencia existente. El valor predeterminado es 0. |
| seed |
integer (int32) |
Semilla aleatoria para controlar salidas deterministas. Si se omite, se utiliza la aleatorización. |
|
| stop |
string[] |
Lista de secuencias de parada que cortarán la generación de texto. El valor predeterminado es ninguno. |
|
| temperature |
number |
0.7 |
Temperatura de muestreo. El valor predeterminado es 0.7. |
ChatCompletionExtraParametersBehavior
Especifica cómo Azure AI Foundry debe controlar "extraParameters". El valor predeterminado es 'error'.
| Valor | Description |
|---|---|
| pass-through | |
| drop |
Elimina todos los parámetros adicionales. |
| error |
Genera un error si hay algún parámetro adicional. |
ChatCompletionResponseFormat
Determina cómo se debe serializar la respuesta del modelo de lenguaje. El valor predeterminado es 'texto'.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| jsonSchemaProperties |
Diccionario abierto para propiedades extendidas. Obligatorio si 'type' == 'json_schema' |
||
| type | text |
Especifica cómo el LLM debe dar formato a la respuesta. Valores posibles: 'text' (cadena sin formato), 'json_object' (JSON arbitrario) o 'json_schema' (se adhiere al esquema proporcionado). |
ChatCompletionResponseFormatType
Especifica cómo el LLM debe dar formato a la respuesta. Valores posibles: 'text' (cadena sin formato), 'json_object' (JSON arbitrario) o 'json_schema' (se adhiere al esquema proporcionado).
| Valor | Description |
|---|---|
| text | |
| jsonObject | |
| jsonSchema |
ChatCompletionSchema
Objeto que define el esquema personalizado que usará el modelo para estructurar su salida.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| additionalProperties |
boolean |
False |
Controla si se permite que un objeto contenga claves o valores adicionales que no se definieron en el esquema JSON. El valor predeterminado es False. |
| properties |
string |
Una cadena con formato JSON que define las propiedades y restricciones del esquema de salida para el modelo. |
|
| required |
string[] |
Matriz de los nombres de propiedad que deben formar parte de la respuesta del modelo. Todas las propiedades deben incluirse para las salidas estructuradas. |
|
| type |
string |
object |
Tipo de representación de esquema. Generalmente 'objeto'. El valor predeterminado es 'object'. |
ChatCompletionSkill
Una aptitud que llama a un modelo de lenguaje a través del punto de conexión de finalización de chat de Azure AI Foundry.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
|
| apiKey |
string |
Clave de API para autenticarse en el modelo. Tanto apiKey como authIdentity no se pueden especificar al mismo tiempo. |
|
| authIdentity | SearchIndexerDataIdentity: |
La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad. |
|
| authResourceId |
string |
Se aplica a las aptitudes personalizadas que se conectan a código externo en una función de Azure o alguna otra aplicación que proporcione las transformaciones. Este valor debe ser el identificador de aplicación creado para la función o aplicación cuando se registró en Azure Active Directory. Cuando se especifica, la aptitud personalizada se conecta a la función o aplicación mediante un identificador administrado (ya sea asignado por el sistema o por el usuario) del servicio de búsqueda y el token de acceso de la función o aplicación, utilizando este valor como identificador de recurso para crear el ámbito del token de acceso. |
|
| batchSize |
integer (int32) |
El tamaño de lote deseado que indica el número de documentos. |
|
| commonModelParameters |
Parámetros comunes del modelo de lenguaje que los clientes pueden modificar. Si se omite, se aplicarán los valores predeterminados razonables. |
||
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
|
| degreeOfParallelism |
integer (int32) |
Si se establece, el número de llamadas paralelas que se pueden realizar a la API web. |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
|
| extraParameters |
object |
Diccionario de tipo abierto para parámetros específicos del modelo que se deben anexar a la llamada de finalización de chat. Sigue el patrón de extensibilidad de Azure AI Foundry. |
|
| extraParametersBehavior | error |
Cómo controla Azure AI Foundry los parámetros adicionales. El valor predeterminado es 'error'. |
|
| httpHeaders |
object |
Los encabezados necesarios para realizar la solicitud http. |
|
| httpMethod |
string |
El método para la solicitud http. |
|
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
||
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
|
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
||
| responseFormat |
Determina cómo el LLM debe formatear su respuesta. El valor predeterminado es el tipo de respuesta 'texto'. |
||
| timeout |
string (duration) |
El tiempo de espera deseado para la solicitud. El valor predeterminado es 30 segundos. |
|
| uri |
string |
La dirección URL de la API web. |
CognitiveServicesAccountKey
Clave de cuenta de varias regiones de un recurso de Azure AI Service asociado a un conjunto de aptitudes.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de recurso de Azure AI Service asociado a un conjunto de aptitudes. |
| description |
string |
Descripción del recurso de servicio Azure AI asociado a un conjunto de aptitudes. |
| key |
string |
Clave usada para aprovisionar el recurso de Azure AI Service asociado a un conjunto de aptitudes. |
ConditionalSkill
Una aptitud que permite escenarios que requieren una operación booleana para determinar los datos que se van a asignar a una salida.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
CustomEntity
Objeto que contiene información sobre las coincidencias encontradas y los metadatos relacionados.
| Nombre | Tipo | Description |
|---|---|---|
| accentSensitive |
boolean |
El valor predeterminado es False. Valor booleano que indica si las comparaciones con el nombre de la entidad deben ser sensibles al acento. |
| aliases |
Matriz de objetos complejos que se pueden usar para especificar ortografías alternativas o sinónimos al nombre de la entidad raíz. |
|
| caseSensitive |
boolean |
El valor predeterminado es False. Valor booleano que indica si las comparaciones con el nombre de la entidad deben ser sensibles al uso de mayúsculas y minúsculas de caracteres. Las coincidencias de ejemplo que no distinguen entre mayúsculas y minúsculas de "Microsoft" podrían ser: microsoft, microSoft, MICROSOFT. |
| defaultAccentSensitive |
boolean |
Cambia el valor de sensibilidad de acento predeterminado para esta entidad. Se utiliza para cambiar el valor predeterminado de todos los valores de accentSensitive de alias. |
| defaultCaseSensitive |
boolean |
Cambia el valor predeterminado de distinción entre mayúsculas y minúsculas para esta entidad. Se puede utilizar para cambiar el valor predeterminado de todos los valores caseSensitive de alias. |
| defaultFuzzyEditDistance |
integer (int32) |
Cambia el valor predeterminado de distancia de edición aproximada para esta entidad. Se puede usar para cambiar el valor predeterminado de todos los valores de alias fuzzyEditDistance. |
| description |
string |
Este campo se puede utilizar como paso a través de metadatos personalizados sobre los textos coincidentes. El valor de este campo aparecerá con cada coincidencia de su entidad en la salida de la aptitud. |
| fuzzyEditDistance |
integer (int32) |
El valor predeterminado es 0. Valor máximo de 5. Indica el número aceptable de caracteres divergentes que aún constituirían una coincidencia con el nombre de la entidad. Se devuelve la menor confusión posible para cualquier coincidencia dada. Por ejemplo, si la distancia de edición se establece en 3, "Windows10" seguiría coincidiendo con "Windows", "Windows10" y "Windows 7". Cuando la distinción entre mayúsculas y minúsculas se establece en false, las diferencias entre mayúsculas y minúsculas NO cuentan para la tolerancia a la difusión, pero sí lo hacen. |
| id |
string |
Este campo se puede utilizar como paso a través de metadatos personalizados sobre los textos coincidentes. El valor de este campo aparecerá con cada coincidencia de su entidad en la salida de la aptitud. |
| name |
string |
El descriptor de entidad de nivel superior. Las coincidencias en la salida de la aptitud se agruparán por este nombre y debe representar la forma "normalizada" del texto que se encuentra. |
| subtype |
string |
Este campo se puede utilizar como paso a través de metadatos personalizados sobre los textos coincidentes. El valor de este campo aparecerá con cada coincidencia de su entidad en la salida de la aptitud. |
| type |
string |
Este campo se puede utilizar como paso a través de metadatos personalizados sobre los textos coincidentes. El valor de este campo aparecerá con cada coincidencia de su entidad en la salida de la aptitud. |
CustomEntityAlias
Un objeto complejo que se puede usar para especificar ortografías alternativas o sinónimos al nombre de la entidad raíz.
| Nombre | Tipo | Description |
|---|---|---|
| accentSensitive |
boolean |
Determine si el alias es sensible al acento. |
| caseSensitive |
boolean |
Determine si el alias distingue entre mayúsculas y minúsculas. |
| fuzzyEditDistance |
integer (int32) |
Determine la distancia de edición aproximada del alias. |
| text |
string |
El texto del alias. |
CustomEntityLookupSkill
Una aptitud busca texto de una lista personalizada de palabras y frases definida por el usuario.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| entitiesDefinitionUri |
string |
Ruta a un archivo JSON o CSV que contiene todo el texto de destino con el que se va a hacer coincidir. Esta definición de entidad se lee al principio de una ejecución del indexador. Las actualizaciones de este archivo durante una ejecución del indexador no surtirán efecto hasta las ejecuciones posteriores. Esta configuración debe ser accesible a través de HTTPS. |
| globalDefaultAccentSensitive |
boolean |
Una bandera global para AccentSensitive. Si AccentSensitive no está establecido en CustomEntity, este valor será el valor predeterminado. |
| globalDefaultCaseSensitive |
boolean |
Una marca global para CaseSensitive. Si CaseSensitive no se establece en CustomEntity, este valor será el valor predeterminado. |
| globalDefaultFuzzyEditDistance |
integer (int32) |
Una bandera global para FuzzyEditDistance. Si FuzzyEditDistance no está establecido en CustomEntity, este valor será el valor predeterminado. |
| inlineEntitiesDefinition |
La definición de CustomEntity insertada. |
|
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
CustomEntityLookupSkillLanguage
Los códigos de idioma admitidos para el texto de entrada por CustomEntityLookupSkill.
| Valor | Description |
|---|---|
| da |
Danés |
| de |
German |
| en |
Inglés |
| es |
Spanish |
| fi |
Finlandés |
| fr |
French |
| it |
Italian |
| ko |
Korean |
| pt |
Portuguese |
DefaultCognitiveServicesAccount
Objeto vacío que representa el recurso predeterminado del servicio Azure AI para un conjunto de aptitudes.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de recurso de Azure AI Service asociado a un conjunto de aptitudes. |
| description |
string |
Descripción del recurso de servicio Azure AI asociado a un conjunto de aptitudes. |
DocumentExtractionSkill
Aptitud que extrae contenido de un archivo dentro de la canalización de enriquecimiento.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| configuration |
object |
Diccionario de configuraciones para la aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| dataToExtract |
string |
El tipo de datos que se extraerán para la aptitud. Se establecerá en 'contentAndMetadata' si no se define. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| parsingMode |
string |
El parsingMode de la habilidad. Se establecerá en 'default' si no se define. |
DocumentIntelligenceLayoutSkill
Una aptitud que extrae información de contenido y diseño, a través de Azure AI Services, de los archivos de la canalización de enriquecimiento.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
|
| chunkingProperties |
Controla la cardinalidad para fragmentar el contenido. |
||
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
|
| extractionOptions |
Controla la cardinalidad del contenido extraído del documento por la aptitud |
||
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
||
| markdownHeaderDepth | h6 |
La profundidad de los encabezados en la salida de Markdown. El valor predeterminado es h6. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
|
| outputFormat | markdown |
Controla la cardinalidad del formato de salida. El valor predeterminado es 'markdown'. |
|
| outputMode | oneToMany |
Controla la cardinalidad de la salida producida por la aptitud. El valor predeterminado es 'oneToMany'. |
|
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
DocumentIntelligenceLayoutSkillChunkingProperties
Controla la cardinalidad para fragmentar el contenido.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| maximumLength |
integer (int32) |
La longitud máxima del fragmento en caracteres. El valor predeterminado es 500. |
|
| overlapLength |
integer (int32) |
La longitud de superposición proporcionada entre dos fragmentos de texto. El valor predeterminado es 0. |
|
| unit | characters |
La unidad del fragmento. |
DocumentIntelligenceLayoutSkillChunkingUnit
Controla la cardinalidad de la unidad de fragmentos. El valor predeterminado es 'personajes'
| Valor | Description |
|---|---|
| characters |
Especifica fragmento por caracteres. |
DocumentIntelligenceLayoutSkillExtractionOptions
Controla la cardinalidad del contenido extraído del documento por la aptitud.
| Valor | Description |
|---|---|
| images |
Especifique que el contenido de la imagen debe extraerse del documento. |
| locationMetadata |
Especifique que los metadatos de ubicación deben extraerse del documento. |
DocumentIntelligenceLayoutSkillMarkdownHeaderDepth
La profundidad de los encabezados en la salida de Markdown. El valor predeterminado es h6.
| Valor | Description |
|---|---|
| h1 |
Nivel de encabezado 1. |
| h2 |
Nivel de encabezado 2. |
| h3 |
Nivel de encabezado 3. |
| h4 |
Nivel de encabezado 4. |
| h5 |
Nivel de encabezado 5. |
| h6 |
Nivel de encabezado 6. |
DocumentIntelligenceLayoutSkillOutputFormat
Controla la cardinalidad del formato de salida. El valor predeterminado es 'markdown'.
| Valor | Description |
|---|---|
| text |
Especifique el formato de la salida como texto. |
| markdown |
Especifique el formato de la salida como Markdown. |
DocumentIntelligenceLayoutSkillOutputMode
Controla la cardinalidad de la salida producida por la aptitud. El valor predeterminado es 'oneToMany'.
| Valor | Description |
|---|---|
| oneToMany |
Especifique que la salida debe analizarse como 'oneToMany'. |
EntityCategory
Una cadena que indica qué categorías de entidad devolver.
| Valor | Description |
|---|---|
| location |
Entidades que describen una ubicación física. |
| organization |
Entidades que describen una organización. |
| person |
Entidades que describen a una persona. |
| quantity |
Entidades que describen una cantidad. |
| datetime |
Entidades que describen una fecha y hora. |
| url |
Entidades que describen una URL. |
|
Entidades que describen una dirección de correo electrónico. |
EntityLinkingSkill
Con la API de Text Analytics, extrae entidades vinculadas del texto.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
string |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| minimumPrecision |
number (double) minimum: 0maximum: 1 |
Un valor entre 0 y 1 que se usa para incluir solo entidades cuya puntuación de confianza es mayor que el valor especificado. Si no se establece (valor predeterminado), o si se establece explícitamente en null, se incluirán todas las entidades. |
| modelVersion |
string |
La versión del modelo que se va a usar al llamar al servicio Text Analytics. De forma predeterminada, se establecerá la última disponible cuando no se especifique. Le recomendamos que no especifique este valor a menos que sea absolutamente necesario. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
EntityRecognitionSkill
Esta habilidad está obsoleta. Utilice el V3. EntityRecognitionSkill en su lugar.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| categories |
Una lista de categorías de entidades que se deben extraer. |
|
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| includeTypelessEntities |
boolean |
Determina si se deben incluir o no entidades que son bien conocidas pero que no se ajustan a un tipo predefinido. Si esta configuración no se establece (valor predeterminado), se establece en null o se establece en false, no se expondrán las entidades que no se ajusten a uno de los tipos predefinidos. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| minimumPrecision |
number (double) |
Un valor entre 0 y 1 que se usa para incluir solo entidades cuya puntuación de confianza es mayor que el valor especificado. Si no se establece (valor predeterminado), o si se establece explícitamente en null, se incluirán todas las entidades. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
EntityRecognitionSkillLanguage
Deprecated. Los códigos de idioma admitidos para el texto de entrada por EntityRecognitionSkill.
| Valor | Description |
|---|---|
| ar |
Árabe |
| cs |
Checo |
| zh-Hans |
Chinese-Simplified |
| zh-Hant |
Chinese-Traditional |
| da |
Danés |
| nl |
Holandés |
| en |
Inglés |
| fi |
Finlandés |
| fr |
French |
| de |
German |
| el |
Griego |
| hu |
Húngaro |
| it |
Italian |
| ja |
Japanese |
| ko |
Korean |
| no |
Noruego (Bokmaal) |
| pl |
Polaco |
| pt-PT |
Portugués (Portugal) |
| pt-BR |
Portugués (Brasil) |
| ru |
Russian |
| es |
Spanish |
| sv |
Sueco |
| tr |
Turco |
EntityRecognitionSkillV3
Con la API de Text Analytics, extrae entidades de diferentes tipos del texto.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| categories |
string[] |
Una lista de categorías de entidades que se deben extraer. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
string |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| minimumPrecision |
number (double) minimum: 0maximum: 1 |
Un valor entre 0 y 1 que se usa para incluir solo entidades cuya puntuación de confianza es mayor que el valor especificado. Si no se establece (valor predeterminado), o si se establece explícitamente en null, se incluirán todas las entidades. |
| modelVersion |
string |
La versión del modelo que se va a usar al llamar a la API de Text Analytics. De forma predeterminada, se establecerá la última disponible cuando no se especifique. Le recomendamos que no especifique este valor a menos que sea absolutamente necesario. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre | Tipo | Description |
|---|---|---|
| info |
object |
Información adicional. |
| type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Los detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
ImageAnalysisSkill
Una aptitud que analiza archivos de imagen. Extrae un amplio conjunto de características visuales basadas en el contenido de la imagen.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| details |
Una cadena que indica qué detalles específicos del dominio se van a devolver. |
|
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| visualFeatures |
Una lista de características visuales. |
ImageAnalysisSkillLanguage
Los códigos de idioma admitidos para la entrada de ImageAnalysisSkill.
| Valor | Description |
|---|---|
| ar |
Árabe |
| az |
Azerbaiyano |
| bg |
Búlgaro |
| bs |
Latín bosnio |
| ca |
Catalán |
| cs |
Checo |
| cy |
Galés |
| da |
Danés |
| de |
German |
| el |
Griego |
| en |
Inglés |
| es |
Spanish |
| et |
Estonio |
| eu |
Vasco |
| fi |
Finlandés |
| fr |
French |
| ga |
Irlandés |
| gl |
Gallego |
| he |
Hebreo |
| hi |
hindi |
| hr |
Croata |
| hu |
Húngaro |
| id |
Indonesian |
| it |
Italian |
| ja |
Japanese |
| kk |
Kazajo |
| ko |
Korean |
| lt |
Lituano |
| lv |
Letón |
| mk |
Macedonio |
| ms |
Malasia malaya |
| nb |
Noruego (Bokmal) |
| nl |
Holandés |
| pl |
Polaco |
| prs |
Darí |
| pt-BR |
Portuguese-Brazil |
| pt |
Portuguese-Portugal |
| pt-PT |
Portuguese-Portugal |
| ro |
Rumano |
| ru |
Russian |
| sk |
Eslovaco |
| sl |
Esloveno |
| sr-Cyrl |
Serbio - Cirílico RS |
| sr-Latn |
Serbio - Latín RS |
| sv |
Sueco |
| th |
Tailandés |
| tr |
Turco |
| uk |
Ucraniano |
| vi |
Vietnamita |
| zh |
Chino simplificado |
| zh-Hans |
Chino simplificado |
| zh-Hant |
Chino tradicional |
ImageDetail
Una cadena que indica qué detalles específicos del dominio se van a devolver.
| Valor | Description |
|---|---|
| celebrities |
Detalles reconocidos como celebridades. |
| landmarks |
Detalles reconocidos como puntos de referencia. |
IndexProjectionMode
Define el comportamiento de las proyecciones de índice en relación con el resto del indexador.
| Valor | Description |
|---|---|
| skipIndexingParentDocuments |
Se omitirá la escritura del documento de origen en el índice de destino del indexador. |
| includeIndexingParentDocuments |
El documento de origen se escribirá en el índice de destino del indexador. Este es el patrón predeterminado. |
InputFieldMappingEntry
Asignación de campos de entrada para una aptitud.
| Nombre | Tipo | Description |
|---|---|---|
| inputs |
Las entradas recursivas que se usan al crear un tipo complejo. |
|
| name |
string |
Nombre de la entrada. |
| source |
string |
El origen de la entrada. |
| sourceContext |
string |
El contexto de origen utilizado para seleccionar entradas recursivas. |
JsonSchemaProperties
Diccionario abierto para propiedades extendidas. Obligatorio si 'type' == 'json_schema'
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| description |
string |
Descripción del esquema json al que se adherirá el modelo. |
|
| name |
string |
Nombre del esquema json al que se adherirá el modelo |
|
| schema |
Objeto que define el esquema personalizado que usará el modelo para estructurar su salida. |
||
| strict |
boolean |
True |
Si la respuesta del modelo debe usar o no salidas estructuradas. El valor predeterminado es verdadero |
KeyPhraseExtractionSkill
Una aptitud que utiliza el análisis de texto para la extracción de frases clave.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| maxKeyPhraseCount |
integer (int32) |
Un número que indica cuántas frases clave devolver. Si está ausente, se devolverán todas las frases clave identificadas. |
| modelVersion |
string |
La versión del modelo que se va a usar al llamar al servicio Text Analytics. De forma predeterminada, se establecerá la última disponible cuando no se especifique. Le recomendamos que no especifique este valor a menos que sea absolutamente necesario. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
KeyPhraseExtractionSkillLanguage
Los códigos de idioma admitidos para el texto de entrada por KeyPhraseExtractionSkill.
| Valor | Description |
|---|---|
| da |
Danés |
| nl |
Holandés |
| en |
Inglés |
| fi |
Finlandés |
| fr |
French |
| de |
German |
| it |
Italian |
| ja |
Japanese |
| ko |
Korean |
| no |
Noruego (Bokmaal) |
| pl |
Polaco |
| pt-PT |
Portugués (Portugal) |
| pt-BR |
Portugués (Brasil) |
| ru |
Russian |
| es |
Spanish |
| sv |
Sueco |
LanguageDetectionSkill
Una aptitud que detecta el idioma del texto de entrada e informa de un único código de idioma para cada documento enviado en la solicitud. El código de idioma se combina con una puntuación que indica la confianza del análisis.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultCountryHint |
string |
Un código de país que se usará como sugerencia para el modelo de detección de idioma si no puede desambiguar el idioma. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| modelVersion |
string |
La versión del modelo que se va a usar al llamar al servicio Text Analytics. De forma predeterminada, se establecerá la última disponible cuando no se especifique. Le recomendamos que no especifique este valor a menos que sea absolutamente necesario. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
LineEnding
Define la secuencia de caracteres que se utilizarán entre las líneas de texto reconocidas por la aptitud de OCR. El valor predeterminado es "espacio".
| Valor | Description |
|---|---|
| space |
Las líneas están separadas por un solo carácter de espacio. |
| carriageReturn |
Las líneas están separadas por un carácter de retorno de carro ('\r'). |
| lineFeed |
Las líneas están separadas por un solo carácter de avance de línea ('\n'). |
| carriageReturnLineFeed |
Las líneas están separadas por un retorno de carro y un carácter de avance de línea ('\r\n'). |
MergeSkill
Una habilidad para fusionar dos o más cadenas en una sola cadena unificada, con un delimitador opcional definido por el usuario que separa cada parte componente.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
|
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
|
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
||
| insertPostTag |
string |
La etiqueta indica el final del texto combinado. De forma predeterminada, la etiqueta es un espacio vacío. |
|
| insertPreTag |
string |
La etiqueta indica el inicio del texto combinado. De forma predeterminada, la etiqueta es un espacio vacío. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
|
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
OcrSkill
Una aptitud que extrae texto de archivos de imagen.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
|
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
|
| defaultLanguageCode |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
||
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
|
| detectOrientation |
boolean |
False |
Un valor que indica activar o no la detección de orientación. El valor predeterminado es False. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
||
| lineEnding |
Define la secuencia de caracteres que se utilizarán entre las líneas de texto reconocidas por la aptitud de OCR. El valor predeterminado es "espacio". |
||
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
|
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
OcrSkillLanguage
Los códigos de idioma admitidos para la entrada de OcrSkill.
| Valor | Description |
|---|---|
| af |
Afrikáans |
| sq |
Albanés |
| anp |
Angika (Devanagiri) |
| ar |
Árabe |
| ast |
Asturiano |
| awa |
Awadhi-Hindi (Devanagiri) |
| az |
Azerbaiyano (latín) |
| bfy |
Bagheli |
| eu |
Vasco |
| be |
Bielorruso (cirílico y latín) |
| be-cyrl |
Bielorruso (cirílico) |
| be-latn |
Bielorruso (latín) |
| bho |
Bhojpuri-Hindi (Devanagiri) |
| bi |
Bislama |
| brx |
Bodo (Devanagiri) |
| bs |
Latín bosnio |
| bra |
Brajbha |
| br |
Bretón |
| bg |
Búlgaro |
| bns |
Bundeli |
| bua |
Buriato (cirílico) |
| ca |
Catalán |
| ceb |
Cebuano |
| rab |
Chamling |
| ch |
Chamorro |
| hne |
Chhattisgarhi (Devanagiri) |
| zh-Hans |
Chino simplificado |
| zh-Hant |
Chino tradicional |
| kw |
Córnico |
| co |
Corso |
| crh |
Tártaro de Crimea (latín) |
| hr |
Croata |
| cs |
Checo |
| da |
Danés |
| prs |
Darí |
| dhi |
Dhimal (Devanagiri) |
| doi |
Dogri (Devanagiri) |
| nl |
Holandés |
| en |
Inglés |
| myv |
Erzya (cirílico) |
| et |
Estonio |
| fo |
Feroés |
| fj |
Fiyiano |
| fil |
Filipino |
| fi |
Finlandés |
| fr |
French |
| fur |
Frulian |
| gag |
Gagauzo (latín) |
| gl |
Gallego |
| de |
German |
| gil |
Gilbertese |
| gon |
Gondi (Devanagiri) |
| el |
Griego |
| kl |
Groenlandés |
| gvr |
Gurung (Devanagiri) |
| ht |
Criollo haitiano |
| hlb |
Halbi (Devanagiri) |
| hni |
Hani |
| bgc |
Haryanvi |
| haw |
Hawaiano |
| hi |
hindi |
| mww |
Hmong Daw (latín) |
| hoc |
Ho (Devanagiri) |
| hu |
Húngaro |
| is |
Icelandic |
| smn |
Inari Sami |
| id |
Indonesian |
| ia |
Interlingua |
| iu |
Inuktitut (latino) |
| ga |
Irlandés |
| it |
Italian |
| ja |
Japanese |
| Jns |
Jaunsari (Devanagiri) |
| jv |
Javanés |
| kea |
Kabuverdianu |
| kac |
Kachin (latín) |
| xnr |
Kangri (Devanagiri) |
| krc |
Karachay-Balkar |
| kaa-cyrl |
Kara-Kalpak (cirílico) |
| kaa |
Kara-Kalpak (latín) |
| csb |
Casubio |
| kk-cyrl |
Kazajo (cirílico) |
| kk-latn |
Kazajo (latín) |
| klr |
Khaling |
| kha |
Jasí |
| quc |
Quiché |
| ko |
Korean |
| kfq |
Korku |
| kpy |
Koryak |
| kos |
Kosraean |
| kum |
Kumyk (cirílico) |
| ku-arab |
Kurdo (árabe) |
| ku-latn |
Kurdo (latín) |
| kru |
Kurukh (Devanagiri) |
| ky |
Kirguistán (cirílico) |
| lkt |
Lakota |
| la |
Latín |
| lt |
Lituano |
| dsb |
Bajo sorbio |
| smj |
Lule Sami |
| lb |
Luxemburgués |
| bfz |
Mahasu Pahari (Devanagiri) |
| ms |
Malayo (latín) |
| mt |
Maltés |
| kmj |
Malto (Devanagiri) |
| gv |
Manés |
| mi |
Maorí |
| mr |
Maratí |
| mn |
Mongol (cirílico) |
| cnr-cyrl |
Montenegrino (cirílico) |
| cnr-latn |
Montenegro (latín) |
| nap |
Napolitano |
| ne |
Nepalí |
| niu |
Niuean |
| nog |
Nogay |
| sme |
Sami del Norte (latín) |
| nb |
Noruego |
| no |
Noruego |
| oc |
Occitano |
| os |
Osético |
| ps |
Pastún |
| fa |
Persa |
| pl |
Polaco |
| pt |
Portuguese |
| pa |
Punjabi (árabe) |
| ksh |
Ripuario |
| ro |
Rumano |
| rm |
Romanche |
| ru |
Russian |
| sck |
Sadri (Devanagiri) |
| sm |
Samoano (latín) |
| sa |
Sánscrito (Devanagiri) |
| sat |
Santali (Devanagiri) |
| sco |
Escocés |
| gd |
Gaélico escocés |
| sr |
Serbio (latino) |
| sr-Cyrl |
Serbio (cirílico) |
| sr-Latn |
Serbio (latino) |
| xsr |
Sherpa (Devanagiri) |
| srx |
Sirmauri (Devanagiri) |
| sms |
Skolt Sami |
| sk |
Eslovaco |
| sl |
Esloveno |
| so |
Somalí (árabe) |
| sma |
Sami del sur |
| es |
Spanish |
| sw |
Swahili (latín) |
| sv |
Sueco |
| tg |
Tayiko (cirílico) |
| tt |
Tártaro (latín) |
| tet |
Tetun |
| thf |
Thangmi |
| to |
Tongano |
| tr |
Turco |
| tk |
Turcomano (latín) |
| tyv |
Tuvano |
| hsb |
Alto sorbio |
| ur |
Urdú |
| ug |
Uigur (árabe) |
| uz-arab |
Uzbeko (árabe) |
| uz-cyrl |
Uzbek (cirílico) |
| uz |
Uzbeko (latino) |
| vo |
Volapük |
| wae |
Walser |
| cy |
Galés |
| fy |
Frisón occidental |
| yua |
Maya Yucateco |
| za |
Zhuang |
| zu |
Zulú |
| unk |
Desconocido (Todos) |
OutputFieldMappingEntry
Asignación de campos de salida para una aptitud.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
El nombre de la salida definida por la aptitud. |
| targetName |
string |
El nombre de destino de la salida. Es opcional y por defecto nombrar. |
PIIDetectionSkill
Con la API de Text Analytics, extrae información personal de un texto de entrada y le da la opción de enmascararlo.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
string |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| domain |
string |
Si se especifica, establecerá el dominio PII para incluir solo un subconjunto de las categorías de entidad. Los valores posibles incluyen: 'phi', 'none'. El valor predeterminado es 'ninguno'. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| maskingCharacter |
string maxLength: 1 |
El carácter utilizado para enmascarar el texto si el parámetro maskingMode está establecido para reemplazar. El valor predeterminado es '*'. |
| maskingMode |
Parámetro que proporciona varias formas de enmascarar la información personal detectada en el texto de entrada. El valor predeterminado es 'ninguno'. |
|
| minimumPrecision |
number (double) minimum: 0maximum: 1 |
Un valor entre 0 y 1 que se usa para incluir solo entidades cuya puntuación de confianza es mayor que el valor especificado. Si no se establece (valor predeterminado), o si se establece explícitamente en null, se incluirán todas las entidades. |
| modelVersion |
string |
La versión del modelo que se va a usar al llamar al servicio Text Analytics. De forma predeterminada, se establecerá la última disponible cuando no se especifique. Le recomendamos que no especifique este valor a menos que sea absolutamente necesario. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| piiCategories |
string[] |
Una lista de categorías de entidades PII que deben extraerse y enmascararse. |
PIIDetectionSkillMaskingMode
Una cadena que indica qué maskingMode usar para enmascarar la información personal detectada en el texto de entrada.
| Valor | Description |
|---|---|
| none |
No se produce ningún enmascaramiento y no se devolverá la salida maskedText. |
| replace |
Reemplaza las entidades detectadas por el carácter dado en el parámetro maskingCharacter. El carácter se repetirá a la longitud de la entidad detectada para que los desplazamientos se correspondan correctamente tanto con el texto de entrada como con el maskedText de salida. |
SearchIndexerDataNoneIdentity
Borra la propiedad de identidad de un origen de datos.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de identidad. |
SearchIndexerDataUserAssignedIdentity
Especifica la identidad de un origen de datos que se va a utilizar.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de identidad. |
| userAssignedIdentity |
string |
Identificador de recurso completo de Azure de una identidad administrada asignada por el usuario, normalmente con el formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que debería haberse asignado al servicio de búsqueda. |
SearchIndexerIndexProjections
Definición de proyecciones adicionales a índices de búsqueda secundarios.
| Nombre | Tipo | Description |
|---|---|---|
| parameters |
Diccionario de propiedades de configuración específicas de proyección de índice. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo. |
|
| selectors |
Una lista de proyecciones que se realizarán en los índices de búsqueda secundarios. |
SearchIndexerIndexProjectionSelector
Descripción de los datos que se van a almacenar en el índice de búsqueda designado.
| Nombre | Tipo | Description |
|---|---|---|
| mappings |
Asignaciones para la proyección, o qué origen debe asignarse a qué campo en el índice de destino. |
|
| parentKeyFieldName |
string |
Nombre del campo en el índice de búsqueda al que se asigna el valor clave del documento principal. Debe ser un campo de cadena de caracteres que se pueda filtrar y no el campo clave. |
| sourceContext |
string |
Contexto de origen para las proyecciones. Representa la cardinalidad en la que el documento se dividirá en varios subdocumentos. |
| targetIndexName |
string |
Nombre del índice de búsqueda al que se va a proyectar. Debe tener un campo clave con el conjunto del analizador de 'palabras clave'. |
SearchIndexerIndexProjectionsParameters
Diccionario de propiedades de configuración específicas de proyección de índice. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo.
| Nombre | Tipo | Description |
|---|---|---|
| projectionMode |
Define el comportamiento de las proyecciones de índice en relación con el resto del indexador. |
SearchIndexerKnowledgeStore
Definición de proyecciones adicionales en blobs, tablas o archivos de Azure de datos enriquecidos.
| Nombre | Tipo | Description |
|---|---|---|
| identity | SearchIndexerDataIdentity: |
La identidad administrada asignada por el usuario que se usa para las conexiones a Azure Storage al escribir proyecciones del almacén de conocimiento. Si la cadena de conexión indica una identidad (ResourceId) y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad. |
| parameters |
Diccionario de propiedades de configuración específicas del almacén de conocimiento. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo. |
|
| projections |
Una lista de proyecciones adicionales para realizar durante la indexación. |
|
| storageConnectionString |
string |
En la que se almacenará la cadena de conexión a las proyecciones de la cuenta de almacenamiento. |
SearchIndexerKnowledgeStoreFileProjectionSelector
Definición de proyección de los datos que se van a almacenar en Azure Files.
| Nombre | Tipo | Description |
|---|---|---|
| generatedKeyName |
string |
Nombre de la clave generada para almacenar la proyección. |
| inputs |
Entradas anidadas para proyecciones complejas. |
|
| referenceKeyName |
string |
Nombre de la clave de referencia para diferentes proyecciones. |
| source |
string |
Datos de origen que se van a proyectar. |
| sourceContext |
string |
Contexto de origen para proyecciones complejas. |
| storageContainer |
string |
Contenedor de blobs en el que almacenar proyecciones. |
SearchIndexerKnowledgeStoreObjectProjectionSelector
Definición de proyección de los datos que se van a almacenar en Azure Blob.
| Nombre | Tipo | Description |
|---|---|---|
| generatedKeyName |
string |
Nombre de la clave generada para almacenar la proyección. |
| inputs |
Entradas anidadas para proyecciones complejas. |
|
| referenceKeyName |
string |
Nombre de la clave de referencia para diferentes proyecciones. |
| source |
string |
Datos de origen que se van a proyectar. |
| sourceContext |
string |
Contexto de origen para proyecciones complejas. |
| storageContainer |
string |
Contenedor de blobs en el que almacenar proyecciones. |
SearchIndexerKnowledgeStoreParameters
Diccionario de propiedades de configuración específicas del almacén de conocimiento. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| synthesizeGeneratedKeyName |
boolean |
False |
Si las proyecciones deben sintetizar o no un nombre de clave generado si aún no está presente. |
SearchIndexerKnowledgeStoreProjection
Objeto contenedor para varios selectores de proyección.
| Nombre | Tipo | Description |
|---|---|---|
| files |
Proyecciones en Azure File Storage. |
|
| objects |
Proyecciones en Azure Blob Storage. |
|
| tables |
Proyecciones en Azure Table Storage. |
SearchIndexerKnowledgeStoreTableProjectionSelector
Descripción de los datos que se van a almacenar en Azure Tables.
| Nombre | Tipo | Description |
|---|---|---|
| generatedKeyName |
string |
Nombre de la clave generada para almacenar la proyección. |
| inputs |
Entradas anidadas para proyecciones complejas. |
|
| referenceKeyName |
string |
Nombre de la clave de referencia para diferentes proyecciones. |
| source |
string |
Datos de origen que se van a proyectar. |
| sourceContext |
string |
Contexto de origen para proyecciones complejas. |
| tableName |
string |
Nombre de la tabla de Azure en la que se van a almacenar los datos proyectados. |
SearchIndexerSkillset
Una lista de habilidades.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.etag |
string |
La ETag del conjunto de habilidades. |
| cognitiveServices | CognitiveServicesAccount: |
Detalles sobre el servicio Azure AI que se usará al ejecutar aptitudes. |
| description |
string |
La descripción del conjunto de habilidades. |
| encryptionKey |
Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para la definición del conjunto de aptitudes cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrar la definición del conjunto de aptitudes. Una vez que haya cifrado la definición del conjunto de aptitudes, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar su clave de cifrado; La definición del conjunto de aptitudes no se verá afectada. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios pagos creados a partir del 1 de enero de 2019. |
|
| indexProjections |
Definición de proyecciones adicionales a los índices de búsqueda secundarios. |
|
| knowledgeStore |
Definición de proyecciones adicionales en blobs, tablas o archivos de Azure de datos enriquecidos. |
|
| name |
string |
El nombre del conjunto de habilidades. |
| skills |
SearchIndexerSkill[]:
|
Una lista de habilidades en el conjunto de habilidades. |
SearchResourceEncryptionKey
Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos.
| Nombre | Tipo | Description |
|---|---|---|
| accessCredentials |
Credenciales opcionales de Azure Active Directory usadas para acceder a Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar. |
|
| identity | SearchIndexerDataIdentity: |
Una identidad administrada explícita que se usará para esta clave de cifrado. Si no se especifica y la propiedad de credenciales de acceso es null, se usa la identidad administrada asignada por el sistema. Al actualizar el recurso, si no se especifica la identidad explícita, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad. |
| keyVaultKeyName |
string |
Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. |
| keyVaultKeyVersion |
string |
La versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. |
| keyVaultUri |
string |
El URI de Azure Key Vault, también conocido como nombre DNS, que contiene la clave que se usará para cifrar los datos en reposo. Un ejemplo de URI podría ser |
SentimentSkill
Esta habilidad está obsoleta. Utilice el V3. SentimentSkill en su lugar.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
SentimentSkillLanguage
Deprecated. Los códigos de idioma admitidos para el texto de entrada por SentimentSkill.
| Valor | Description |
|---|---|
| da |
Danés |
| nl |
Holandés |
| en |
Inglés |
| fi |
Finlandés |
| fr |
French |
| de |
German |
| el |
Griego |
| it |
Italian |
| no |
Noruego (Bokmaal) |
| pl |
Polaco |
| pt-PT |
Portugués (Portugal) |
| ru |
Russian |
| es |
Spanish |
| sv |
Sueco |
| tr |
Turco |
SentimentSkillV3
Con la API de Text Analytics, evalúa el texto no estructurado y, para cada registro, proporciona etiquetas de opinión (como "negativo", "neutro" y "positivo") en función de la puntuación de confianza más alta encontrada por el servicio en un nivel de oración y documento.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
|
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
|
| defaultLanguageCode |
string |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
|
| includeOpinionMining |
boolean |
False |
Si se establece en true, la salida de la aptitud incluirá información de Text Analytics para la minería de opiniones, es decir, objetivos (sustantivos o verbos) y su evaluación asociada (adjetivo) en el texto. El valor predeterminado es False. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
||
| modelVersion |
string |
La versión del modelo que se va a usar al llamar al servicio Text Analytics. De forma predeterminada, se establecerá la última disponible cuando no se especifique. Le recomendamos que no especifique este valor a menos que sea absolutamente necesario. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
|
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
ShaperSkill
Una habilidad para remodelar los resultados. Crea un tipo complejo para admitir campos compuestos (también conocidos como campos multiparte).
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
SplitSkill
Una habilidad para dividir una cadena en trozos de texto.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| azureOpenAITokenizerParameters |
Solo se aplica si la unidad está establecida en azureOpenAITokens. Si se especifica, splitSkill utilizará estos parámetros al realizar la tokenización. Los parámetros son un 'encoderModelName' válido y una propiedad opcional 'allowedSpecialTokens'. |
|
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultLanguageCode |
Valor que indica qué código de idioma se va a usar. El valor predeterminado es |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| maximumPageLength |
integer (int32) |
La longitud máxima de página deseada. El valor predeterminado es 10000. |
| maximumPagesToTake |
integer (int32) |
Solo se aplica cuando textSplitMode se establece en 'pages'. Si se especifica, SplitSkill dejará de dividir después de procesar las primeras páginas 'maximumPagesToTake', para mejorar el rendimiento cuando solo se necesitan unas pocas páginas iniciales de cada documento. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| pageOverlapLength |
integer (int32) |
Solo se aplica cuando textSplitMode se establece en 'pages'. Si se especifica, n+1º fragmento comenzará con este número de caracteres/tokens desde el final del n-ésimo fragmento. |
| textSplitMode |
Un valor que indica qué modo de división realizar. |
|
| unit |
Solo se aplica si textSplitMode está establecido en pages. Hay dos valores posibles. La elección de los valores decidirá la medida de longitud (maximumPageLength y pageOverlapLength). El valor predeterminado es 'caracteres', lo que significa que la longitud se medirá por carácter. |
SplitSkillEncoderModelName
Solo se aplica si la unidad está establecida en azureOpenAITokens. Las opciones incluyen 'R50k_base', 'P50k_base', 'P50k_edit' y 'CL100k_base'. El valor predeterminado es 'CL100k_base'.
| Valor | Description |
|---|---|
| r50k_base |
Hace referencia a un modelo base entrenado con un vocabulario de 50 000 tokens, que se usa a menudo en tareas generales de procesamiento del lenguaje natural. |
| p50k_base |
Un modelo base con un vocabulario de 50 000 tokens, optimizado para tareas basadas en avisos. |
| p50k_edit |
Similar a p50k_base pero ajustado para editar o reformular tareas con un vocabulario de 50,000 tokens. |
| cl100k_base |
Un modelo base con un vocabulario de 100,000 tokens. |
SplitSkillLanguage
Los códigos de idioma admitidos para el texto de entrada por SplitSkill.
| Valor | Description |
|---|---|
| am |
Amárico |
| bs |
Bosnio |
| cs |
Checo |
| da |
Danés |
| de |
German |
| en |
Inglés |
| es |
Spanish |
| et |
Estonio |
| fi |
Finlandés |
| fr |
French |
| he |
Hebreo |
| hi |
hindi |
| hr |
Croata |
| hu |
Húngaro |
| id |
Indonesian |
| is |
Icelandic |
| it |
Italian |
| ja |
Japanese |
| ko |
Korean |
| lv |
Letón |
| nb |
Noruego |
| nl |
Holandés |
| pl |
Polaco |
| pt |
Portugués (Portugal) |
| pt-br |
Portugués (Brasil) |
| ru |
Russian |
| sk |
Eslovaco |
| sl |
Esloveno |
| sr |
Serbio |
| sv |
Sueco |
| tr |
Turco |
| ur |
Urdú |
| zh |
Chino (simplificado) |
SplitSkillUnit
Un valor que indica qué unidad usar.
| Valor | Description |
|---|---|
| characters |
La longitud se medirá por carácter. |
| azureOpenAITokens |
La longitud se medirá mediante un tokenizador AzureOpenAI de la biblioteca tiktoken. |
TextSplitMode
Un valor que indica qué modo de división realizar.
| Valor | Description |
|---|---|
| pages |
Divida el texto en páginas individuales. |
| sentences |
Divide el texto en oraciones individuales. |
TextTranslationSkill
Una habilidad para traducir texto de un idioma a otro.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| defaultFromLanguageCode |
El código de idioma desde el que se traducirán documentos para documentos que no especifican explícitamente el idioma de. |
|
| defaultToLanguageCode |
El código de idioma al que se van a traducir los documentos para los documentos que no especifican explícitamente el idioma de destino. |
|
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| suggestedFrom |
El código de idioma desde el que se van a traducir los documentos cuando no se proporcionan ni la entrada fromLanguageCode ni el parámetro defaultFromLanguageCode y la detección automática de idioma no se realiza correctamente. El valor predeterminado es |
TextTranslationSkillLanguage
Los códigos de idioma admitidos para el texto de entrada por TextTranslationSkill.
| Valor | Description |
|---|---|
| af |
Afrikáans |
| ar |
Árabe |
| bn |
Bengalí |
| bs |
Bosnio (latino) |
| bg |
Búlgaro |
| yue |
Cantonés (tradicional) |
| ca |
Catalán |
| zh-Hans |
Chino simplificado |
| zh-Hant |
Chino tradicional |
| hr |
Croata |
| cs |
Checo |
| da |
Danés |
| nl |
Holandés |
| en |
Inglés |
| et |
Estonio |
| fj |
Fiyiano |
| fil |
Filipino |
| fi |
Finlandés |
| fr |
French |
| de |
German |
| el |
Griego |
| ht |
Criollo haitiano |
| he |
Hebreo |
| hi |
hindi |
| mww |
Hmong Daw |
| hu |
Húngaro |
| is |
Icelandic |
| id |
Indonesian |
| it |
Italian |
| ja |
Japanese |
| sw |
Swahili |
| tlh |
Klingon |
| tlh-Latn |
Klingon (alfabeto latino) |
| tlh-Piqd |
Klingon (escritura klingon) |
| ko |
Korean |
| lv |
Letón |
| lt |
Lituano |
| mg |
Malgache |
| ms |
Malayo |
| mt |
Maltés |
| nb |
Noruego |
| fa |
Persa |
| pl |
Polaco |
| pt |
Portuguese |
| pt-br |
Portugués (Brasil) |
| pt-PT |
Portugués (Portugal) |
| otq |
Otomí Querétaro |
| ro |
Rumano |
| ru |
Russian |
| sm |
Samoano |
| sr-Cyrl |
Serbio (cirílico) |
| sr-Latn |
Serbio (latino) |
| sk |
Eslovaco |
| sl |
Esloveno |
| es |
Spanish |
| sv |
Sueco |
| ty |
Tahitiano |
| ta |
Tamil |
| te |
Telugu |
| th |
Tailandés |
| to |
Tongano |
| tr |
Turco |
| uk |
Ucraniano |
| ur |
Urdú |
| vi |
Vietnamita |
| cy |
Galés |
| yua |
Maya Yucateco |
| ga |
Irlandés |
| kn |
Canarés |
| mi |
Maorí |
| ml |
Malayalam |
| pa |
Punjabí |
VisionVectorizeSkill
Permite generar una inserción vectorial para una entrada de imagen o texto determinada mediante la API de vectorización de visión de Azure AI Services.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| modelVersion |
string |
La versión del modelo que se va a usar al llamar al servicio AI Services Vision. De forma predeterminada, se establecerá la última disponible cuando no se especifique. |
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
VisualFeature
Las cadenas que indican qué tipos de características visuales se van a devolver.
| Valor | Description |
|---|---|
| adult |
Características visuales reconocidas como personas adultas. |
| brands |
Características visuales reconocidas como marcas comerciales. |
| categories |
Categorías. |
| description |
Descripción. |
| faces |
Características visuales reconocidas como rostros de personas. |
| objects |
Características visuales reconocidas como objetos. |
| tags |
Etiquetas. |
WebApiSkill
Una aptitud que puede llamar a un punto de conexión de API web, lo que le permite ampliar un conjunto de aptitudes haciendo que llame al código personalizado.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Un fragmento de URI que especifica el tipo de aptitud. |
| authIdentity | SearchIndexerDataIdentity: |
La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad. |
| authResourceId |
string |
Se aplica a las aptitudes personalizadas que se conectan a código externo en una función de Azure o alguna otra aplicación que proporcione las transformaciones. Este valor debe ser el identificador de aplicación creado para la función o aplicación cuando se registró en Azure Active Directory. Cuando se especifica, la aptitud personalizada se conecta a la función o aplicación mediante un identificador administrado (ya sea asignado por el sistema o por el usuario) del servicio de búsqueda y el token de acceso de la función o aplicación, utilizando este valor como identificador de recurso para crear el ámbito del token de acceso. |
| batchSize |
integer (int32) |
El tamaño de lote deseado que indica el número de documentos. |
| context |
string |
Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document. |
| degreeOfParallelism |
integer (int32) |
Si se establece, el número de llamadas paralelas que se pueden realizar a la API web. |
| description |
string |
La descripción de la aptitud que describe las entradas, salidas y uso de la aptitud. |
| httpHeaders |
object |
Los encabezados necesarios para realizar la solicitud http. |
| httpMethod |
string |
El método para la solicitud http. |
| inputs |
Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente. |
|
| name |
string |
El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'. |
| outputs |
La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada. |
|
| timeout |
string (duration) |
El tiempo de espera deseado para la solicitud. El valor predeterminado es 30 segundos. |
| uri |
string |
La dirección URL de la API web. |