Knowledge Sources - Create Or Update

Servizio:: Search Service

Versione API:: 2025-11-01-preview

Crea una nuova origine informazioni o aggiorna un'origine informazioni se esiste già.

PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2025-11-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	URL dell'endpoint del servizio di ricerca.
sourceName	path	True	string	Il nome dell'origine della conoscenza.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Accept		Accept	L'intestazione Accetta.
If-Match		string	Definisce la condizione di If-Match. L'operazione verrà eseguita solo se l'ETag sul server corrisponde a questo valore.
If-None-Match		string	Definisce la condizione If-None-Match. L'operazione verrà eseguita solo se l'ETag sul server non corrisponde a questo valore.
Prefer	True	Prefer	Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.
x-ms-client-request-id		string (uuid)	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Corpo della richiesta

Il corpo della richiesta può essere uno dei seguenti:

Nome	Descrizione
AzureBlobKnowledgeSource	Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure.
IndexedOneLakeKnowledgeSource	Configurazione per l'origine della conoscenza OneLake.
IndexedSharePointKnowledgeSource	Configurazione per l'origine della conoscenza di SharePoint.
RemoteSharePointKnowledgeSource	Configurazione per l'origine della conoscenza remota di SharePoint.
SearchIndexKnowledgeSource	Origine conoscenza destinata a un indice di ricerca.
WebKnowledgeSource	Risultati Web di targeting della Knowledge Source.

AzureBlobKnowledgeSource

Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure.

Nome	Necessario	Tipo	Descrizione
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Tipo di origine della conoscenza.
kind	True	string: azureBlob	Tipo di origine della conoscenza.
name	True	string	Il nome dell'origine della conoscenza.
@odata.etag		string	L'ETag della fonte di conoscenza.
description		string	Descrizione facoltativa definita dall'utente.
encryptionKey		SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.

IndexedOneLakeKnowledgeSource

Configurazione per l'origine della conoscenza OneLake.

Nome	Necessario	Tipo	Descrizione
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Parametri per l'origine della conoscenza.
kind	True	string: indexedOneLake	Tipo di origine della conoscenza.
name	True	string	Il nome dell'origine della conoscenza.
@odata.etag		string	L'ETag della fonte di conoscenza.
description		string	Descrizione facoltativa definita dall'utente.
encryptionKey		SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.

IndexedSharePointKnowledgeSource

Configurazione per l'origine della conoscenza di SharePoint.

Nome	Necessario	Tipo	Descrizione
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Parametri per l'origine della conoscenza.
kind	True	string: indexedSharePoint	Tipo di origine della conoscenza.
name	True	string	Il nome dell'origine della conoscenza.
@odata.etag		string	L'ETag della fonte di conoscenza.
description		string	Descrizione facoltativa definita dall'utente.
encryptionKey		SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.

RemoteSharePointKnowledgeSource

Configurazione per l'origine della conoscenza remota di SharePoint.

Nome	Necessario	Tipo	Descrizione
kind	True	string: remoteSharePoint	Tipo di origine della conoscenza.
name	True	string	Il nome dell'origine della conoscenza.
@odata.etag		string	L'ETag della fonte di conoscenza.
description		string	Descrizione facoltativa definita dall'utente.
encryptionKey		SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	I parametri per la sorgente di conoscenza remota di SharePoint.

SearchIndexKnowledgeSource

Origine conoscenza destinata a un indice di ricerca.

Nome	Necessario	Tipo	Descrizione
kind	True	string: searchIndex	Tipo di origine della conoscenza.
name	True	string	Il nome dell'origine della conoscenza.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Parametri per l'origine della conoscenza.
@odata.etag		string	L'ETag della fonte di conoscenza.
description		string	Descrizione facoltativa definita dall'utente.
encryptionKey		SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.

WebKnowledgeSource

Risultati Web di targeting della Knowledge Source.

Nome	Necessario	Tipo	Descrizione
kind	True	string: web	Tipo di origine della conoscenza.
name	True	string	Il nome dell'origine della conoscenza.
@odata.etag		string	L'ETag della fonte di conoscenza.
description		string	Descrizione facoltativa definita dall'utente.
encryptionKey		SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
webParameters		WebKnowledgeSourceParameters	I parametri per l'origine della conoscenza Web.

