Knowledge Sources - Create

Servicio:: Search Service

Versión de la API:: 2026-08-01-preview

Crea una nueva fuente de conocimiento.

POST {endpoint}/knowledgesources?api-version=2026-08-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Accept		Accept	El encabezado Aceptar.
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Cuerpo de la solicitud

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

Nombre	Description
AzureBlobKnowledgeSource	Configuración para el origen de conocimiento de Azure Blob Storage.
FabricDataAgentKnowledgeSource	Configuración para la fuente de conocimiento del Fabric Data Agent.
FabricOntologyKnowledgeSource	Configuración para Fabric Ontology fuente de conocimiento.
FileKnowledgeSource	Configuración para la fuente de conocimiento de archivos que soporta subida e indexación directa de archivos.
IndexedOneLakeKnowledgeSource	Configuración para el origen de conocimiento de OneLake.
IndexedSharePointKnowledgeSource	Configuración para el origen de conocimiento de SharePoint.
IndexedSqlKnowledgeSource	Configuración para la fuente de conocimiento SQL indexada.
McpServerKnowledgeSource	Configuración de una fuente de conocimiento respaldada por un servidor MCP (Model Context Protocol).
RemoteSharePointKnowledgeSource	Configuración para el origen de conocimiento remoto de SharePoint.
SearchIndexKnowledgeSource	Fuente de conocimiento dirigida a un índice de búsqueda.
WebKnowledgeSource	Fuente de conocimiento dirigida a resultados web.
WorkIQKnowledgeSource	Configuración para la fuente de conocimiento de WorkIQ.

AzureBlobKnowledgeSource

Configuración para el origen de conocimiento de Azure Blob Storage.

Nombre	Requerido	Tipo	Description
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	El tipo de fuente de conocimiento.
kind	True	string: azureBlob	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

FabricDataAgentKnowledgeSource

Configuración para la fuente de conocimiento del Fabric Data Agent.

Nombre	Requerido	Tipo	Description
fabricDataAgentParameters	True	FabricDataAgentKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento del Fabric Data Agent.
kind	True	string: fabricDataAgent	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

FabricOntologyKnowledgeSource

Configuración para Fabric Ontology fuente de conocimiento.

Nombre	Requerido	Tipo	Description
fabricOntologyParameters	True	FabricOntologyKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento de Fabric Ontology.
kind	True	string: fabricOntology	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

FileKnowledgeSource

Configuración para la fuente de conocimiento de archivos que soporta subida e indexación directa de archivos.

Nombre	Requerido	Tipo	Description
fileParameters	True	FileKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento del archivo.
kind	True	string: file	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
corsOptions		CorsOptions	Opciones para controlar el Intercambio de Recursos entre Orígenes (CORS) para los extremos de archivo de la fuente de conocimiento del archivo (subir, listar, actualizar, eliminar).
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

IndexedOneLakeKnowledgeSource

Configuración para el origen de conocimiento de OneLake.

Nombre	Requerido	Tipo	Description
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento.
kind	True	string: indexedOneLake	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

IndexedSharePointKnowledgeSource

Configuración para el origen de conocimiento de SharePoint.

Nombre	Requerido	Tipo	Description
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento.
kind	True	string: indexedSharePoint	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

IndexedSqlKnowledgeSource

Configuración para la fuente de conocimiento SQL indexada.

Nombre	Requerido	Tipo	Description
indexedSqlParameters	True	IndexedSqlKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento SQL.
kind	True	string: indexedSql	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

McpServerKnowledgeSource

Configuración de una fuente de conocimiento respaldada por un servidor MCP (Model Context Protocol).

Nombre	Requerido	Tipo	Description
kind	True	string: mcpServer	El tipo de fuente de conocimiento.
mcpServerParameters	True	McpServerKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento del servidor MCP.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

RemoteSharePointKnowledgeSource

Configuración para el origen de conocimiento remoto de SharePoint.

Nombre	Requerido	Tipo	Description
kind	True	string: remoteSharePoint	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento remota de SharePoint.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

SearchIndexKnowledgeSource

Fuente de conocimiento dirigida a un índice de búsqueda.

Nombre	Requerido	Tipo	Description
kind	True	string: searchIndex	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

WebKnowledgeSource

Fuente de conocimiento dirigida a resultados web.

Nombre	Requerido	Tipo	Description
kind	True	string: web	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.
webParameters		WebKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento web.

WorkIQKnowledgeSource

Configuración para la fuente de conocimiento de WorkIQ.

Nombre	Requerido	Tipo	Description
kind	True	string: workIQ	El tipo de fuente de conocimiento.
name	True	string	El nombre de la fuente de conocimiento.
workIQParameters	True	WorkIQKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento de WorkIQ, incluyendo la configuración de la app Entra, propiedad del cliente, utilizada para la autenticación en nombre de la empresa.
@odata.etag		string	El ETag de la fuente de conocimiento.
description		string	Descripción opcional definida por el usuario.
encryptionKey		SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

Respuestas

Nombre	Tipo	Description
201 Created	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

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

Ejemplos

SearchServiceCreateKnowledgeSource

SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSourceFabricDataAgent

SearchServiceCreateKnowledgeSourceFabricOntology

SearchServiceCreateKnowledgeSourceFile

SearchServiceCreateKnowledgeSourceIndexedOneLake

SearchServiceCreateKnowledgeSourceIndexedSharePoint

SearchServiceCreateKnowledgeSourceIndexedSql

SearchServiceCreateKnowledgeSourceMcpServer

SearchServiceCreateKnowledgeSourceWeb

SearchServiceCreateKnowledgeSourceWorkIQ

SearchServiceCreateKnowledgeSource

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "resultsProcessing": "none",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceAzureBlob

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      },
      "networkAccessMode": "private"
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateKnowledgeSourceFabricDataAgent

Solicitud de ejemplo

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview


{
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  },
  "name": "ks-fabric-agent-test",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "kind": "fabricDataAgent",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabric-agent-test",
  "kind": "fabricDataAgent",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  }
}

SearchServiceCreateKnowledgeSourceFabricOntology

