Knowledge Sources - Create Or Update
Crea una nuova origine informazioni o aggiorna un'origine informazioni se esiste già.
PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-08-01-previewParametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
URL dell'endpoint del servizio di ricerca. |
|
source
|
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 |
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 nel server non corrisponde a questo valore. |
|
| Prefer | True |
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 |
|---|---|
|
Azure |
Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure. |
|
Fabric |
Configurazione per la sorgente di conoscenza del Fabric Data Agent. |
|
Fabric |
Configurazione per Fabric Ontology, fonte di conoscenza. |
|
File |
Configurazione per File knowledge source che supporta il caricamento e l'indicizzazione diretta dei file. |
|
Indexed |
Configurazione per l'origine della conoscenza OneLake. |
|
Indexed |
Configurazione per l'origine della conoscenza di SharePoint. |
|
Indexed |
Configurazione per la sorgente di conoscenza SQL indicizzata. |
|
Mcp |
Configurazione per una fonte di conoscenza supportata da un server MCP (Model Context Protocol). |
|
Remote |
Configurazione per l'origine della conoscenza remota di SharePoint. |
|
Search |
Origine conoscenza destinata a un indice di ricerca. |
|
Web |
Risultati Web di targeting della Knowledge Source. |
|
Work |
Configurazione per la fonte di conoscenza WorkIQ. |
AzureBlobKnowledgeSource
Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| azureBlobParameters | True |
Tipo di origine della conoscenza. |
|
| kind | True |
string:
azure |
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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
FabricDataAgentKnowledgeSource
Configurazione per la sorgente di conoscenza del Fabric Data Agent.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| fabricDataAgentParameters | True |
I parametri per la sorgente di conoscenza del Fabric Data Agent. |
|
| kind | True |
string:
fabric |
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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
FabricOntologyKnowledgeSource
Configurazione per Fabric Ontology, fonte di conoscenza.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| fabricOntologyParameters | True |
I parametri per la fonte di conoscenza di Fabric Ontology. |
|
| kind | True |
string:
fabric |
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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
FileKnowledgeSource
Configurazione per File knowledge source che supporta il caricamento e l'indicizzazione diretta dei file.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| fileParameters | True |
I parametri per la sorgente di conoscenza del file. |
|
| kind | True |
string:
file |
Tipo di origine della conoscenza. |
| name | True |
string |
Il nome dell'origine della conoscenza. |
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
|
| corsOptions |
Opzioni per controllare la condivisione delle risorse cross-origin (CORS) per gli endpoint del file della sorgente di conoscenza del file (caricamento, elenco, aggiornamento, cancella). |
||
| description |
string |
Descrizione facoltativa definita dall'utente. |
|
| encryptionKey |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
IndexedOneLakeKnowledgeSource
Configurazione per l'origine della conoscenza OneLake.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| indexedOneLakeParameters | True |
Parametri per l'origine della conoscenza. |
|
| kind | True |
string:
indexed |
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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
IndexedSharePointKnowledgeSource
Configurazione per l'origine della conoscenza di SharePoint.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| indexedSharePointParameters | True |
Parametri per l'origine della conoscenza. |
|
| kind | True |
string:
indexed |
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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
IndexedSqlKnowledgeSource
Configurazione per la sorgente di conoscenza SQL indicizzata.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| indexedSqlParameters | True |
I parametri per la sorgente di conoscenza SQL. |
|
| kind | True |
string:
indexed |
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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
McpServerKnowledgeSource
Configurazione per una fonte di conoscenza supportata da un server MCP (Model Context Protocol).
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| kind | True |
string:
mcp |
Tipo di origine della conoscenza. |
| mcpServerParameters | True |
I parametri per la sorgente di conoscenza del server MCP. |
|
| 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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
RemoteSharePointKnowledgeSource
Configurazione per l'origine della conoscenza remota di SharePoint.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| kind | True |
string:
remote |
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 |
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 |
I parametri per la sorgente di conoscenza remota di SharePoint. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
SearchIndexKnowledgeSource
Origine conoscenza destinata a un indice di ricerca.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| kind | True |
string:
search |
Tipo di origine della conoscenza. |
| name | True |
string |
Il nome dell'origine della conoscenza. |
| searchIndexParameters | True |
Parametri per l'origine della conoscenza. |
|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
|
| description |
string |
Descrizione facoltativa definita dall'utente. |
|
| encryptionKey |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
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 |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
||
| webParameters |
I parametri per l'origine della conoscenza Web. |
WorkIQKnowledgeSource
Configurazione per la fonte di conoscenza WorkIQ.
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| kind | True |
string:
workIQ |
Tipo di origine della conoscenza. |
| name | True |
string |
Il nome dell'origine della conoscenza. |
| workIQParameters | True |
I parametri per la sorgente di conoscenza WorkIQ, inclusa la configurazione dell'app Entra di proprietà del cliente utilizzata per l'autenticazione a nome del cliente. |
|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
|
| description |
string |
Descrizione facoltativa definita dall'utente. |
|
| encryptionKey |
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. |
||
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
KnowledgeSource:
|
La richiesta ha avuto esito positivo. |
| 201 Created |
KnowledgeSource:
|
La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa. |
| Other Status Codes |
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
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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
}
]
}
}
}
Risposta di esempio
{
"@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."
}
]
}
}
}{
"@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."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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
}
]
}
}
}
Risposta di esempio
{
"@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"
}
}
}{
"@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"
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent
Esempio di richiesta
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabric-agent-test')?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>"
}
}
}
Risposta di esempio
{
"@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"
}
}{
"@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"
}
}SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology
Esempio di richiesta
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabricontology-test')?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>"
}
}
}
Risposta di esempio
{
"@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"
}
}{
"@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"
}
}SearchServiceCreateOrUpdateKnowledgeSourceFile
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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
}
}
Risposta di esempio
{
"@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
}
}{
"@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
}
}SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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
}
]
}
}
}
Risposta di esempio
{
"@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."
}
]
}
}
}{
"@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."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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
}
]
}
}
}
Risposta di esempio
{
"@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."
}
]
}
}
}{
"@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."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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
}
]
}
}
}
Risposta di esempio
{
"@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."
}
]
}
}
}{
"@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."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceMcpServer
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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
}
]
}
}
Risposta di esempio
{
"@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
}
}
}
]
}
}{
"@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
}
}
}
]
}
}SearchServiceCreateOrUpdateKnowledgeSourceWeb
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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>"
}
}
}
Risposta di esempio
{
"@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
}
]
}
}
}{
"@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
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ
Esempio di richiesta
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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"
}
}
}
Risposta di esempio
{
"@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"
}
}
}{
"@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"
}
}
}Definizioni
| Nome | Descrizione |
|---|---|
| Accept |
L'intestazione Accetta. |
| AIServices |
Parametri per i servizi di IA. |
|
Asset |
Configurazione di un asset store utilizzato per memorizzare asset estratti come immagini. |
|
Azure |
Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure. |
|
Azure |
Parametri per l'origine della conoscenza di Archiviazione BLOB di Azure. |
|
Azure |
Nome del modello Azure Open AI che verrà chiamato. |
|
Azure |
Specifica i parametri per la connessione alla risorsa OpenAI di Azure. |
|
Content |
Mappa una colonna SQL a un campo indice di ricerca. |
|
Cors |
Definisce le opzioni per controllare la condivisione di risorse tra le origini (CORS) per un indice. |
|
Embedding |
Mapola una colonna SQL a un campo vettoriale per l'embedding. |
|
Entra |
Configurazione per una registrazione dell'app Microsoft Entra di proprietà del cliente utilizzata per l'autenticazione basata su credenziali federate per conto del cliente. |
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Error |
Dettagli dell'errore. |
|
Error |
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. |
|
Fabric |
Configurazione per la sorgente di conoscenza del Fabric Data Agent. |
|
Fabric |
Parametri per la fonte di conoscenza del Fabric Data Agent. |
|
Fabric |
Configurazione per Fabric Ontology, fonte di conoscenza. |
|
Fabric |
Parametri per la fonte di conoscenza di Fabric Ontology. |
|
File |
Configurazione per File knowledge source che supporta il caricamento e l'indicizzazione diretta dei file. |
|
File |
Parametri per la fonte di conoscenza del file. |
|
Freshness |
Configurazione per il recupero consapevole della freschezza. Quando impostato, i documenti più recenti ricevono un aumento di classifica durante il recupero. |
|
Indexed |
Configurazione per l'origine della conoscenza OneLake. |
|
Indexed |
Parametri per l'origine della conoscenza OneLake. |
|
Indexed |
Specifica le raccolte di SharePoint a cui accedere. |
|
Indexed |
Configurazione per l'origine della conoscenza di SharePoint. |
|
Indexed |
Parametri per l'origine della conoscenza di SharePoint. |
|
Indexed |
Configurazione per la sorgente di conoscenza SQL indicizzata. |
|
Indexed |
Parametri per la sorgente di conoscenza SQL indicizzata. |
|
Indexing |
Rappresenta una pianificazione per l'esecuzione dell'indicizzatore. |
|
Knowledge |
Specifica la risorsa Azure OpenAI usata per eseguire la pianificazione delle query. |
|
Knowledge |
Modello di intelligenza artificiale da utilizzare per la pianificazione delle query. |
|
Knowledge |
Specifica la risorsa Azure OpenAI usata per vettorializzare una stringa di query. |
|
Knowledge |
Consolida tutte le impostazioni generali di acquisizione per le fonti di conoscenza. |
|
Knowledge |
Tipi di permesso da ingerire insieme al contenuto del documento. |
|
Knowledge |
Il tipo di fonte di conoscenza. |
|
Knowledge |
Specifica la modalità di accesso alla rete per l'ingestione della sorgente di conoscenza. Il predefinito è 'pubblico'. |
|
Knowledge |
Controlla se i risultati di una fonte di conoscenza vengono riclassificati. |
|
Mcp |
Il tipo di autenticazione per un server MCP. |
|
Mcp |
Rileva automaticamente il formato di uscita e analizza di conseguenza. |
|
Mcp |
Autenticazione tramite una connessione Azure AI Foundry. |
|
Mcp |
Parametri per l'autenticazione della connessione Foundry. |
|
Mcp |
Analizza l'output come documento JSON usando i parametri JSON configurati. |
|
Mcp |
Configurazione per una fonte di conoscenza supportata da un server MCP (Model Context Protocol). |
|
Mcp |
Parametri per una sorgente di conoscenza di un server MCP. |
|
Mcp |
Considera l'output come un singolo blocco senza alcun parsing. |
|
Mcp |
Parametri per l'analisi parsing dell'output JSON. |
|
Mcp |
Il tipo di output parsing per uno strumento server MCP. |
|
Mcp |
Parametri per la parsing di output diviso. |
|
Mcp |
Dividi l'output in pagine usando i parametri di divisione configurati. |
|
Mcp |
Autenticazione utilizzando header HTTP memorizzati. |
|
Mcp |
Parametri per l'autenticazione delle intestazioni memorizzate. |
|
Mcp |
Rappresenta un singolo strumento all'interno di una sorgente di conoscenza server MCP. |
| Prefer |
Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo. |
|
Remote |
Configurazione per l'origine della conoscenza remota di SharePoint. |
|
Remote |
Parametri per l'origine della conoscenza remota di SharePoint. |
|
Search |
Cancella la proprietà Identity di un'origine dati. |
|
Search |
Specifica l'identità di un'origine dati da usare. |
|
Search |
Riferimento di campo per un indice di ricerca. |
|
Search |
Origine conoscenza destinata a un indice di ricerca. |
|
Search |
Il tipo di suggerimento per un incarico di ricerca e una fonte di conoscenza dell'indice di ricerca. |
|
Search |
Un suggerimento che potenzia i documenti in base al valore di un campo. |
|
Search |
Un suggerimento che identifica un campo e valori rappresentativi che il query planner può usare per costruire un filtro. |
|
Search |
Un suggerimento che migliora i documenti basandosi su un'espressione di più parole. |
|
Search |
Parametri per l'origine della conoscenza dell'indice di ricerca. |
|
Search |
Suggerimenti che guidano la pianificazione delle query verso filtri utili e potenziamenti per una fonte di conoscenza dell'indice di ricerca. |
|
Search |
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. |
|
Split |
I codici lingua supportati per il testo di input da SplitSkill. |
|
Text |
Valore che indica la modalità di divisione da eseguire. |
|
Vector |
Metodo di vettorizzazione da utilizzare durante la fase di query. |
|
Web |
Risultati Web di targeting della Knowledge Source. |
|
Web |
Configurazione per il dominio di origine della conoscenza Web. |
|
Web |
Configurazione del dominio che consente/blocca per l'origine della conoscenza Web. |
|
Web |
Parametri per la fonte di conoscenza web. |
|
Work |
Configurazione per la fonte di conoscenza WorkIQ. |
|
Work |
Parametri per una fonte di conoscenza WorkIQ. |
Accept
L'intestazione Accetta.
| Valore | Descrizione |
|---|---|
| application/json;odata.metadata=minimal |
AIServices
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. |
AssetStore
Configurazione di un asset store utilizzato per memorizzare asset estratti come immagini.
| Nome | Tipo | Descrizione |
|---|---|---|
| connectionString |
string |
La stringa di connessione per lo asset store. |
| containerName |
string |
Il nome del contenitore del blob all'interno dello asset store dove sono memorizzati gli asset estratti (ad esempio, immagini). |
AzureBlobKnowledgeSource
Configurazione per l'origine della conoscenza di Archiviazione BLOB di Azure.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
| azureBlobParameters |
Tipo di origine della conoscenza. |
|
| description |
string |
Descrizione facoltativa definita dall'utente. |
| encryptionKey |
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:
azure |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
AzureBlobKnowledgeSourceParameters
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 |
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. |
| queryHints |
Suggerimenti predefiniti che guidano la pianificazione delle query verso filtri e potenziamenti utili per questa fonte di conoscenza supportata da indici. I suggerimenti di query al momento della richiesta sostituiscono questi valori predefiniti come oggetto completo. |
AzureOpenAIModelName
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. |
| gpt-5.1 |
Modello GPT51. |
| gpt-5.2 |
Modello GPT52. |
| gpt-5.4 |
Modello GPT54. |
| gpt-5.4-mini |
Modello Gpt54Mini. |
| gpt-5.4-nano |
Modello Gpt54Nano. |
| gpt-5.5 |
Modello GPT55. |
| gpt-5.6-sol |
Modello Gpt56Sol. |
| gpt-5.6-terra |
Modello Gpt56Terra. |
| gpt-5.6-luna |
Modello GPT56Luna. |
AzureOpenAIVectorizerParameters
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: |
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 |
Nome del modello di incorporamento distribuito nel percorso deploymentId specificato. |
|
| resourceUri |
string (uri) |
URI della risorsa OpenAI di Azure. |
ContentColumnMapping
Mappa una colonna SQL a un campo indice di ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| name |
string |
Nome del campo dell'indice target. |
| searchFieldType |
string |
Tipo di campo Azure AI Search (ad esempio, Edm.String, Edm.Int32). |
| sourceField |
string |
Nome della colonna SQL. |
CorsOptions
Definisce le opzioni per controllare la condivisione di risorse tra le origini (CORS) per un indice.
| Nome | Tipo | Descrizione |
|---|---|---|
| allowedOrigins |
string[] |
L'elenco delle origini da cui il codice JavaScript avrà accesso all'indice. Può contenere un elenco di host nel formato {protocol}://{nome-dominio-completo}[:{port#}], o un singolo '*' per consentire tutte le origini (non consigliato). |
| maxAgeInSeconds |
integer (int64) |
Durata per la quale i browser devono memorizzare nella cache le risposte preliminari CORS. Il valore predefinito è 5 minuti. |
EmbeddingColumnMapping
Mapola una colonna SQL a un campo vettoriale per l'embedding.
| Nome | Tipo | Descrizione |
|---|---|---|
| name |
string |
Nome del campo vettoriale target nell'indice di ricerca. |
| sourceField |
string |
Colonna SQL utilizzata come input per la generazione di embedding. |
EntraAppAuthentication
Configurazione per una registrazione dell'app Microsoft Entra di proprietà del cliente utilizzata per l'autenticazione basata su credenziali federate per conto del cliente.
| Nome | Tipo | Descrizione |
|---|---|---|
| applicationId |
string (uuid) |
L'ID dell'applicazione (client) della registrazione dell'app Entra di proprietà del cliente. |
| federatedCredentialId |
string (uuid) |
L'ID credenziale federato configurato sulla registrazione dell'app, permettendo al servizio di ricerca di autenticarsi come app senza un segreto client memorizzato. |
| tenantId |
string (uuid) |
L'ID tenant della registrazione dell'app. È richiesto quando la registrazione dell'app è in un tenant diverso rispetto al servizio di ricerca. Se omesso, viene utilizzato il tenant del servizio di ricerca. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
Informazioni aggiuntive. |
|
| type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| additionalInfo |
Informazioni aggiuntive sull'errore. |
|
| code |
string |
Codice di errore. |
| details |
Dettagli dell'errore. |
|
| message |
string |
Messaggio di errore. |
| target |
string |
La destinazione 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.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Oggetto error. |
FabricDataAgentKnowledgeSource
Configurazione per la sorgente di conoscenza del Fabric Data Agent.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
| description |
string |
Descrizione facoltativa definita dall'utente. |
| encryptionKey |
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. |
|
| fabricDataAgentParameters |
I parametri per la sorgente di conoscenza del Fabric Data Agent. |
|
| kind |
string:
fabric |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
FabricDataAgentKnowledgeSourceParameters
Parametri per la fonte di conoscenza del Fabric Data Agent.
| Nome | Tipo | Descrizione |
|---|---|---|
| dataAgentId |
string |
Specifica quale Fabric Data Agent accedere. |
| workspaceId |
string |
ID dello spazio di lavoro Fabric. |
FabricOntologyKnowledgeSource
Configurazione per Fabric Ontology, fonte di conoscenza.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
| description |
string |
Descrizione facoltativa definita dall'utente. |
| encryptionKey |
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. |
|
| fabricOntologyParameters |
I parametri per la fonte di conoscenza di Fabric Ontology. |
|
| kind |
string:
fabric |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
FabricOntologyKnowledgeSourceParameters
Parametri per la fonte di conoscenza di Fabric Ontology.
| Nome | Tipo | Descrizione |
|---|---|---|
| ontologyId |
string |
L'ID dell'ontologia da utilizzare dallo spazio di lavoro Fabric. |
| workspaceId |
string |
L'ID dello spazio di lavoro Fabric contiene l'ontologia. |
FileKnowledgeSource
Configurazione per File knowledge source che supporta il caricamento e l'indicizzazione diretta dei file.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
| corsOptions |
Opzioni per controllare la condivisione delle risorse cross-origin (CORS) per gli endpoint del file della sorgente di conoscenza del file (caricamento, elenco, aggiornamento, cancella). |
|
| description |
string |
Descrizione facoltativa definita dall'utente. |
| encryptionKey |
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. |
|
| fileParameters |
I parametri per la sorgente di conoscenza del file. |
|
| kind |
string:
file |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
FileKnowledgeSourceParameters
Parametri per la fonte di conoscenza del file.
| Nome | Tipo | Descrizione |
|---|---|---|
| createdResources |
object |
Risorse create dalla fonte di conoscenza del file. |
| ingestionParameters |
Consolida tutte le impostazioni generali di ingestione per la fonte di conoscenza del File, inclusa la modalità di estrazione dei contenuti e un EmbeddingModel opzionale. |
|
| queryHints |
Suggerimenti predefiniti che guidano la pianificazione delle query verso filtri e potenziamenti utili per questa fonte di conoscenza supportata da indici. I suggerimenti di query al momento della richiesta sostituiscono questi valori predefiniti come oggetto completo. |
FreshnessPolicy
Configurazione per il recupero consapevole della freschezza. Quando impostato, i documenti più recenti ricevono un aumento di classifica durante il recupero.
| Nome | Tipo | Descrizione |
|---|---|---|
| boostingDuration |
string |
Durata ISO 8601 per la finestra di aumento della freschezza (ad esempio 'P90D' per 90 giorni). I documenti più recenti di questa durata ricevono un aumento di classifica durante il recupero. |
IndexedOneLakeKnowledgeSource
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 |
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 |
Parametri per l'origine della conoscenza. |
|
| kind |
string:
indexed |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
IndexedOneLakeKnowledgeSourceParameters
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 |
Consolida tutte le impostazioni generali di ingestione. |
|
| lakehouseId |
string |
Specifica a quale lakehouse OneLake accedere. |
| queryHints |
Suggerimenti predefiniti che guidano la pianificazione delle query verso filtri e potenziamenti utili per questa fonte di conoscenza supportata da indici. I suggerimenti di query al momento della richiesta sostituiscono questi valori predefiniti come oggetto completo. |
|
| targetPath |
string |
Cartella OneLakehouse opzionale o scorciatoia per filtrare i contenuti OneLake. |
IndexedSharePointContainerName
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
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 |
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 |
Parametri per l'origine della conoscenza. |
|
| kind |
string:
indexed |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
IndexedSharePointKnowledgeSourceParameters
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 |
Specifica le raccolte di SharePoint a cui accedere. |
|
| createdResources |
object |
Risorse create dall'origine della conoscenza. |
| ingestionParameters |
Consolida tutte le impostazioni generali di ingestione. |
|
| query |
string |
Query facoltativa per filtrare il contenuto di SharePoint. |
| queryHints |
Suggerimenti predefiniti che guidano la pianificazione delle query verso filtri e potenziamenti utili per questa fonte di conoscenza supportata da indici. I suggerimenti di query al momento della richiesta sostituiscono questi valori predefiniti come oggetto completo. |
IndexedSqlKnowledgeSource
Configurazione per la sorgente di conoscenza SQL indicizzata.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
| description |
string |
Descrizione facoltativa definita dall'utente. |
| encryptionKey |
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. |
|
| indexedSqlParameters |
I parametri per la sorgente di conoscenza SQL. |
|
| kind |
string:
indexed |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
IndexedSqlKnowledgeSourceParameters
Parametri per la sorgente di conoscenza SQL indicizzata.
| Nome | Tipo | Descrizione |
|---|---|---|
| connectionString |
string |
La stringa di connessione per database SQL di Azure o Istanza gestita di SQL. |
| contentColumns |
Colonne opzionali per i campi di contenuto. Se omessa, tutte le colonne vengono scoperte automaticamente. |
|
| createdResources |
object |
Risorse create dall'origine della conoscenza. |
| embeddingColumns |
Applicazioni opzionali per l'incorporamento di campi vettoriali. Se omesso, non vengono creati campi vettoriali. |
|
| highWaterMarkColumnName |
string |
Nome di colonna opzionale per il rilevamento del cambio di marca di marea alta. Se fornito, utilizza HighWaterMarkChangeDetectionPolicy. |
| ingestionParameters |
Consolida tutte le impostazioni generali di ingestione, inclusi modello di incorporamento, programma e identità. |
|
| queryHints |
Suggerimenti predefiniti che guidano la pianificazione delle query verso filtri e potenziamenti utili per questa fonte di conoscenza supportata da indici. I suggerimenti di query al momento della richiesta sostituiscono questi valori predefiniti come oggetto completo. |
|
| tableOrView |
string |
Il nome della tabella o della vista da indicizzare. Può essere qualificato per schema (ad esempio, 'dbo. MyTable'). |
IndexingSchedule
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
Specifica la risorsa Azure OpenAI usata per eseguire la pianificazione delle query.
| Nome | Tipo | Descrizione |
|---|---|---|
| azureOpenAIParameters |
Parametri Azure OpenAI. |
|
| kind |
string:
azure |
Modello di intelligenza artificiale da utilizzare per la pianificazione delle query. |
KnowledgeBaseModelKind
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
Specifica la risorsa Azure OpenAI usata per vettorializzare una stringa di query.
| Nome | Tipo | Descrizione |
|---|---|---|
| azureOpenAIParameters |
Contiene i parametri specifici della vettorizzazione di incorporamento di Azure OpenAI. |
|
| kind |
string:
azure |
Nome del tipo di metodo di vettorizzazione configurato per l'utilizzo con la ricerca vettoriale. |
KnowledgeSourceIngestionParameters
Consolida tutte le impostazioni generali di acquisizione per le fonti di conoscenza.
| Nome | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| aiServices |
Configurazione opzionale dei servizi di intelligenza artificiale per l'elaborazione dei contenuti. |
||
| assetStore |
Configurazione opzionale di asset store per memorizzare asset estratti come immagini. |
||
| chatCompletionModel | KnowledgeBaseModel: |
Modello di completamento della chat opzionale per la verbalizzazione delle immagini o l'estrazione del contesto. |
|
| contentExtractionMode |
enum:
|
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: |
Configurazione vettorizzatore opzionale per la vettorializzazione dei contenuti. |
|
| freshnessPolicy |
Politica opzionale di freschezza per biasing retrieval verso documenti più recenti. |
||
| identity | SearchIndexerDataIdentity: |
Un'identità esplicita da utilizzare per questa fonte di conoscenza. |
|
| ingestionPermissionOptions |
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 |
Pianificazione facoltativa per l'inserimento dei dati. |
||
| networkAccessMode | public |
Modalità di accesso alla rete opzionale per l'ingestione. Impostato su 'privato' per eseguire l'ingestione in un ambiente di esecuzione privata che può raggiungere fonti di dati e dipendenze tramite una rete privata. Il predefinito è 'pubblico'. Questa è un'impostazione create-time e non può essere modificata dopo la creazione della fonte di conoscenza. |
KnowledgeSourceIngestionPermissionOption
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. |
| sensitivityLabels |
Assumi le etichette di sensibilità di Microsoft Purview insieme ai contenuti dei documenti. |
KnowledgeSourceKind
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. |
| indexedSql |
Una fonte di conoscenza che recupera e assorbe dati da database SQL di Azure o Istanza gestita di SQL in un Search Index. |
| web |
Una fonte di conoscenza che legge dati dal web. |
| remoteSharePoint |
Una fonte di conoscenza che legge dati da SharePoint remoto. |
| workIQ |
Una fonte di conoscenza che legge dati dal QI lavorativo |
| file |
Una fonte di conoscenza che supporta il caricamento e l'indicizzazione diretta dei file. |
| mcpServer |
Una sorgente di conoscenza supportata da un server MCP (Model Context Protocol). |
| fabricDataAgent |
Una fonte di conoscenza che recupera dati da un Fabric Data Agent. |
| fabricOntology |
Una fonte di conoscenza che recupera dati dalle ontologie Microsoft Fabric Ontology. |
KnowledgeSourceNetworkAccessMode
Specifica la modalità di accesso alla rete per l'ingestione della sorgente di conoscenza. Il predefinito è 'pubblico'.
| Valore | Descrizione |
|---|---|
| public |
L'ingestione si svolge nell'ambiente di esecuzione standard, accessibile al pubblico. Si tratta dell'impostazione predefinita. |
| private |
L'ingestione si svolge in un ambiente di esecuzione privata per poter raggiungere fonti di dati e dipendenze su una rete privata (endpoint privato / collegamento privato condiviso). |
KnowledgeSourceResultsProcessing
Controlla se i risultati di una fonte di conoscenza vengono riclassificati.
| Valore | Descrizione |
|---|---|
| rerank |
I risultati di questa fonte di conoscenza passano attraverso la pipeline di riclassificazione. Questo è il comportamento predefinito. |
| none |
I risultati di questa fonte di conoscenza bypassano il riordinamento e preservano il loro ordine sottostante. |
McpServerAuthenticationKind
Il tipo di autenticazione per un server MCP.
| Valore | Descrizione |
|---|---|
| foundryConnection |
Autentica usando una connessione Azure AI Foundry. |
| storedHeaders |
Autentica usando le intestazioni HTTP memorizzate. |
McpServerAutoOutputParsing
Rileva automaticamente il formato di uscita e analizza di conseguenza.
| Nome | Tipo | Descrizione |
|---|---|---|
| kind |
string:
auto |
Il tipo di output parsing da applicare. |
McpServerFoundryConnectionAuthentication
Autenticazione tramite una connessione Azure AI Foundry.
| Nome | Tipo | Descrizione |
|---|---|---|
| foundryConnectionParameters |
Parametri per l'autenticazione della connessione Foundry. |
|
| kind |
string:
foundry |
Il tipo di autenticazione da usare. |
McpServerFoundryConnectionParameters
Parametri per l'autenticazione della connessione Foundry.
| Nome | Tipo | Descrizione |
|---|---|---|
| connectionId |
string |
L'identificatore di connessione Azure AI Foundry. |
McpServerJsonOutputParsing
Analizza l'output come documento JSON usando i parametri JSON configurati.
| Nome | Tipo | Descrizione |
|---|---|---|
| jsonParameters |
Parametri per l'analisi parsing dell'output JSON. Richiesto quando gentile è 'json'. |
|
| kind |
string:
json |
Il tipo di output parsing da applicare. |
McpServerKnowledgeSource
Configurazione per una fonte di conoscenza supportata da un server MCP (Model Context Protocol).
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
| description |
string |
Descrizione facoltativa definita dall'utente. |
| encryptionKey |
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:
mcp |
Tipo di origine della conoscenza. |
| mcpServerParameters |
I parametri per la sorgente di conoscenza del server MCP. |
|
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
McpServerKnowledgeSourceParameters
Parametri per una sorgente di conoscenza di un server MCP.
| Nome | Tipo | Descrizione |
|---|---|---|
| authentication | McpServerAuthentication: |
La configurazione dell'autenticazione per il server MCP. |
| serverURL |
string |
L'URL dell'endpoint del server MCP. |
| tools |
L'elenco degli strumenti da invocare sul server MCP. |
McpServerNoneOutputParsing
Considera l'output come un singolo blocco senza alcun parsing.
| Nome | Tipo | Descrizione |
|---|---|---|
| kind |
string:
none |
Il tipo di output parsing da applicare. |
McpServerOutputParsingJsonParameters
Parametri per l'analisi parsing dell'output JSON.
| Nome | Tipo | Descrizione |
|---|---|---|
| documentsPath |
string |
Il percorso JSON verso l'array di documenti nell'output dello strumento. |
| includeContext |
boolean |
Se includere il contesto circostante dell'output JSON insieme ai documenti estratti. |
McpServerOutputParsingKind
Il tipo di output parsing per uno strumento server MCP.
| Valore | Descrizione |
|---|---|
| auto |
Rileva automaticamente il formato di uscita e analizza di conseguenza. |
| json |
Analizza l'output come documento JSON usando i parametri JSON configurati. |
| split |
Dividi l'output in pagine usando i parametri di divisione configurati. |
| none |
Considera l'output come un singolo blocco senza alcun parsing. |
McpServerOutputParsingSplitParameters
Parametri per la parsing di output diviso.
| Nome | Tipo | Descrizione |
|---|---|---|
| defaultLanguageCode |
Valore che indica il codice della lingua da utilizzare. Il valore predefinito è |
|
| maximumPageLength |
integer (int32) |
Il numero massimo di caratteri per pagina. |
| maximumPagesToTake |
integer (int32) |
Il numero massimo di pagine da prendere dall'output. |
| pageOverlapLength |
integer (int32) |
Il numero di caratteri da sovrapporsi tra le pagine. |
| textSplitMode |
La modalità di divisione del testo da usare. |
McpServerSplitOutputParsing
Dividi l'output in pagine usando i parametri di divisione configurati.
| Nome | Tipo | Descrizione |
|---|---|---|
| kind |
string:
split |
Il tipo di output parsing da applicare. |
| splitParameters |
Parametri per la parsing di output diviso. |
McpServerStoredHeadersAuthentication
Autenticazione utilizzando header HTTP memorizzati.
| Nome | Tipo | Descrizione |
|---|---|---|
| kind |
string:
stored |
Il tipo di autenticazione da usare. |
| storedHeadersParameters |
Parametri per l'autenticazione delle intestazioni memorizzate. |
McpServerStoredHeadersParameters
Parametri per l'autenticazione delle intestazioni memorizzate.
| Nome | Tipo | Descrizione |
|---|---|---|
| headers |
object |
Le intestazioni HTTP memorizzate da includere nelle richieste del server MCP. |
McpServerTool
Rappresenta un singolo strumento all'interno di una sorgente di conoscenza server MCP.
| Nome | Tipo | Descrizione |
|---|---|---|
| maxOutputTokens |
integer (int32) |
Un condensatore opzionale di token post-parsing per l'output di questo strumento. Deve essere maggiore di 0 quando specificato. |
| name |
string |
Nome dello strumento MCP da richiamare. |
| outputParsing | McpServerOutputParsing: |
Configurazione opzionale per analizzare l'output dello strumento. |
| resultsProcessing |
Controlla se i risultati analizzati di questo strumento vengono riclassificati. Imposta di default 'riclassifica' quando non specificato. |
Prefer
Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.
| Valore | Descrizione |
|---|---|
| return=representation |
RemoteSharePointKnowledgeSource
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 |
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:
remote |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| remoteSharePointParameters |
I parametri per la sorgente di conoscenza remota di SharePoint. |
|
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
RemoteSharePointKnowledgeSourceParameters
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
Cancella la proprietà Identity di un'origine dati.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Frammento di URI che specifica il tipo di identità. |
SearchIndexerDataUserAssignedIdentity
Specifica l'identità di un'origine dati da usare.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Frammento di URI che specifica il tipo di identità. |
| federatedIdentityClientId |
string |
Supporto User-Assigned identità gestita multi-tenente: l'id client dell'app multi-tentant configurata per federarsi con l'identità gestita assegnata dall'utente. |
| userAssignedIdentity |
string |
ID risorsa di Azure completo di un'identità gestita assegnata dall'utente in genere nel formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" che dovrebbe essere stato assegnato al servizio di ricerca. |
SearchIndexFieldReference
Riferimento di campo per un indice di ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| name |
string |
Nome del campo. |
SearchIndexKnowledgeSource
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 |
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:
search |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
|
| searchIndexParameters |
Parametri per l'origine della conoscenza. |
SearchIndexKnowledgeSourceBoostKind
Il tipo di suggerimento per un incarico di ricerca e una fonte di conoscenza dell'indice di ricerca.
| Valore | Descrizione |
|---|---|
| fieldValue |
Potenzia i documenti basandosi sul valore di un campo. |
| multiWordExpression |
Potenzia i documenti basandosi su un'espressione di più parole. |
SearchIndexKnowledgeSourceFieldValueBoost
Un suggerimento che potenzia i documenti in base al valore di un campo.
| Nome | Tipo | Descrizione |
|---|---|---|
| boost |
number (double) |
Un moltiplicatore per il punteggio del documento. Deve essere un numero positivo diverso da 1,0. |
| boostInstructions |
string |
Istruzioni in linguaggio naturale che spiegano quando e come applicare il boost. |
| field |
string minLength: 1 |
Il nome del campo indice di ricerca. |
| fieldValues |
string[] |
Valori rappresentativi per il campo. |
| kind |
string:
field |
Quel tipo di suggerimento di potenziamento. |
SearchIndexKnowledgeSourceFilterHint
Un suggerimento che identifica un campo e valori rappresentativi che il query planner può usare per costruire un filtro.
| Nome | Tipo | Descrizione |
|---|---|---|
| field |
string minLength: 1 |
Il nome del campo indice di ricerca filtrabile. |
| fieldValues |
string[] |
Valori rappresentativi per il campo. |
| filterInstructions |
string |
Istruzioni in linguaggio naturale che spiegano quando e come filtrare sul campo. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Un suggerimento che migliora i documenti basandosi su un'espressione di più parole.
| Nome | Tipo | Descrizione |
|---|---|---|
| boost |
number (double) |
Un moltiplicatore per il punteggio del documento. Deve essere un numero positivo diverso da 1,0. |
| boostInstructions |
string |
Istruzioni in linguaggio naturale che spiegano quando e come applicare il boost. |
| fieldValues |
string[] |
Valori rappresentativi per il potenziamento. |
| kind |
string:
multi |
Quel tipo di suggerimento di potenziamento. |
SearchIndexKnowledgeSourceParameters
Parametri per l'origine della conoscenza dell'indice di ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| baseFilter |
string |
Una condizione di filtro predefinita applicata all'indice al momento del recupero (ad esempio, 'State EQ VA'). Può essere sovrascritto al momento della query tramite parametri di runtime della sorgente della conoscenza. |
| queryHints |
Suggerimenti predefiniti che guidano la pianificazione delle query verso filtri utili e potenziamenti per questa fonte di conoscenza dell'indice di ricerca. I suggerimenti di query al momento della richiesta sostituiscono questi valori predefiniti come oggetto completo. |
|
| searchFields |
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 |
Utilizzato per richiedere campi aggiuntivi per i dati di origine a cui si fa riferimento. |
SearchIndexKnowledgeSourceQueryHints
Suggerimenti che guidano la pianificazione delle query verso filtri utili e potenziamenti per una fonte di conoscenza dell'indice di ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Potenzia i suggerimenti che identificano condizioni che il query planner può utilizzare per influenzare la classificazione dei documenti. |
| filters |
Suggerimenti di filtro che identificano campi e valori rappresentativi che il query planner può usare per costruire filtri. |
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.
| Nome | Tipo | Valore predefinito | 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: |
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. |
|
| isServiceLevelKey |
boolean |
False |
Un valore opzionale che indica se questa chiave è una chiave a livello di servizio. Il valore predefinito è false. |
| 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 |
SplitSkillLanguage
I codici lingua supportati per il testo di input da SplitSkill.
| Valore | Descrizione |
|---|---|
| am |
Amharic |
| bs |
bosniaco |
| cs |
Ceco |
| da |
Danese |
| de |
Tedesco |
| en |
English |
| es |
Spagnolo |
| et |
Estone |
| fi |
Finlandese |
| fr |
French |
| he |
Ebraico |
| hi |
hindi |
| hr |
Croato |
| hu |
Ungherese |
| id |
Indonesian |
| is |
Islandese |
| it |
Italian |
| ja |
Japanese |
| ko |
Coreano |
| lv |
Lettone |
| nb |
Norvegese |
| nl |
Olandese |
| pl |
Polacco |
| pt |
Portoghese (Portogallo) |
| pt-br |
Portoghese (Brasile) |
| ru |
Russo |
| sk |
Slovacco |
| sl |
Sloveno |
| sr |
Serbo |
| sv |
Svedese |
| tr |
Turco |
| ur |
Urdu |
| zh |
Cinese (semplificato) |
TextSplitMode
Valore che indica la modalità di divisione da eseguire.
| Valore | Descrizione |
|---|---|
| pages |
Dividere il testo in singole pagine. |
| sentences |
Dividere il testo in singole frasi. |
VectorSearchVectorizerKind
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
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 |
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. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
|
| webParameters |
I parametri per l'origine della conoscenza Web. |
WebKnowledgeSourceDomain
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
Configurazione del dominio che consente/blocca per l'origine della conoscenza Web.
| Nome | Tipo | Descrizione |
|---|---|---|
| allowedDomains |
Domini consentiti per i risultati web. |
|
| blockedDomains |
Domini bloccati dai risultati web. |
WebKnowledgeSourceParameters
Parametri per la fonte di conoscenza web.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il numero predefinito di risultati web da restituire. Può essere sovrascritto al momento della query tramite parametri di runtime della sorgente della conoscenza. |
| domains |
Configurazione del dominio che consente/blocca per i risultati Web. |
|
| freshness |
string |
Il filtro predefinito di freschezza per i risultati web. Può essere sovrascritto al momento della query tramite parametri di runtime della sorgente della conoscenza. |
| language |
string |
Il linguaggio predefinito per i risultati web. Può essere sovrascritto al momento della query tramite parametri di runtime della sorgente della conoscenza. |
| market |
string |
Il mercato predefinito per i risultati web. Può essere sovrascritto al momento della query tramite parametri di runtime della sorgente della conoscenza. |
WorkIQKnowledgeSource
Configurazione per la fonte di conoscenza WorkIQ.
| Nome | Tipo | Descrizione |
|---|---|---|
| @odata.etag |
string |
L'ETag della fonte di conoscenza. |
| description |
string |
Descrizione facoltativa definita dall'utente. |
| encryptionKey |
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:
workIQ |
Tipo di origine della conoscenza. |
| name |
string |
Il nome dell'origine della conoscenza. |
| resultsProcessing |
Controlla se i risultati di questa fonte di conoscenza vengono riclassificati prima di essere inclusi nel set finale di risultati. Imposta di default 'riclassifica' quando non specificato. |
|
| workIQParameters |
I parametri per la sorgente di conoscenza WorkIQ, inclusa la configurazione dell'app Entra di proprietà del cliente utilizzata per l'autenticazione a nome del cliente. |
WorkIQKnowledgeSourceParameters
Parametri per una fonte di conoscenza WorkIQ.
| Nome | Tipo | Descrizione |
|---|---|---|
| entraAppAuthentication |
La configurazione di registrazione dell'app Microsoft Entra di proprietà del cliente utilizzata per l'autenticazione a nome dell'API Work IQ. Il cliente registra un'app Entra di proprietà del tenant, le concede il permesso delegato WorkIQAgent.Ask e configura una credenziale federata affinché Azure AI Search possa autenticarsi come quell'app senza un segreto client memorizzato. |