Risposte

Nome	Tipo	Descrizione
200 OK	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	La richiesta ha avuto esito positivo.
201 Created	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

api-key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://search.azure.com/.default

Esempio

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSource

Esempio di richiesta

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-11-01-preview





{
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig"
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "@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>"
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "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",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

Codice di stato:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "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",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

Esempio di richiesta

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-11-01-preview





{
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "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>"
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "@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",
    "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": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

Codice di stato:: 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",
    "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": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

Esempio di richiesta

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-11-01-preview





{
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "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>"
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "@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",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

Codice di stato:: 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",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

Esempio di richiesta

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-11-01-preview





{
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "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>"
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "@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",
    "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",
        "rbacScope"
      ],
      "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"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

Codice di stato:: 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",
    "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",
        "rbacScope"
      ],
      "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"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

Esempio di richiesta

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-11-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>"
    }
  }
}

Risposta di esempio

Codice di stato:: 200

{
  "@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",
    "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
        }
      ]
    }
  }
}

Codice di stato:: 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",
    "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
        }
      ]
    }
  }
}

Definizioni

Nome	Descrizione
Accept	L'intestazione Accetta.
AIServices	Parametri per i servizi di IA.
AzureBlobKnowledgeSource	Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure.
AzureBlobKnowledgeSourceParameters	Parametri per l'origine della conoscenza di Archiviazione BLOB di Azure.
AzureOpenAIModelName	Nome del modello Azure Open AI che verrà chiamato.
AzureOpenAIVectorizerParameters	Specifica i parametri per la connessione alla risorsa OpenAI di Azure.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
IndexedOneLakeKnowledgeSource	Configurazione per l'origine della conoscenza OneLake.
IndexedOneLakeKnowledgeSourceParameters	Parametri per l'origine della conoscenza OneLake.
IndexedSharePointContainerName	Specifica le raccolte di SharePoint a cui accedere.
IndexedSharePointKnowledgeSource	Configurazione per l'origine della conoscenza di SharePoint.
IndexedSharePointKnowledgeSourceParameters	Parametri per l'origine della conoscenza di SharePoint.
IndexingSchedule	Rappresenta una pianificazione per l'esecuzione dell'indicizzatore.
KnowledgeBaseAzureOpenAIModel	Specifica la risorsa Azure OpenAI usata per eseguire la pianificazione delle query.
KnowledgeBaseModelKind	Modello di intelligenza artificiale da utilizzare per la pianificazione delle query.
KnowledgeSourceAzureOpenAIVectorizer	Specifica la risorsa Azure OpenAI usata per vettorializzare una stringa di query.
KnowledgeSourceIngestionParameters	Consolida tutte le impostazioni generali di acquisizione per le fonti di conoscenza.
KnowledgeSourceIngestionPermissionOption	Tipi di permesso da ingerire insieme al contenuto del documento.
KnowledgeSourceKind	Il tipo di fonte di conoscenza.
Prefer	Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.
RemoteSharePointKnowledgeSource	Configurazione per l'origine della conoscenza remota di SharePoint.
RemoteSharePointKnowledgeSourceParameters	Parametri per l'origine della conoscenza remota di SharePoint.
SearchIndexerDataNoneIdentity	Cancella la proprietà Identity di un'origine dati.
SearchIndexerDataUserAssignedIdentity	Specifica l'identità di un'origine dati da usare.
SearchIndexFieldReference	Riferimento di campo per un indice di ricerca.
SearchIndexKnowledgeSource	Origine conoscenza destinata a un indice di ricerca.
SearchIndexKnowledgeSourceParameters	Parametri per l'origine della conoscenza dell'indice di ricerca.
SearchResourceEncryptionKey	Una chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite dall'utente possono essere utilizzate per crittografare o decrittografare i dati inattivi, ad esempio indici e mappe di sinonimi.
VectorSearchVectorizerKind	Metodo di vettorizzazione da utilizzare durante la fase di query.
WebKnowledgeSource	Risultati Web di targeting della Knowledge Source.
WebKnowledgeSourceDomain	Configurazione per il dominio di origine della conoscenza Web.
WebKnowledgeSourceDomains	Configurazione del dominio che consente/blocca per l'origine della conoscenza Web.
WebKnowledgeSourceParameters	Parametri per la fonte di conoscenza web.