Solicitud de ejemplo

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview


{
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  },
  "name": "ks-fabricontology-test",
  "description": "Description of the Fabric Ontology knowledge source.",
  "kind": "fabricOntology",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabricontology-test",
  "kind": "fabricOntology",
  "description": "Description of the Fabric Ontology knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  }
}

SearchServiceCreateKnowledgeSourceFile

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the File knowledge source.",
  "kind": "file",
  "fileParameters": {
    "ingestionParameters": {
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "index": "ks-preview-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

SearchServiceCreateKnowledgeSourceIndexedOneLake

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the OneLake knowledge source.",
  "kind": "indexedOneLake",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedSharePoint

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the SharePoint knowledge source.",
  "kind": "indexedSharePoint",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedSql

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the SQL knowledge source.",
  "kind": "indexedSql",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "minimal"
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSql",
  "description": "Description of the SQL knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceMcpServer

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the MCP server knowledge source.",
  "kind": "mcpServer",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        },
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096
      }
    ]
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "mcpServer",
  "description": "Description of the MCP server knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceCreateKnowledgeSourceWeb

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "web",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceWorkIQ

Solicitud de ejemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the WorkIQ knowledge source.",
  "kind": "workIQ",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

Respuesta de muestra

status code:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
AIServices	Parámetros para los servicios de IA.
AssetStore	Configuración de un asset store utilizado para almacenar assets extraídos como imágenes.
AzureBlobKnowledgeSource	Configuración para el origen de conocimiento de Azure Blob Storage.
AzureBlobKnowledgeSourceParameters	Parámetros para el origen de conocimiento de Azure Blob Storage.
AzureOpenAIModelName	Nombre del modelo de Azure Open AI al que se llamará.
AzureOpenAIVectorizerParameters	Especifica los parámetros para conectarse al recurso de Azure OpenAI.
ContentColumnMapping	Mapea una columna SQL a un campo índice de búsqueda.
CorsOptions	Define las opciones para controlar el uso compartido de recursos entre orígenes (CORS) para un índice.
EmbeddingColumnMapping	Mapea una columna SQL a un campo vectorial para incrustar.
EntraAppAuthentication	Configuración para un registro de aplicación Microsoft Entra propiedad del cliente utilizado para autenticación basada en credenciales federadas en nombre de la empresa.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
FabricDataAgentKnowledgeSource	Configuración para la fuente de conocimiento del Fabric Data Agent.
FabricDataAgentKnowledgeSourceParameters	Parámetros para la fuente de conocimiento del Fabric Data Agent.
FabricOntologyKnowledgeSource	Configuración para Fabric Ontology fuente de conocimiento.
FabricOntologyKnowledgeSourceParameters	Fuente de datos sobre parámetros para Fabric Ontology.
FileKnowledgeSource	Configuración para la fuente de conocimiento de archivos que soporta subida e indexación directa de archivos.
FileKnowledgeSourceParameters	Parámetros para la fuente de conocimiento del archivo.
FreshnessPolicy	Configuración para recuperación consciente de la frescura. Cuando se establecen, los documentos más recientes reciben un aumento de ranking durante la recuperación.
IndexedOneLakeKnowledgeSource	Configuración para el origen de conocimiento de OneLake.
IndexedOneLakeKnowledgeSourceParameters	Parámetros para el origen de conocimiento de OneLake.
IndexedSharePointContainerName	Especifica a qué bibliotecas de SharePoint se va a acceder.
IndexedSharePointKnowledgeSource	Configuración para el origen de conocimiento de SharePoint.
IndexedSharePointKnowledgeSourceParameters	Parámetros para el origen de conocimiento de SharePoint.
IndexedSqlKnowledgeSource	Configuración para la fuente de conocimiento SQL indexada.
IndexedSqlKnowledgeSourceParameters	Parámetros para la fuente de conocimiento SQL indexada.
IndexingSchedule	Representa una programación para la ejecución del indexador.
KnowledgeBaseAzureOpenAIModel	Especifica el recurso de Azure OpenAI que se usa para realizar la planeación de consultas.
KnowledgeBaseModelKind	El modelo de IA que se utilizará para la planificación de consultas.
KnowledgeSourceAzureOpenAIVectorizer	Especifica el recurso de Azure OpenAI que se usa para vectorizar una cadena de consulta.
KnowledgeSourceIngestionParameters	Consolida todas las configuraciones generales de ingesta para los orígenes de conocimiento.
KnowledgeSourceIngestionPermissionOption	Tipos de permisos para ingerir junto con el contenido del documento.
KnowledgeSourceKind	El tipo de fuente de conocimiento.
KnowledgeSourceNetworkAccessMode	Especifica el modo de acceso a la red para la ingestión de fuentes de conocimiento. El predeterminado es 'público'.
KnowledgeSourceResultsProcessing	Controla si los resultados de una fuente de conocimiento se reclasifican.
McpServerAuthenticationKind	El tipo de autenticación para un servidor MCP.
McpServerAutoOutputParsing	Detecta automáticamente el formato de salida y analiza en consecuencia.
McpServerFoundryConnectionAuthentication	Autenticación usando una conexión de Fundición de IA de Azure.
McpServerFoundryConnectionParameters	Parámetros para la autenticación de conexiones con Foundry.
McpServerJsonOutputParsing	Analiza la salida como un documento JSON usando los parámetros JSON configurados.
McpServerKnowledgeSource	Configuración de una fuente de conocimiento respaldada por un servidor MCP (Model Context Protocol).
McpServerKnowledgeSourceParameters	Parámetros para la fuente de conocimiento de un servidor MCP.
McpServerNoneOutputParsing	Trata la salida como un solo bloque sin ningún análisis sintáctico.
McpServerOutputParsingJsonParameters	Parámetros para análisis de salida JSON.
McpServerOutputParsingKind	El tipo de análisis sintáctico de salida para una herramienta de servidor MCP.
McpServerOutputParsingSplitParameters	Parámetros para análisis de salida dividida.
McpServerSplitOutputParsing	Divide la salida en páginas usando los parámetros de división configurados.
McpServerStoredHeadersAuthentication	Autenticación usando cabeceras HTTP almacenadas.
McpServerStoredHeadersParameters	Parámetros para la autenticación de cabeceras almacenadas.
McpServerTool	Representa una única herramienta dentro de una fuente de conocimiento de un servidor MCP.
RemoteSharePointKnowledgeSource	Configuración para el origen de conocimiento remoto de SharePoint.
RemoteSharePointKnowledgeSourceParameters	Parámetros para el origen de conocimiento remoto de SharePoint.
SearchIndexerDataNoneIdentity	Borra la propiedad de identidad de un origen de datos.
SearchIndexerDataUserAssignedIdentity	Especifica la identidad de un origen de datos que se va a usar.
SearchIndexFieldReference	Referencia de campo para un índice de búsqueda.
SearchIndexKnowledgeSource	Fuente de conocimiento dirigida a un índice de búsqueda.
SearchIndexKnowledgeSourceBoostKind	El tipo de consejo de impulso para una fuente de conocimiento de un índice de búsqueda.
SearchIndexKnowledgeSourceFieldValueBoost	Una pista que mejora documentos basándose en el valor de un campo.
SearchIndexKnowledgeSourceFilterHint	Una pista que identifica un campo y valores representativos que el planificador de consultas puede usar al construir un filtro.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Una pista que mejora los documentos basándose en una expresión de varias palabras.
SearchIndexKnowledgeSourceParameters	Parámetros para el origen de conocimiento del índice de búsqueda.
SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros útiles y mejoras para una fuente de conocimiento de índice de búsqueda.
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.
SplitSkillLanguage	Los códigos de idioma admitidos para el texto de entrada por SplitSkill.
TextSplitMode	Valor que indica qué modo de división se va a realizar.
VectorSearchVectorizerKind	El método de vectorización que se utilizará durante el tiempo de consulta.
WebKnowledgeSource	Fuente de conocimiento dirigida a resultados web.
WebKnowledgeSourceDomain	Configuración para el dominio de origen de conocimiento web.
WebKnowledgeSourceDomains	Configuración de dominio/bloqueo para el origen de conocimiento web.
WebKnowledgeSourceParameters	Parámetros para el origen de conocimiento web.
WorkIQKnowledgeSource	Configuración para la fuente de conocimiento de WorkIQ.
WorkIQKnowledgeSourceParameters	Parámetros para una fuente de conocimiento WorkIQ.

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=minimal

