Knowledge Sources - Create Or Update

Služba:: Search Service

Verze rozhraní API:: 2025-11-01-preview

Vytvoří nový zdroj znalostí nebo aktualizuje zdroj znalostí, pokud již existuje.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
sourceName	path	True	string	Název zdroje znalostí.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Accept		Accept	Hlavička Accept.
If-Match		string	Definuje podmínku If-Match. Operace bude provedena pouze v případě, že značka ETag na serveru odpovídá této hodnotě.
If-None-Match		string	Definuje podmínku If-None-Match. Operace bude provedena pouze v případě, že značka ETag na serveru neodpovídá této hodnotě.
Prefer	True	Prefer	U požadavků HTTP PUT dává pokyn službě, aby v případě úspěchu vrátila vytvořený/aktualizovaný prostředek.
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Text požadavku

Text žádosti může tvořit:

Name	Description
AzureBlobKnowledgeSource	Konfigurace pro zdroj znalostí Azure Blob Storage.
IndexedOneLakeKnowledgeSource	Konfigurace pro zdroj znalostí OneLake.
IndexedSharePointKnowledgeSource	Konfigurace pro zdroj znalostí SharePoint.
RemoteSharePointKnowledgeSource	Konfigurace pro vzdálený zdroj znalostí SharePoint.
SearchIndexKnowledgeSource	Zdroj znalostí: Cílení na vyhledávací index.
WebKnowledgeSource	Zdroj znalostí: Cílení na webové výsledky.

AzureBlobKnowledgeSource

Konfigurace pro zdroj znalostí Azure Blob Storage.

Name	Vyžadováno	Typ	Description
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Typ zdroje znalostí.
kind	True	string: azureBlob	Typ zdroje znalostí.
name	True	string	Název zdroje znalostí.
@odata.etag		string	ETag zdroje znalostí.
description		string	Volitelný uživatelsky definovaný popis.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

IndexedOneLakeKnowledgeSource

Konfigurace pro zdroj znalostí OneLake.

Name	Vyžadováno	Typ	Description
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Parametry pro zdroj znalostí.
kind	True	string: indexedOneLake	Typ zdroje znalostí.
name	True	string	Název zdroje znalostí.
@odata.etag		string	ETag zdroje znalostí.
description		string	Volitelný uživatelsky definovaný popis.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

IndexedSharePointKnowledgeSource

Konfigurace pro zdroj znalostí SharePoint.

Name	Vyžadováno	Typ	Description
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Parametry pro zdroj znalostí.
kind	True	string: indexedSharePoint	Typ zdroje znalostí.
name	True	string	Název zdroje znalostí.
@odata.etag		string	ETag zdroje znalostí.
description		string	Volitelný uživatelsky definovaný popis.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

RemoteSharePointKnowledgeSource

Konfigurace pro vzdálený zdroj znalostí SharePoint.

Name	Vyžadováno	Typ	Description
kind	True	string: remoteSharePoint	Typ zdroje znalostí.
name	True	string	Název zdroje znalostí.
@odata.etag		string	ETag zdroje znalostí.
description		string	Volitelný uživatelsky definovaný popis.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	Parametry pro vzdálený zdroj znalostí SharePoint.

SearchIndexKnowledgeSource

Zdroj znalostí: Cílení na vyhledávací index.

Name	Vyžadováno	Typ	Description
kind	True	string: searchIndex	Typ zdroje znalostí.
name	True	string	Název zdroje znalostí.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Parametry pro zdroj znalostí.
@odata.etag		string	ETag zdroje znalostí.
description		string	Volitelný uživatelsky definovaný popis.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.

WebKnowledgeSource

Zdroj znalostí: Cílení na webové výsledky.

Name	Vyžadováno	Typ	Description
kind	True	string: web	Typ zdroje znalostí.
name	True	string	Název zdroje znalostí.
@odata.etag		string	ETag zdroje znalostí.
description		string	Volitelný uživatelsky definovaný popis.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
webParameters		WebKnowledgeSourceParameters	Parametry webového zdroje znalostí.

Odpovědi

Name	Typ	Description
200 OK	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Požadavek byl úspěšný.
201 Created	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSource

Ukázkový požadavek

HTTP

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