Accept

Enumerazione

L'intestazione Accetta.

Valore	Descrizione
application/json;odata.metadata=minimal

AIServices

Oggetto

Parametri per i servizi di IA.

Nome	Tipo	Descrizione
apiKey	string	La chiave API per l'accesso ai servizi di intelligenza artificiale.
uri	string (uri)	URI dell'endpoint di AI Services.

AzureBlobKnowledgeSource

Oggetto

Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
@odata.etag	string	L'ETag della fonte di conoscenza.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Tipo di origine della conoscenza.
description	string	Descrizione facoltativa definita dall'utente.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
kind	string: azureBlob	Tipo di origine della conoscenza.
name	string	Il nome dell'origine della conoscenza.

AzureBlobKnowledgeSourceParameters

Oggetto

Parametri per l'origine della conoscenza di Archiviazione BLOB di Azure.

Nome	Tipo	Valore predefinito	Descrizione
connectionString	string		Stringa di connessione basata su chiave o il formato ResourceId se si usa un'identità gestita.
containerName	string		Nome del contenitore di archiviazione BLOB.
createdResources	object		Risorse create dall'origine della conoscenza.
folderPath	string		Percorso della cartella facoltativo all'interno del contenitore.
ingestionParameters	KnowledgeSourceIngestionParameters		Consolida tutte le impostazioni generali di ingestione.
isADLSGen2	boolean	False	Impostare su true se ci si connette a un account di archiviazione ADLS Gen2. Il valore predefinito è false.

AzureOpenAIModelName

Enumerazione

Nome del modello Azure Open AI che verrà chiamato.

Valore	Descrizione
text-embedding-ada-002	Modello TextEmbeddingAda002.
text-embedding-3-large	TextEmbedding3Large model.
text-embedding-3-small	Modello Incorporato3Piccolo.
gpt-4o	Modello GPT4o.
gpt-4o-mini	Modello Gpt4oMini.
gpt-4.1	Modello GPT41.
gpt-4.1-mini	Modello GPT41Mini.
gpt-4.1-nano	Modello Gpt41Nano.
gpt-5	Modello GPT5.
gpt-5-mini	Modello GPT5Mini.
gpt-5-nano	Modello Gpt5Nano.

AzureOpenAIVectorizerParameters

Oggetto

Specifica i parametri per la connessione alla risorsa OpenAI di Azure.

Nome	Tipo	Descrizione
apiKey	string	Chiave API della risorsa OpenAI di Azure designata.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identità gestita assegnata dall'utente usata per le connessioni in uscita.
deploymentId	string	ID della distribuzione del modello OpenAI di Azure nella risorsa designata.
modelName	AzureOpenAIModelName	Nome del modello di incorporamento distribuito nel percorso deploymentId specificato.
resourceUri	string (uri)	URI della risorsa OpenAI di Azure.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

IndexedOneLakeKnowledgeSource

Oggetto

Configurazione per l'origine della conoscenza OneLake.

Nome	Tipo	Descrizione
@odata.etag	string	L'ETag della fonte di conoscenza.
description	string	Descrizione facoltativa definita dall'utente.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Parametri per l'origine della conoscenza.
kind	string: indexedOneLake	Tipo di origine della conoscenza.
name	string	Il nome dell'origine della conoscenza.

IndexedOneLakeKnowledgeSourceParameters

Oggetto

Parametri per l'origine della conoscenza OneLake.

Nome	Tipo	Descrizione
createdResources	object	Risorse create dall'origine della conoscenza.
fabricWorkspaceId	string	ID area di lavoro OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida tutte le impostazioni generali di ingestione.
lakehouseId	string	Specifica a quale lakehouse OneLake accedere.
targetPath	string	Cartella OneLakehouse opzionale o scorciatoia per filtrare i contenuti OneLake.

IndexedSharePointContainerName

Enumerazione