AIServices

Objeto

Parámetros para los servicios de IA.

Nombre	Tipo	Description
apiKey	string	La clave de API para acceder a los servicios de IA.
uri	string (uri)	El URI del punto de conexión de AI Services.

AssetStore

Objeto

Configuración de un asset store utilizado para almacenar assets extraídos como imágenes.

Nombre	Tipo	Description
connectionString	string	La cadena de conexión para el asset store.
containerName	string	El nombre del contenedor de blob dentro del almacén de activos donde se almacenan los activos extraídos (por ejemplo, imágenes).

AzureBlobKnowledgeSource

Objeto

Configuración para el origen de conocimiento de Azure Blob Storage.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	El tipo de fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
kind	string: azureBlob	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

AzureBlobKnowledgeSourceParameters

Objeto

Parámetros para el origen de conocimiento de Azure Blob Storage.

Nombre	Tipo	Valor predeterminado	Description
connectionString	string		Cadena de conexión basada en clave o el formato ResourceId si se usa una identidad administrada.
containerName	string		Nombre del contenedor de Blob Storage.
createdResources	object		Recursos creados por la fuente de conocimiento.
folderPath	string		Ruta de acceso de carpeta opcional dentro del contenedor.
ingestionParameters	KnowledgeSourceIngestionParameters		Consolida todas las configuraciones generales de ingesta.
isADLSGen2	boolean	False	Establézcalo en true si se conecta a una cuenta de almacenamiento de ADLS Gen2. El valor predeterminado es falso.
queryHints	SearchIndexKnowledgeSourceQueryHints		Pistas predeterminadas que guían la planificación de consultas hacia filtros y mejoras útiles para esta fuente de conocimiento respaldada por índices. Las pistas de consulta en tiempo de solicitud reemplazan estos valores predeterminados como objeto completo.

AzureOpenAIModelName

Enumeración

Nombre del modelo de Azure Open AI al que se llamará.

Valor	Description
text-embedding-ada-002	TextEmbeddingAda002 modelo.
text-embedding-3-large	TextEmbedding3 Modelo grande.
text-embedding-3-small	TextoEmbede3Modelo pequeño.
gpt-4o	Modelo GPT4o.
gpt-4o-mini	Modelo Gpt4oMini.
gpt-4.1	Modelo GPT41.
gpt-4.1-mini	Modelo Gpt41Mini.
gpt-4.1-nano	Modelo Gpt41Nano.
gpt-5	Modelo GPT5.
gpt-5-mini	Modelo Gpt5Mini.
gpt-5-nano	Modelo Gpt5Nano.
gpt-5.1	Modelo GPT51.
gpt-5.2	Modelo GPT52.
gpt-5.4	Modelo GPT54.
gpt-5.4-mini	Modelo GPT54Mini.
gpt-5.4-nano	Modelo Gpt54Nano.
gpt-5.5	Modelo GPT55.
gpt-5.6-sol	Modelo Gpt56Sol.
gpt-5.6-terra	Modelo GPT56Terra.
gpt-5.6-luna	Modelo Gpt56Luna.

AzureOpenAIVectorizerParameters

Objeto

Especifica los parámetros para conectarse al recurso de Azure OpenAI.

Nombre	Tipo	Description
apiKey	string	Clave de API del recurso de Azure OpenAI designado.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	La identidad administrada asignada por el usuario que se usa para las conexiones salientes.
deploymentId	string	Identificador de la implementación del modelo de Azure OpenAI en el recurso designado.
modelName	AzureOpenAIModelName	Nombre del modelo de inserción que se implementa en la ruta de acceso deploymentId proporcionada.
resourceUri	string (uri)	Identificador URI del recurso de Azure OpenAI.

ContentColumnMapping

Objeto

Mapea una columna SQL a un campo índice de búsqueda.