{
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig"
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

Stavový kód:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

Ukázkový požadavek

HTTP

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





{
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

Stavový kód:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

Ukázkový požadavek

HTTP

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





{
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-test",
  "description": "Description of the OneLake knowledge source.",
  "kind": "indexedOneLake",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

Stavový kód:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

Ukázkový požadavek

HTTP

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





{
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-test",
  "description": "Description of the SharePoint knowledge source.",
  "kind": "indexedSharePoint",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

Stavový kód:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

Ukázkový požadavek

HTTP

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





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

Ukázková odpověď

Stavový kód:: 200

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

Stavový kód:: 201

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

Definice

Name	Description
Accept	Hlavička Accept.
AIServices	Parametry pro služby AI.
AzureBlobKnowledgeSource	Konfigurace pro zdroj znalostí Azure Blob Storage.
AzureBlobKnowledgeSourceParameters	Parametry pro zdroj znalostí služby Azure Blob Storage.
AzureOpenAIModelName	Název modelu Azure Open AI, který se bude volat.
AzureOpenAIVectorizerParameters	Určuje parametry pro připojení k prostředku Azure OpenAI.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
IndexedOneLakeKnowledgeSource	Konfigurace pro zdroj znalostí OneLake.
IndexedOneLakeKnowledgeSourceParameters	Parametry pro zdroj znalostí OneLake.
IndexedSharePointContainerName	Určuje, ke kterým knihovnám SharePoint se má přistupovat.
IndexedSharePointKnowledgeSource	Konfigurace pro zdroj znalostí SharePoint.
IndexedSharePointKnowledgeSourceParameters	Parametry pro zdroj znalostí SharePoint.
IndexingSchedule	Představuje plán provádění indexeru.
KnowledgeBaseAzureOpenAIModel	Určuje prostředek Azure OpenAI používaný k plánování dotazů.
KnowledgeBaseModelKind	Model umělé inteligence, který se má použít pro plánování dotazů.
KnowledgeSourceAzureOpenAIVectorizer	Určuje prostředek Azure OpenAI použitý k vektorizaci řetězce dotazu.
KnowledgeSourceIngestionParameters	Konsoliduje všechna obecná nastavení příjmu dat pro zdroje znalostí.
KnowledgeSourceIngestionPermissionOption	Typy oprávnění pro vstup do obsahu dokumentu.
KnowledgeSourceKind	Druh zdroje znalostí.
Prefer	U požadavků HTTP PUT dává pokyn službě, aby v případě úspěchu vrátila vytvořený/aktualizovaný prostředek.
RemoteSharePointKnowledgeSource	Konfigurace pro vzdálený zdroj znalostí SharePoint.
RemoteSharePointKnowledgeSourceParameters	Parametry pro vzdálený zdroj znalostí SharePoint.
SearchIndexerDataNoneIdentity	Vymaže vlastnost identity zdroje dat.
SearchIndexerDataUserAssignedIdentity	Určuje identitu zdroje dat, která se má použít.
SearchIndexFieldReference	Referenční pole pro vyhledávací index.
SearchIndexKnowledgeSource	Zdroj znalostí: Cílení na vyhledávací index.
SearchIndexKnowledgeSourceParameters	Parametry pro vyhledávací index zdroje znalostí.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.
VectorSearchVectorizerKind	Metoda vektorizace, která se má použít během doby dotazu.
WebKnowledgeSource	Zdroj znalostí: Cílení na webové výsledky.
WebKnowledgeSourceDomain	Konfigurace pro webovou zdrojovou doménu znalostí.
WebKnowledgeSourceDomains	Konfigurace povolení/blokování domény pro webový zdroj znalostí.
WebKnowledgeSourceParameters	Parametry pro webový zdroj znalostí.

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=minimal

AIServices

Objekt

Parametry pro služby AI.

Name	Typ	Description
apiKey	string	Klíč API pro přístup ke službám AI.
uri	string (uri)	Identifikátor URI koncového bodu služby AI.

AzureBlobKnowledgeSource

Objekt

Konfigurace pro zdroj znalostí Azure Blob Storage.

Name	Typ	Description
@odata.etag	string	ETag zdroje znalostí.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Typ zdroje znalostí.
description	string	Volitelný uživatelsky definovaný popis.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
kind	string: azureBlob	Typ zdroje znalostí.
name	string	Název zdroje znalostí.

AzureBlobKnowledgeSourceParameters

Objekt

Parametry pro zdroj znalostí služby Azure Blob Storage.

Name	Typ	Default value	Description
connectionString	string		Připojovací řetězec založený na klíči nebo formát ResourceId, pokud používáte spravovanou identitu.
containerName	string		Název kontejneru úložiště objektů blob.
createdResources	object		Zdroje vytvořené zdrojem znalostí.
folderPath	string		Volitelná cesta ke složce v rámci kontejneru.
ingestionParameters	KnowledgeSourceIngestionParameters		Konsoliduje všechna obecná nastavení příjmu dat.
isADLSGen2	boolean	False	Pokud se připojujete k účtu úložiště ADLS Gen2, nastavte na hodnotu true. Výchozí hodnota je False.

AzureOpenAIModelName

Výčet

Název modelu Azure Open AI, který se bude volat.

Hodnota	Description
text-embedding-ada-002	Model TextEmbeddingAda002.
text-embedding-3-large	TextEmbedding3Large model.
text-embedding-3-small	Model TextEmbedding3Small.
gpt-4o	Model Gpt4o.
gpt-4o-mini	Model Gpt4oMini.
gpt-4.1	Model Gpt41.
gpt-4.1-mini	Model Gpt41Mini.
gpt-4.1-nano	Model Gpt41Nano.
gpt-5	Model GPT5.
gpt-5-mini	Model Gpt5Mini.
gpt-5-nano	Model Gpt5Nano.

AzureOpenAIVectorizerParameters

Objekt

Určuje parametry pro připojení k prostředku Azure OpenAI.

Name	Typ	Description
apiKey	string	Klíč rozhraní API určeného prostředku Azure OpenAI
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Spravovaná identita přiřazená uživatelem používaná pro odchozí připojení.
deploymentId	string	ID nasazení modelu Azure OpenAI v určeném prostředku
modelName	AzureOpenAIModelName	Název modelu vložení, který je nasazený na zadané cestě deploymentId.
resourceUri	string (uri)	Identifikátor URI prostředku Azure OpenAI.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

IndexedOneLakeKnowledgeSource

Objekt

Konfigurace pro zdroj znalostí OneLake.

Name	Typ	Description
@odata.etag	string	ETag zdroje znalostí.
description	string	Volitelný uživatelsky definovaný popis.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Parametry pro zdroj znalostí.
kind	string: indexedOneLake	Typ zdroje znalostí.
name	string	Název zdroje znalostí.

IndexedOneLakeKnowledgeSourceParameters

Objekt

Parametry pro zdroj znalostí OneLake.

Name	Typ	Description
createdResources	object	Zdroje vytvořené zdrojem znalostí.
fabricWorkspaceId	string	ID pracovního prostoru OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Konsoliduje všechna obecná nastavení příjmu dat.
lakehouseId	string	Určuje, ke kterému jezernímu domu OneLake se má přistupovat.
targetPath	string	Volitelná složka nebo zástupce OneLakehouse pro filtrování obsahu OneLake.

IndexedSharePointContainerName

Výčet

Určuje, ke kterým knihovnám SharePoint se má přistupovat.

Hodnota	Description
defaultSiteLibrary	Indexujte obsah z výchozí knihovny dokumentů webu.
allSiteLibraries	Indexujte obsah ze všech knihoven dokumentů na webu.
useQuery	Použijte dotaz k filtrování obsahu SharePointu.

IndexedSharePointKnowledgeSource

Objekt

Konfigurace pro zdroj znalostí SharePoint.

Name	Typ	Description
@odata.etag	string	ETag zdroje znalostí.
description	string	Volitelný uživatelsky definovaný popis.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Parametry pro zdroj znalostí.
kind	string: indexedSharePoint	Typ zdroje znalostí.
name	string	Název zdroje znalostí.

IndexedSharePointKnowledgeSourceParameters

Objekt

Parametry pro zdroj znalostí SharePoint.

Name	Typ	Description
connectionString	string	Připojovací řetězec služby SharePoint s formátem: SharePointOnlineEndpoint=[adresa URL webu SharePoint]; ApplicationId=[ID aplikace Azure AD]; ApplicationSecret=[Tajný klíč klienta aplikace Azure AD]; TenantId=[ID tenanta sharepointového webu]
containerName	IndexedSharePointContainerName	Určuje, ke kterým knihovnám SharePoint se má přistupovat.
createdResources	object	Zdroje vytvořené zdrojem znalostí.
ingestionParameters	KnowledgeSourceIngestionParameters	Konsoliduje všechna obecná nastavení příjmu dat.
query	string	Volitelný dotaz pro filtrování obsahu SharePoint.

IndexingSchedule

Objekt

Představuje plán provádění indexeru.

Name	Typ	Description
interval	string (duration)	Časový interval mezi provedeními indexeru.
startTime	string (date-time)	Čas, kdy by měl indexer začít běžet.

KnowledgeBaseAzureOpenAIModel

Objekt

Určuje prostředek Azure OpenAI používaný k plánování dotazů.

Name	Typ	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI parametry.
kind	string: azureOpenAI	Model umělé inteligence, který se má použít pro plánování dotazů.

KnowledgeBaseModelKind

Výčet

Model umělé inteligence, který se má použít pro plánování dotazů.

Hodnota	Description
azureOpenAI	K plánování dotazů používejte modely Azure Open AI.

KnowledgeSourceAzureOpenAIVectorizer

Objekt

Určuje prostředek Azure OpenAI použitý k vektorizaci řetězce dotazu.

Name	Typ	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Obsahuje parametry specifické pro vektorizaci vkládání Azure OpenAI.
kind	string: azureOpenAI	Název druhu metody vektorizace, která je konfigurována pro použití s vektorovým vyhledáváním.

KnowledgeSourceIngestionParameters

Objekt

Konsoliduje všechna obecná nastavení příjmu dat pro zdroje znalostí.

Name	Typ	Default value	Description
aiServices	AIServices		Volitelná konfigurace služeb AI Services pro zpracování obsahu.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Volitelný model doplňování chatu pro verbalizaci obrázků nebo extrakci kontextu.
contentExtractionMode	enum: minimal standard	minimal	Volitelný režim extrakce obsahu. Výchozí hodnota je 'minimální'.
disableImageVerbalization	boolean	False	Označuje, zda má být verbalizace obrazu vypnutá. Výchozí hodnota je False.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Volitelná konfigurace vektorizátoru pro vektorizaci obsahu.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Explicitní identita, která se má použít pro tento zdroj znalostí.
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		Volitelný seznam typů oprávnění pro ingestování společně s obsahem dokumentu. Pokud je zadaný, nastaví možnosti oprávnění indexeru pro zdroj dat.
ingestionSchedule	IndexingSchedule		Volitelný plán pro příjem dat.

KnowledgeSourceIngestionPermissionOption

Výčet

Typy oprávnění pro vstup do obsahu dokumentu.

Hodnota	Description
userIds	Ingestujte explicitní identifikátory uživatelů spolu s obsahem dokumentu.
groupIds	Ingestujte identifikátory skupin spolu s obsahem dokumentu.
rbacScope	Ingestujte informace o rozsahu RBAC společně s obsahem dokumentu.

KnowledgeSourceKind

Výčet

Druh zdroje znalostí.

Hodnota	Description
searchIndex	Zdroj znalostí, který čte data z indexu vyhledávání.
azureBlob	Zdroj znalostí, který čte a ingestuje data z Azure Blob Storage do indexu vyhledávání.
indexedSharePoint	Zdroj znalostí, který čte data z indexovaného SharePointu.
indexedOneLake	Zdroj znalostí, který čte data z indexovaného OneLake.
web	Zdroj znalostí, který čte data z webu.
remoteSharePoint	Zdroj znalostí, který čte data z vzdáleného SharePointu.

Prefer

Výčet

U požadavků HTTP PUT dává pokyn službě, aby v případě úspěchu vrátila vytvořený/aktualizovaný prostředek.

Hodnota	Description
return=representation

RemoteSharePointKnowledgeSource

Objekt

Konfigurace pro vzdálený zdroj znalostí SharePoint.

Name	Typ	Description
@odata.etag	string	ETag zdroje znalostí.
description	string	Volitelný uživatelsky definovaný popis.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
kind	string: remoteSharePoint	Typ zdroje znalostí.
name	string	Název zdroje znalostí.
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	Parametry pro vzdálený zdroj znalostí SharePoint.

RemoteSharePointKnowledgeSourceParameters

Objekt

Parametry pro vzdálený zdroj znalostí SharePoint.

Name	Typ	Description
containerTypeId	string	ID kontejneru pro připojení ke službě SharePoint Embedded. Pokud je tato hodnota null, použije se SharePoint Online.
filterExpression	string	Výraz KQL (Keyword Query Language) s dotazovatelnými vlastnostmi a atributy SharePointu pro rozsah načítání před spuštěním dotazu.
resourceMetadata	string[]	Seznam polí metadat, která mají být vrácena pro každou položku v odpovědi. Do tohoto seznamu lze zahrnout pouze načíst vlastnosti metadat. Ve výchozím nastavení se nevrací žádná metadata.

SearchIndexerDataNoneIdentity

Objekt

Vymaže vlastnost identity zdroje dat.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identifikátoru URI určující typ identity.

SearchIndexerDataUserAssignedIdentity

Objekt

Určuje identitu zdroje dat, která se má použít.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identifikátoru URI určující typ identity.
userAssignedIdentity	string	Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", které by mělo být přiřazeno vyhledávací službě.

SearchIndexFieldReference

Objekt

Referenční pole pro vyhledávací index.

Name	Typ	Description
name	string	Název pole.

SearchIndexKnowledgeSource

Objekt

Zdroj znalostí: Cílení na vyhledávací index.

Name	Typ	Description
@odata.etag	string	ETag zdroje znalostí.
description	string	Volitelný uživatelsky definovaný popis.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
kind	string: searchIndex	Typ zdroje znalostí.
name	string	Název zdroje znalostí.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Parametry pro zdroj znalostí.

SearchIndexKnowledgeSourceParameters

Objekt

Parametry pro vyhledávací index zdroje znalostí.

Name	Typ	Description
searchFields	SearchIndexFieldReference[]	Slouží k omezení polí, která se mají prohledávat ve vyhledávacím indexu.
searchIndexName	string	Název indexu vyhledávání.
semanticConfigurationName	string	Slouží k určení jiné sémantické konfigurace cílového vyhledávacího indexu, než je výchozí.
sourceDataFields	SearchIndexFieldReference[]	Slouží k vyžádání dalších polí pro odkazovaná zdrojová data.

SearchResourceEncryptionKey

Objekt

Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Name	Typ	Description
accessCredentials.applicationId	string	ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění ke službě Azure Key Vault, která se má použít při šifrování neaktivních uložených dat. ID aplikace by nemělo být zaměňováno s ID objektu pro vaši aplikaci AAD.
accessCredentials.applicationSecret	string	Ověřovací klíč zadané aplikace AAD.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána.
keyVaultKeyName	string	Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI služby Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být `https://my-keyvault-name.vault.azure.net`.

VectorSearchVectorizerKind

Výčet

Metoda vektorizace, která se má použít během doby dotazu.

Hodnota	Description
azureOpenAI	Generování vkládání pomocí prostředku Azure OpenAI v době dotazu
customWebApi	Generování vkládání pomocí vlastního webového koncového bodu v době dotazu
aiServicesVision	Generování vkládání pro obrázek nebo textový vstup v době dotazu pomocí rozhraní API pro zpracování obrazu ve službě Azure AI Services Vectorize
aml	Generování vložení pomocí koncového bodu Azure Machine Learning nasazeného prostřednictvím katalogu modelů Azure AI Foundry v době dotazu.

WebKnowledgeSource

Objekt

Zdroj znalostí: Cílení na webové výsledky.

Name	Typ	Description
@odata.etag	string	ETag zdroje znalostí.
description	string	Volitelný uživatelsky definovaný popis.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování v klidu pro definici zdroje znalostí, když chcete mít plnou jistotu, že nikdo, ani Microsoft, je nemůže dešifrovat. Jakmile zašifrujete definici zdroje znalostí, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby měnit, pokud chcete šifrovací klíč otáčet; Definice vašeho zdroje znalostí zůstane nedotčena. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
kind	string: web	Typ zdroje znalostí.
name	string	Název zdroje znalostí.
webParameters	WebKnowledgeSourceParameters	Parametry webového zdroje znalostí.

WebKnowledgeSourceDomain

Objekt

Konfigurace pro webovou zdrojovou doménu znalostí.

Name	Typ	Description
address	string	Adresa domény.
includeSubpages	boolean	Zda zahrnout podstránky z této domény.

WebKnowledgeSourceDomains

Objekt

Konfigurace povolení/blokování domény pro webový zdroj znalostí.

Name	Typ	Description
allowedDomains	WebKnowledgeSourceDomain[]	Domény, které jsou povoleny pro webové výsledky.
blockedDomains	WebKnowledgeSourceDomain[]	Domény, které jsou blokovány ve webových výsledcích.

WebKnowledgeSourceParameters

Objekt

Parametry pro webový zdroj znalostí.

Name	Typ	Description
domains	WebKnowledgeSourceDomains	Konfigurace povolení/blokování domény pro webové výsledky.