Specifica le raccolte di SharePoint a cui accedere.

Valore	Descrizione
defaultSiteLibrary	Indicizzare il contenuto dalla raccolta documenti predefinita del sito.
allSiteLibraries	Indicizzare il contenuto di ogni raccolta documenti del sito.
useQuery	Usa una query per filtrare i contenuti di SharePoint.

IndexedSharePointKnowledgeSource

Oggetto

Configurazione per l'origine della conoscenza di SharePoint.

Nome	Tipo	Descrizione
@odata.etag	string	L'ETag della fonte di conoscenza.
description	string	Descrizione facoltativa definita dall'utente.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Parametri per l'origine della conoscenza.
kind	string: indexedSharePoint	Tipo di origine della conoscenza.
name	string	Il nome dell'origine della conoscenza.

IndexedSharePointKnowledgeSourceParameters

Oggetto

Parametri per l'origine della conoscenza di SharePoint.

Nome	Tipo	Descrizione
connectionString	string	Stringa di connessione SharePoint con formato: SharePointOnlineEndpoint=[URL del sito SharePoint]; ApplicationId=[ID app Azure AD]; ApplicationSecret=[Segreto client dell'app Azure AD]; TenantId=[ID tenant del sito SharePoint]
containerName	IndexedSharePointContainerName	Specifica le raccolte di SharePoint a cui accedere.
createdResources	object	Risorse create dall'origine della conoscenza.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida tutte le impostazioni generali di ingestione.
query	string	Query facoltativa per filtrare il contenuto di SharePoint.

IndexingSchedule

Oggetto

Rappresenta una pianificazione per l'esecuzione dell'indicizzatore.

Nome	Tipo	Descrizione
interval	string (duration)	Intervallo di tempo tra le esecuzioni dell'indicizzatore.
startTime	string (date-time)	Ora in cui deve iniziare l'esecuzione di un indicizzatore.

KnowledgeBaseAzureOpenAIModel

Oggetto

Specifica la risorsa Azure OpenAI usata per eseguire la pianificazione delle query.

Nome	Tipo	Descrizione
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Parametri Azure OpenAI.
kind	string: azureOpenAI	Modello di intelligenza artificiale da utilizzare per la pianificazione delle query.

KnowledgeBaseModelKind

Enumerazione

Modello di intelligenza artificiale da utilizzare per la pianificazione delle query.

Valore	Descrizione
azureOpenAI	Usa i modelli di Azure Open AI per la pianificazione delle query.

KnowledgeSourceAzureOpenAIVectorizer

Oggetto

Specifica la risorsa Azure OpenAI usata per vettorializzare una stringa di query.

Nome	Tipo	Descrizione
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Contiene i parametri specifici della vettorizzazione di incorporamento di Azure OpenAI.
kind	string: azureOpenAI	Nome del tipo di metodo di vettorizzazione configurato per l'utilizzo con la ricerca vettoriale.

KnowledgeSourceIngestionParameters

Oggetto

Consolida tutte le impostazioni generali di acquisizione per le fonti di conoscenza.

Nome	Tipo	Valore predefinito	Descrizione
aiServices	AIServices		Configurazione opzionale dei servizi di intelligenza artificiale per l'elaborazione dei contenuti.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Modello di completamento della chat opzionale per la verbalizzazione delle immagini o l'estrazione del contesto.
contentExtractionMode	enum: minimal standard	minimal	Modalità di estrazione dei contenuti opzionale. Il valore predefinito è 'minimal'.
disableImageVerbalization	boolean	False	Indica se la verbalizzazione dell'immagine deve essere disabilitata. Il valore predefinito è false.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Configurazione vettorizzatore opzionale per la vettorializzazione dei contenuti.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Un'identità esplicita da utilizzare per questa fonte di conoscenza.
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		Elenco facoltativo di tipi di autorizzazione da inserire insieme al contenuto del documento. Se specificato, verranno impostate le opzioni di autorizzazione dell'indicizzatore per l'origine dati.
ingestionSchedule	IndexingSchedule		Pianificazione facoltativa per l'inserimento dei dati.

KnowledgeSourceIngestionPermissionOption

Enumerazione

Tipi di permesso da ingerire insieme al contenuto del documento.

Valore	Descrizione
userIds	Acquisisci identificatori utente espliciti insieme al contenuto del documento.
groupIds	Acquisisci identificatori di gruppo insieme al contenuto del documento.
rbacScope	Inserire le informazioni sull'ambito RBAC insieme al contenuto del documento.

KnowledgeSourceKind

Enumerazione

Il tipo di fonte di conoscenza.

Valore	Descrizione
searchIndex	Origine della conoscenza che legge i dati da un indice di ricerca.
azureBlob	Un'origine delle informazioni che legge e inserisce dati da Archiviazione BLOB di Azure in un indice di ricerca.
indexedSharePoint	Una fonte di conoscenza che legge dati da SharePoint indicizzato.
indexedOneLake	Una fonte di conoscenza che legge dati da OneLake indicizzato.
web	Una fonte di conoscenza che legge dati dal web.
remoteSharePoint	Una fonte di conoscenza che legge dati da SharePoint remoto.

Prefer

Enumerazione

Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.

Valore	Descrizione
return=representation

RemoteSharePointKnowledgeSource

Oggetto

Configurazione per l'origine della conoscenza remota di SharePoint.

Nome	Tipo	Descrizione
@odata.etag	string	L'ETag della fonte di conoscenza.
description	string	Descrizione facoltativa definita dall'utente.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
kind	string: remoteSharePoint	Tipo di origine della conoscenza.
name	string	Il nome dell'origine della conoscenza.
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	I parametri per la sorgente di conoscenza remota di SharePoint.

RemoteSharePointKnowledgeSourceParameters

Oggetto

Parametri per l'origine della conoscenza remota di SharePoint.

Nome	Tipo	Descrizione
containerTypeId	string	ID contenitore per la connessione SharePoint Embedded. Quando è null, utilizzerà SharePoint Online.
filterExpression	string	Espressione KQL (Keyword Query Language) con proprietà e attributi di SharePoint interrogabili per definire l'ambito del recupero prima dell'esecuzione della query.
resourceMetadata	string[]	Elenco di campi di metadati da restituire per ogni elemento della risposta. In questo elenco possono essere incluse solo le proprietà dei metadati recuperabili. Per impostazione predefinita, non viene restituito alcun metadino.

SearchIndexerDataNoneIdentity

Oggetto

Cancella la proprietà Identity di un'origine dati.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Frammento di URI che specifica il tipo di identità.

SearchIndexerDataUserAssignedIdentity

Oggetto

Specifica l'identità di un'origine dati da usare.

Nome	Tipo	Descrizione
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Frammento di URI che specifica il tipo di identità.
userAssignedIdentity	string	L'ID risorsa di Azure completo di un'identità gestita assegnata all'utente, in genere nel formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" che avrebbe dovuto essere assegnato al servizio di ricerca.

SearchIndexFieldReference

Oggetto

Riferimento di campo per un indice di ricerca.

Nome	Tipo	Descrizione
name	string	Nome del campo.

SearchIndexKnowledgeSource

Oggetto

Origine conoscenza destinata a un indice di ricerca.

Nome	Tipo	Descrizione
@odata.etag	string	L'ETag della fonte di conoscenza.
description	string	Descrizione facoltativa definita dall'utente.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
kind	string: searchIndex	Tipo di origine della conoscenza.
name	string	Il nome dell'origine della conoscenza.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Parametri per l'origine della conoscenza.

SearchIndexKnowledgeSourceParameters

Oggetto

Parametri per l'origine della conoscenza dell'indice di ricerca.

Nome	Tipo	Descrizione
searchFields	SearchIndexFieldReference[]	Utilizzato per limitare i campi in cui eseguire la ricerca nell'indice di ricerca.
searchIndexName	string	Nome dell'indice di ricerca.
semanticConfigurationName	string	Utilizzato per specificare una configurazione semantica diversa nell'indice di ricerca di destinazione diversa da quella predefinita.
sourceDataFields	SearchIndexFieldReference[]	Utilizzato per richiedere campi aggiuntivi per i dati di origine a cui si fa riferimento.

SearchResourceEncryptionKey

Oggetto

Una chiave di crittografia gestita dal cliente in Azure Key Vault. Le chiavi create e gestite dall'utente possono essere utilizzate per crittografare o decrittografare i dati inattivi, ad esempio indici e mappe di sinonimi.

Nome	Tipo	Descrizione
accessCredentials.applicationId	string	ID applicazione AAD a cui sono state concesse le autorizzazioni di accesso necessarie all'insieme di credenziali delle chiavi di Azure da usare durante la crittografia dei dati inattivi. L'ID applicazione non deve essere confuso con l'ID oggetto per l'applicazione AAD.
accessCredentials.applicationSecret	string	Chiave di autenticazione dell'applicazione AAD specificata.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identità gestita esplicita da usare per questa chiave di crittografia. Se non specificato e la proprietà delle credenziali di accesso è Null, viene usata l'identità gestita assegnata dal sistema. Se l'identità esplicita non viene specificata, l'aggiornamento alla risorsa rimane invariato. Se si specifica "none", il valore di questa proprietà viene cancellato.
keyVaultKeyName	string	Nome della chiave di Azure Key Vault da usare per crittografare i dati inattivi.
keyVaultKeyVersion	string	Versione della chiave di Azure Key Vault da usare per crittografare i dati inattivi.
keyVaultUri	string	L'URI dell'insieme di credenziali delle chiavi di Azure, detto anche nome DNS, che contiene la chiave da usare per crittografare i dati inattivi. Un URI di esempio potrebbe essere `https://my-keyvault-name.vault.azure.net`.

VectorSearchVectorizerKind

Enumerazione

Metodo di vettorizzazione da utilizzare durante la fase di query.

Valore	Descrizione
azureOpenAI	Generare incorporamenti usando una risorsa OpenAI di Azure in fase di query.
customWebApi	Generare incorporamenti usando un endpoint Web personalizzato in fase di query.
aiServicesVision	Generare incorporamenti per un'immagine o un input di testo in fase di query usando l'API Vectorize visione di Servizi di intelligenza artificiale di Azure.
aml	Generare incorporamenti usando un endpoint di Azure Machine Learning distribuito tramite il catalogo dei modelli di Azure AI Foundry in fase di query.

WebKnowledgeSource

Oggetto

Risultati Web di targeting della Knowledge Source.

Nome	Tipo	Descrizione
@odata.etag	string	L'ETag della fonte di conoscenza.
description	string	Descrizione facoltativa definita dall'utente.
encryptionKey	SearchResourceEncryptionKey	Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia a riposo per la definizione della sorgente di conoscenza quando si vuole la piena garanzia che nessuno, nemmeno Microsoft, possa decriptarle. Una volta che hai criptato la definizione della tua fonte di conoscenza, questa rimarrà sempre criptata. Il servizio di ricerca ignorerà i tentativi di impostare questa proprietà su null. Puoi modificare questa proprietà se necessariamente se vuoi ruotare la chiave di crittografia; La definizione della tua fonte di conoscenza non sarà influenzata. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati il 1° gennaio 2019.
kind	string: web	Tipo di origine della conoscenza.
name	string	Il nome dell'origine della conoscenza.
webParameters	WebKnowledgeSourceParameters	I parametri per l'origine della conoscenza Web.

WebKnowledgeSourceDomain

Oggetto

Configurazione per il dominio di origine della conoscenza Web.

Nome	Tipo	Descrizione
address	string	L'indirizzo del dominio.
includeSubpages	boolean	Se includere o meno le sottopagine di questo dominio.

WebKnowledgeSourceDomains

Oggetto

Configurazione del dominio che consente/blocca per l'origine della conoscenza Web.

Nome	Tipo	Descrizione
allowedDomains	WebKnowledgeSourceDomain[]	Domini consentiti per i risultati web.
blockedDomains	WebKnowledgeSourceDomain[]	Domini bloccati dai risultati web.

WebKnowledgeSourceParameters

Oggetto

Parametri per la fonte di conoscenza web.

Nome	Tipo	Descrizione
domains	WebKnowledgeSourceDomains	Configurazione del dominio che consente/blocca per i risultati Web.