Nombre	Tipo	Description
name	string	Nombre del campo índice objetivo.
searchFieldType	string	Tipo de campo Búsqueda de Azure AI (por ejemplo, Edm.String, Edm.Int32).
sourceField	string	Nombre de columna SQL.

CorsOptions

Objeto

Define las opciones para controlar el uso compartido de recursos entre orígenes (CORS) para un índice.

Nombre	Tipo	Description
allowedOrigins	string[]	La lista de orígenes desde los que se concederá acceso al código JavaScript al índice. Puede contener una lista de hosts con el formato {protocol}://{fully-qualified-domain-name}[:{port#}], o un solo '*' para permitir todos los orígenes (no recomendado).
maxAgeInSeconds	integer (int64)	La duración durante la cual los exploradores deben almacenar en caché las respuestas preparatorias de CORS. El valor predeterminado es 5 minutos.

EmbeddingColumnMapping

Objeto

Mapea una columna SQL a un campo vectorial para incrustar.

Nombre	Tipo	Description
name	string	Nombre del campo vectorial objetivo en el índice de búsqueda.
sourceField	string	Columna SQL utilizada como entrada para la generación de incrustaciones.

EntraAppAuthentication

Objeto

Configuración para un registro de aplicación Microsoft Entra propiedad del cliente utilizado para autenticación basada en credenciales federadas en nombre de la empresa.

Nombre	Tipo	Description
applicationId	string (uuid)	El ID de la aplicación (cliente) del registro de la aplicación Entra, propiedad del cliente.
federatedCredentialId	string (uuid)	El ID de credencial federado configurado en el registro de la app, permitiendo que el servicio de búsqueda se autentique como la app sin un secreto de cliente almacenado.
tenantId	string (uuid)	El ID del inquilino del registro de la app. Es obligatorio cuando el registro de la app está en un tenant diferente al del servicio de búsqueda. Si se omite, se utiliza el inquilino del servicio de búsqueda.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FabricDataAgentKnowledgeSource

Objeto

Configuración para la fuente de conocimiento del Fabric Data Agent.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
fabricDataAgentParameters	FabricDataAgentKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento del Fabric Data Agent.
kind	string: fabricDataAgent	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

FabricDataAgentKnowledgeSourceParameters

Objeto

Parámetros para la fuente de conocimiento del Fabric Data Agent.

Nombre	Tipo	Description
dataAgentId	string	Especifica a qué Fabric Data Agent acceder.
workspaceId	string	ID de espacio de trabajo Fabric.

FabricOntologyKnowledgeSource

Objeto

Configuración para Fabric Ontology fuente de conocimiento.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
fabricOntologyParameters	FabricOntologyKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento de Fabric Ontology.
kind	string: fabricOntology	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

FabricOntologyKnowledgeSourceParameters

Objeto

Fuente de datos sobre parámetros para Fabric Ontology.

Nombre	Tipo	Description
ontologyId	string	El ID de la ontología a usar desde el espacio de trabajo de Fabric.
workspaceId	string	El ID de espacio de trabajo Fabric que contiene la ontología.

FileKnowledgeSource

Objeto

Configuración para la fuente de conocimiento de archivos que soporta subida e indexación directa de archivos.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
corsOptions	CorsOptions	Opciones para controlar el Intercambio de Recursos entre Orígenes (CORS) para los extremos de archivo de la fuente de conocimiento del archivo (subir, listar, actualizar, eliminar).
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
fileParameters	FileKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento del archivo.
kind	string: file	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

FileKnowledgeSourceParameters

Objeto

Parámetros para la fuente de conocimiento del archivo.

Nombre	Tipo	Description
createdResources	object	Recursos creados por la fuente de conocimiento del archivo.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todos los ajustes generales de ingestión para la fuente de conocimiento del archivo, incluyendo el modo de extracción de contenido y un embeddingModel opcional.
queryHints	SearchIndexKnowledgeSourceQueryHints	Pistas predeterminadas que guían la planificación de consultas hacia filtros y mejoras útiles para esta fuente de conocimiento respaldada por índices. Las pistas de consulta en tiempo de solicitud reemplazan estos valores predeterminados como objeto completo.

FreshnessPolicy

Objeto

Configuración para recuperación consciente de la frescura. Cuando se establecen, los documentos más recientes reciben un aumento de ranking durante la recuperación.

Nombre	Tipo	Description
boostingDuration	string	Duración ISO 8601 para la ventana de aumento de frescura (por ejemplo, 'P90D' durante 90 días). Los documentos más recientes que esta duración reciben un aumento de clasificación durante la recuperación.

IndexedOneLakeKnowledgeSource

Objeto

Configuración para el origen de conocimiento de OneLake.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento.
kind	string: indexedOneLake	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

IndexedOneLakeKnowledgeSourceParameters

Objeto

Parámetros para el origen de conocimiento de OneLake.

Nombre	Tipo	Description
createdResources	object	Recursos creados por la fuente de conocimiento.
fabricWorkspaceId	string	ID de área de trabajo de OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas las configuraciones generales de ingesta.
lakehouseId	string	Especifica a qué casa del lago OneLake se va a acceder.
queryHints	SearchIndexKnowledgeSourceQueryHints	Pistas predeterminadas que guían la planificación de consultas hacia filtros y mejoras útiles para esta fuente de conocimiento respaldada por índices. Las pistas de consulta en tiempo de solicitud reemplazan estos valores predeterminados como objeto completo.
targetPath	string	Carpeta OneLakehouse opcional o acceso directo para filtrar el contenido de OneLake.

IndexedSharePointContainerName

Enumeración

Especifica a qué bibliotecas de SharePoint se va a acceder.

Valor	Description
defaultSiteLibrary	Indexar el contenido de la biblioteca de documentos predeterminada del sitio.
allSiteLibraries	Indexe el contenido de cada biblioteca de documentos del sitio.
useQuery	Utiliza una consulta para filtrar el contenido de SharePoint.

IndexedSharePointKnowledgeSource

Objeto

Configuración para el origen de conocimiento de SharePoint.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento.
kind	string: indexedSharePoint	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

IndexedSharePointKnowledgeSourceParameters

Objeto

Parámetros para el origen de conocimiento de SharePoint.

Nombre	Tipo	Description
connectionString	string	Cadena de conexión de SharePoint con formato: SharePointOnlineEndpoint=[URL del sitio de SharePoint]; ApplicationId=[ID de aplicación de Azure AD]; ApplicationSecret=[Secreto de cliente de la aplicación de Azure AD]; TenantId=[Id. de inquilino del sitio de SharePoint]
containerName	IndexedSharePointContainerName	Especifica a qué bibliotecas de SharePoint se va a acceder.
createdResources	object	Recursos creados por la fuente de conocimiento.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas las configuraciones generales de ingesta.
query	string	Consulta opcional para filtrar el contenido de SharePoint.
queryHints	SearchIndexKnowledgeSourceQueryHints	Pistas predeterminadas que guían la planificación de consultas hacia filtros y mejoras útiles para esta fuente de conocimiento respaldada por índices. Las pistas de consulta en tiempo de solicitud reemplazan estos valores predeterminados como objeto completo.

IndexedSqlKnowledgeSource

Objeto

Configuración para la fuente de conocimiento SQL indexada.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
indexedSqlParameters	IndexedSqlKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento SQL.
kind	string: indexedSql	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

IndexedSqlKnowledgeSourceParameters

Objeto

Parámetros para la fuente de conocimiento SQL indexada.

Nombre	Tipo	Description
connectionString	string	La cadena de conexión para Azure SQL Database o SQL Managed Instance.
contentColumns	ContentColumnMapping[]	Mapeos opcionales de columnas para campos de contenido. Si se omite, todas las columnas se descubren automáticamente.
createdResources	object	Recursos creados por la fuente de conocimiento.
embeddingColumns	EmbeddingColumnMapping[]	Mapeos opcionales de columnas para incrustar campos vectoriales. Si se omite, no se crean campos vectoriales.
highWaterMarkColumnName	string	Nombre opcional de columna para la detección de cambios de marca de agua alta. Si se proporciona, utiliza HighWaterMarkChangeDetectionPolicy.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todos los ajustes generales de ingestión, incluyendo modelo de incrustación, horario e identidad.
queryHints	SearchIndexKnowledgeSourceQueryHints	Pistas predeterminadas que guían la planificación de consultas hacia filtros y mejoras útiles para esta fuente de conocimiento respaldada por índices. Las pistas de consulta en tiempo de solicitud reemplazan estos valores predeterminados como objeto completo.
tableOrView	string	El nombre de la tabla o vista para indexar. Puede ser cualificado por esquema (por ejemplo, 'dbo. MiMesa').

IndexingSchedule

Objeto

Representa una programación para la ejecución del indexador.

Nombre	Tipo	Description
interval	string (duration)	Intervalo de tiempo entre ejecuciones del indexador.
startTime	string (date-time)	Hora en la que un indexador debe comenzar a ejecutarse.

KnowledgeBaseAzureOpenAIModel

Objeto

Especifica el recurso de Azure OpenAI que se usa para realizar la planeación de consultas.

Nombre	Tipo	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI.
kind	string: azureOpenAI	El modelo de IA que se utilizará para la planificación de consultas.

KnowledgeBaseModelKind

Enumeración

El modelo de IA que se utilizará para la planificación de consultas.

Valor	Description
azureOpenAI	Use modelos de Azure Open AI para la planeación de consultas.

KnowledgeSourceAzureOpenAIVectorizer

Objeto

Especifica el recurso de Azure OpenAI que se usa para vectorizar una cadena de consulta.

Nombre	Tipo	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Contiene los parámetros específicos de la vectorización de inserción de Azure OpenAI.
kind	string: azureOpenAI	El nombre del tipo de método de vectorización que se configura para su uso con la búsqueda vectorial.

KnowledgeSourceIngestionParameters

Objeto

Consolida todas las configuraciones generales de ingesta para los orígenes de conocimiento.

Nombre	Tipo	Valor predeterminado	Description
aiServices	AIServices		Configuración opcional de AI Services para el procesamiento de contenido.
assetStore	AssetStore		Configuración opcional de asset store para almacenar assets extraídos como imágenes.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Modelo opcional de finalización de chat para la verbalización de imágenes o la extracción de contexto.
contentExtractionMode	enum: minimal standard	minimal	Modo de extracción de contenido opcional. El valor predeterminado es 'mínimo'.
disableImageVerbalization	boolean	False	Indica si se debe desactivar la verbalización de la imagen. El valor predeterminado es falso.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Configuración opcional del vectorizador para vectorizar contenido.
freshnessPolicy	FreshnessPolicy		Política opcional de frescura para sesgar la recuperación hacia documentos más recientes.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Una identidad explícita que se usará para este origen de conocimiento.
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		Lista opcional de tipos de permisos para ingerir junto con el contenido del documento. Si se especifica, establecerá las opciones de permisos del indexador para el origen de datos.
ingestionSchedule	IndexingSchedule		Programación opcional para la ingesta de datos.
networkAccessMode	KnowledgeSourceNetworkAccessMode	public	Modo de acceso a la red opcional para la ingestión. Configura en 'privado' para ejecutar la ingestión en un entorno de ejecución privada que pueda acceder a fuentes de datos y dependencias a través de una red privada. El predeterminado es 'público'. Esta es una configuración de creación y no puede cambiarse una vez creada la fuente de conocimiento.

KnowledgeSourceIngestionPermissionOption

Enumeración

Tipos de permisos para ingerir junto con el contenido del documento.

Valor	Description
userIds	Ingiere identificadores de usuario explícitos junto con el contenido del documento.
groupIds	Ingiera identificadores de grupo junto con el contenido del documento.
rbacScope	Ingiera información del alcance de RBAC junto con el contenido del documento.
sensitivityLabels	Ingiere las etiquetas de sensibilidad de Microsoft Purview junto al contenido del documento.

KnowledgeSourceKind

Enumeración

El tipo de fuente de conocimiento.

Valor	Description
searchIndex	Un origen de conocimiento que lee datos de un índice de búsqueda.
azureBlob	Un origen de conocimiento que lee e ingiere datos de Azure Blob Storage en un índice de búsqueda.
indexedSharePoint	Una fuente de conocimiento que lee datos de SharePoint indexado.
indexedOneLake	Una fuente de conocimiento que lee datos de OneLake indexado.
indexedSql	Una fuente de conocimiento que recupera e ingirte datos de Azure SQL Database o SQL Managed Instance a un Índice de Búsqueda.
web	Una fuente de conocimiento que lee datos de la web.
remoteSharePoint	Una fuente de conocimiento que lee datos de SharePoint remoto.
workIQ	Una fuente de conocimiento que lee datos de IQ en el trabajo
file	Una fuente de conocimiento que soporta la subida e indexación directa de archivos.
mcpServer	Una fuente de conocimiento respaldada por un servidor MCP (Model Context Protocol).
fabricDataAgent	Una fuente de conocimiento que recupera datos de un Fabric Data Agent.
fabricOntology	Una fuente de conocimiento que recupera datos de las ontologías de Microsoft Fabric Ontology.

KnowledgeSourceNetworkAccessMode

Enumeración

Especifica el modo de acceso a la red para la ingestión de fuentes de conocimiento. El predeterminado es 'público'.

Valor	Description
public	La ingestión se ejecuta en el entorno estándar y accesible públicamente. Este es el valor predeterminado.
private	La ingestión se ejecuta en un entorno de ejecución privada para poder acceder a fuentes de datos y dependencias a través de una red privada (punto final privado / enlace privado compartido).

KnowledgeSourceResultsProcessing

Enumeración

Controla si los resultados de una fuente de conocimiento se reclasifican.

Valor	Description
rerank	Los resultados de esta fuente de conocimiento pasan por la cadena de reclasificación. Este es el comportamiento predeterminado.
none	Los resultados de esta fuente de conocimiento evitan la reclasificación y preservan su orden subyacente.

McpServerAuthenticationKind

Enumeración

El tipo de autenticación para un servidor MCP.

Valor	Description
foundryConnection	Autentica usando una conexión de Fundición de IA de Azure.
storedHeaders	Autentica usando cabeceras HTTP almacenadas.

McpServerAutoOutputParsing

Objeto

Detecta automáticamente el formato de salida y analiza en consecuencia.

Nombre	Tipo	Description
kind	string: auto	El tipo de análisis de salida que se aplica.

McpServerFoundryConnectionAuthentication

Objeto

Autenticación usando una conexión de Fundición de IA de Azure.

Nombre	Tipo	Description
foundryConnectionParameters	McpServerFoundryConnectionParameters	Parámetros para la autenticación de conexiones con Foundry.
kind	string: foundryConnection	El tipo de autenticación que hay que usar.

McpServerFoundryConnectionParameters

Objeto

Parámetros para la autenticación de conexiones con Foundry.

Nombre	Tipo	Description
connectionId	string	El identificador de conexión Fundición de IA de Azure.

McpServerJsonOutputParsing

Objeto

Analiza la salida como un documento JSON usando los parámetros JSON configurados.

Nombre	Tipo	Description
jsonParameters	McpServerOutputParsingJsonParameters	Parámetros para análisis de salida JSON. Obligatorio cuando es 'json'.
kind	string: json	El tipo de análisis de salida que se aplica.

McpServerKnowledgeSource

Objeto

Configuración de una fuente de conocimiento respaldada por un servidor MCP (Model Context Protocol).

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
kind	string: mcpServer	El tipo de fuente de conocimiento.
mcpServerParameters	McpServerKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento del servidor MCP.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

McpServerKnowledgeSourceParameters

Objeto

Parámetros para la fuente de conocimiento de un servidor MCP.

Nombre	Tipo	Description
authentication	McpServerAuthentication: McpServerFoundryConnectionAuthentication McpServerStoredHeadersAuthentication	La configuración de autenticación para el servidor MCP.
serverURL	string	La URL del endpoint del servidor MCP.
tools	McpServerTool[]	La lista de herramientas para invocar en el servidor MCP.

McpServerNoneOutputParsing

Objeto

Trata la salida como un solo bloque sin ningún análisis sintáctico.

Nombre	Tipo	Description
kind	string: none	El tipo de análisis de salida que se aplica.

McpServerOutputParsingJsonParameters

Objeto

Parámetros para análisis de salida JSON.

Nombre	Tipo	Description
documentsPath	string	El camino JSON hacia el array de documentos en la salida de la herramienta.
includeContext	boolean	Si incluir el contexto circundante de la salida JSON junto a los documentos extraídos.

McpServerOutputParsingKind

Enumeración

El tipo de análisis sintáctico de salida para una herramienta de servidor MCP.

Valor	Description
auto	Detecta automáticamente el formato de salida y analiza en consecuencia.
json	Analiza la salida como un documento JSON usando los parámetros JSON configurados.
split	Divide la salida en páginas usando los parámetros de división configurados.
none	Trata la salida como un solo bloque sin ningún análisis sintáctico.

McpServerOutputParsingSplitParameters

Objeto

Parámetros para análisis de salida dividida.

Nombre	Tipo	Description
defaultLanguageCode	SplitSkillLanguage	Valor que indica qué código de lenguaje se va a usar. El valor predeterminado es `en`.
maximumPageLength	integer (int32)	El número máximo de caracteres por página.
maximumPagesToTake	integer (int32)	El número máximo de páginas que se pueden extraer de la salida.
pageOverlapLength	integer (int32)	El número de caracteres que se solapan entre páginas.
textSplitMode	TextSplitMode	El modo de división de texto para usar.

McpServerSplitOutputParsing

Objeto

Divide la salida en páginas usando los parámetros de división configurados.

Nombre	Tipo	Description
kind	string: split	El tipo de análisis de salida que se aplica.
splitParameters	McpServerOutputParsingSplitParameters	Parámetros para análisis de salida dividida.

McpServerStoredHeadersAuthentication

Objeto

Autenticación usando cabeceras HTTP almacenadas.

Nombre	Tipo	Description
kind	string: storedHeaders	El tipo de autenticación que hay que usar.
storedHeadersParameters	McpServerStoredHeadersParameters	Parámetros para la autenticación de cabeceras almacenadas.

McpServerStoredHeadersParameters

Objeto

Parámetros para la autenticación de cabeceras almacenadas.

Nombre	Tipo	Description
headers	object	Los encabezados HTTP almacenados para incluir en las solicitudes del servidor MCP.

McpServerTool

Objeto

Representa una única herramienta dentro de una fuente de conocimiento de un servidor MCP.

Nombre	Tipo	Description
maxOutputTokens	integer (int32)	Un límite opcional de token post-análisis para la salida de esta herramienta. Debe ser mayor que 0 cuando se especifica.
name	string	Nombre de la herramienta MCP que se va a invocar.
outputParsing	McpServerOutputParsing: McpServerAutoOutputParsing McpServerJsonOutputParsing McpServerNoneOutputParsing McpServerSplitOutputParsing	Configuración opcional para analizar la salida de la herramienta.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados analizados de esta herramienta se reclasifican. Por defecto se pone en 'reclasificar' cuando no se especifica.

RemoteSharePointKnowledgeSource

Objeto

Configuración para el origen de conocimiento remoto de SharePoint.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
kind	string: remoteSharePoint	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento remota de SharePoint.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.

RemoteSharePointKnowledgeSourceParameters

Objeto

Parámetros para el origen de conocimiento remoto de SharePoint.

Nombre	Tipo	Description
containerTypeId	string	Identificador de contenedor para la conexión de SharePoint Embedded. Cuando es null, usará SharePoint Online.
filterExpression	string	Expresión de lenguaje de consulta de palabras clave (KQL) con propiedades y atributos de SharePoint consultables para determinar el ámbito de la recuperación antes de que se ejecute la consulta.
resourceMetadata	string[]	Una lista de campos de metadatos que se devolverán para cada elemento de la respuesta. Solo se pueden incluir en esta lista propiedades de metadatos recuperables. De forma predeterminada, no se devuelven metadatos.

SearchIndexerDataNoneIdentity

Objeto

Borra la propiedad de identidad de un origen de datos.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragmento de URI que especifica el tipo de identidad.

SearchIndexerDataUserAssignedIdentity

Objeto

Especifica la identidad de un origen de datos que se va a usar.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragmento de URI que especifica el tipo de identidad.
federatedIdentityClientId	string	Soporte de Identidad Gestionada User-Assigned Multi-inquilino: El id de cliente de la aplicación multi-tenente configurada para federarse con la identidad gestionada asignada por el usuario.
userAssignedIdentity	string	El identificador de recurso de Azure completo 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 se debe haber asignado al servicio de búsqueda.

SearchIndexFieldReference

Objeto

Referencia de campo para un índice de búsqueda.

Nombre	Tipo	Description
name	string	Nombre del campo.

SearchIndexKnowledgeSource

Objeto

Fuente de conocimiento dirigida a un índice de búsqueda.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
kind	string: searchIndex	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento.

SearchIndexKnowledgeSourceBoostKind

Enumeración

El tipo de consejo de impulso para una fuente de conocimiento de un índice de búsqueda.

Valor	Description
fieldValue	Mejora los documentos basándote en un valor de campo.
multiWordExpression	Mejora documentos basados en una expresión de varias palabras.

SearchIndexKnowledgeSourceFieldValueBoost

Objeto

Una pista que mejora documentos basándose en el valor de un campo.

Nombre	Tipo	Description
boost	number (double)	Un multiplicador para la puntuación del documento. Debe ser un número positivo no igual a 1,0.
boostInstructions	string	Instrucciones en lenguaje natural que expliquen cuándo y cómo aplicar el impulso.
field	string minLength: 1	El nombre del campo índice de búsqueda.
fieldValues	string[]	Valores representativos para el campo.
kind	string: fieldValue	Ese tipo de pista de impulso.

SearchIndexKnowledgeSourceFilterHint

Objeto

Una pista que identifica un campo y valores representativos que el planificador de consultas puede usar al construir un filtro.

Nombre	Tipo	Description
field	string minLength: 1	El nombre del campo índice de búsqueda filtrable.
fieldValues	string[]	Valores representativos para el campo.
filterInstructions	string	Instrucciones en lenguaje natural que expliquen cuándo y cómo filtrar en el campo.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Objeto

Una pista que mejora los documentos basándose en una expresión de varias palabras.

Nombre	Tipo	Description
boost	number (double)	Un multiplicador para la puntuación del documento. Debe ser un número positivo no igual a 1,0.
boostInstructions	string	Instrucciones en lenguaje natural que expliquen cuándo y cómo aplicar el impulso.
fieldValues	string[]	Valores representativos para el impulso.
kind	string: multiWordExpression	Ese tipo de pista de impulso.

SearchIndexKnowledgeSourceParameters

Objeto

Parámetros para el origen de conocimiento del índice de búsqueda.

Nombre	Tipo	Description
baseFilter	string	Una condición de filtro por defecto aplicada al índice en el momento de la recuperación (por ejemplo, 'Eq de estado VA'). Puede ser anulado en tiempo de consulta mediante parámetros de ejecución de la fuente de conocimiento.
queryHints	SearchIndexKnowledgeSourceQueryHints	Consejos por defecto que guían la planificación de consultas hacia filtros y mejoras útiles para esta fuente de conocimiento del índice de búsqueda. Las pistas de consulta en tiempo de solicitud reemplazan estos valores predeterminados como objeto completo.
searchFields	SearchIndexFieldReference[]	Se utiliza para restringir los campos que se buscan en el índice de búsqueda.
searchIndexName	string	El nombre del índice de búsqueda.
semanticConfigurationName	string	Se utiliza para especificar una configuración semántica diferente en el índice de búsqueda de destino distinta de la predeterminada.
sourceDataFields	SearchIndexFieldReference[]	Se utiliza para solicitar campos adicionales para los datos de origen a los que se hace referencia.

SearchIndexKnowledgeSourceQueryHints

Objeto

Consejos que guían la planificación de consultas hacia filtros útiles y mejoras para una fuente de conocimiento de índice de búsqueda.

Nombre	Tipo	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Potenciar las pistas que identifican condiciones que el planificador de consultas puede usar para influir en el posicionamiento de los documentos.
filters	SearchIndexKnowledgeSourceFilterHint[]	Pistas de filtro que identifican campos y valores representativos que el planificador de consultas puede usar al construir filtros.

SearchResourceEncryptionKey

Objeto

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	Valor predeterminado	Description
accessCredentials.applicationId	string		Un identificador de aplicación de AAD al que se concedieron los permisos de acceso necesarios a Azure Key Vault que se va a usar al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el id. de objeto de la aplicación de AAD.
accessCredentials.applicationSecret	string		Clave de autenticación de la aplicación de AAD especificada.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Una identidad administrada explícita que se va a 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 al recurso, si la identidad explícita no está especificada, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad.
isServiceLevelKey	boolean	False	Un valor opcional que indica si esta clave es una clave de nivel de servicio. El valor predeterminado es falso.
keyVaultKeyName	string		Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.
keyVaultKeyVersion	string		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 denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un URI de ejemplo podría ser `https://my-keyvault-name.vault.azure.net`.

SplitSkillLanguage

Enumeración

Los códigos de idioma admitidos para el texto de entrada por SplitSkill.

Valor	Description
am	Amharic
bs	Bosnian
cs	Checo
da	Danés
de	German
en	English
es	Spanish
et	Estonio
fi	Finlandés
fr	French
he	Hebreo
hi	hindi
hr	Croatian
hu	Húngaro
id	indonesio
is	Islandés
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	Ruso
sk	Slovak
sl	Esloveno
sr	Serbio
sv	Sueco
tr	Turco
ur	Urdú
zh	Chino (simplificado)

TextSplitMode

Enumeración

Valor que indica qué modo de división se va a realizar.

Valor	Description
pages	Divida el texto en páginas individuales.
sentences	Divida el texto en oraciones individuales.

VectorSearchVectorizerKind

Enumeración

El método de vectorización que se utilizará durante el tiempo de consulta.

Valor	Description
azureOpenAI	Genere incrustaciones mediante un recurso de Azure OpenAI en el momento de la consulta.
customWebApi	Genere incrustaciones mediante un punto de conexión web personalizado en el momento de la consulta.
aiServicesVision	Genere incrustaciones para una entrada de imagen o texto en el momento de la consulta mediante Azure AI Services Vision Vectorize API.
aml	Genere inserciones mediante un punto de conexión de Azure Machine Learning implementado a través del catálogo de modelos de Fundición de IA de Azure en el momento de la consulta.

WebKnowledgeSource

Objeto

Fuente de conocimiento dirigida a resultados web.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
kind	string: web	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.
webParameters	WebKnowledgeSourceParameters	Los parámetros de la fuente de conocimiento web.

WebKnowledgeSourceDomain

Objeto

Configuración para el dominio de origen de conocimiento web.

Nombre	Tipo	Description
address	string	La dirección del dominio.
includeSubpages	boolean	Si se deben incluir o no subpáginas de este dominio.

WebKnowledgeSourceDomains

Objeto

Configuración de dominio/bloqueo para el origen de conocimiento web.

Nombre	Tipo	Description
allowedDomains	WebKnowledgeSourceDomain[]	Dominios que están permitidos para resultados web.
blockedDomains	WebKnowledgeSourceDomain[]	Dominios bloqueados en los resultados web.

WebKnowledgeSourceParameters

Objeto

Parámetros para el origen de conocimiento web.

Nombre	Tipo	Description
count	integer (int32)	El número por defecto de resultados web que se devuelven. Puede ser anulado en tiempo de consulta mediante parámetros de ejecución de la fuente de conocimiento.
domains	WebKnowledgeSourceDomains	Configuración de dominio/bloqueo de permitidos para resultados web.
freshness	string	El filtro de frescura por defecto para resultados web. Puede ser anulado en tiempo de consulta mediante parámetros de ejecución de la fuente de conocimiento.
language	string	El lenguaje predeterminado para los resultados web. Puede ser anulado en tiempo de consulta mediante parámetros de ejecución de la fuente de conocimiento.
market	string	El mercado predeterminado para resultados web. Puede ser anulado en tiempo de consulta mediante parámetros de ejecución de la fuente de conocimiento.

WorkIQKnowledgeSource

Objeto

Configuración para la fuente de conocimiento de WorkIQ.

Nombre	Tipo	Description
@odata.etag	string	El ETag de la fuente de conocimiento.
description	string	Descripción opcional definida por el usuario.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se utiliza para proporcionar un nivel adicional de cifrado en reposo para la definición de la fuente de conocimiento cuando quieres la total seguridad de que nadie, ni siquiera Microsoft, puede descifrarlas. Una vez que hayas cifrado la definición de tu fuente de conocimiento, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puedes cambiar esta propiedad según lo necesites si quieres rotar tu clave de cifrado; La definición de tu fuente de conocimiento 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.
kind	string: workIQ	El tipo de fuente de conocimiento.
name	string	El nombre de la fuente de conocimiento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla si los resultados de esta fuente de conocimiento se reclasifican antes de incluirse en el conjunto final de resultados. Por defecto se pone en 'reclasificar' cuando no se especifica.
workIQParameters	WorkIQKnowledgeSourceParameters	Los parámetros para la fuente de conocimiento de WorkIQ, incluyendo la configuración de la app Entra, propiedad del cliente, utilizada para la autenticación en nombre de la empresa.

WorkIQKnowledgeSourceParameters

Objeto

Parámetros para una fuente de conocimiento WorkIQ.

Nombre	Tipo	Description
entraAppAuthentication	EntraAppAuthentication	La configuración de registro de la aplicación Microsoft Entra, propiedad del cliente, se utiliza para la autenticación en nombre de la API Work IQ. El cliente registra una aplicación Entra propiedad del inquilino, le concede el permiso delegado WorkIQAgent.Ask y configura una credencial federada para que Búsqueda de Azure AI pueda autenticarse como esa app sin un secreto de cliente almacenado.