Knowledge Sources - Create Or Update

Layanan:: Search Service

Versi API:: 2025-11-01-preview

Membuat sumber pengetahuan baru atau memperbarui sumber pengetahuan jika sudah ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	URL titik akhir layanan pencarian.
sourceName	path	True	string	Nama sumber pengetahuan.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Accept		Accept	Header Terima.
If-Match		string	Menentukan kondisi If-Match. Operasi akan dilakukan hanya jika ETag di server cocok dengan nilai ini.
If-None-Match		string	Menentukan kondisi If-None-Match. Operasi akan dilakukan hanya jika ETag di server tidak cocok dengan nilai ini.
Prefer	True	Prefer	Untuk permintaan HTTP PUT, menginstruksikan layanan untuk mengembalikan sumber daya yang dibuat/diperbarui setelah berhasil.
x-ms-client-request-id		string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Isi Permintaan

Isi permintaan dapat berupa salah satu hal berikut:

Nama	Deskripsi
AzureBlobKnowledgeSource	Konfigurasi untuk sumber pengetahuan Azure Blob Storage.
IndexedOneLakeKnowledgeSource	Konfigurasi untuk sumber pengetahuan OneLake.
IndexedSharePointKnowledgeSource	Konfigurasi untuk sumber pengetahuan SharePoint.
RemoteSharePointKnowledgeSource	Konfigurasi untuk sumber pengetahuan SharePoint jarak jauh.
SearchIndexKnowledgeSource	Sumber Pengetahuan menargetkan indeks penelusuran.
WebKnowledgeSource	Sumber Pengetahuan menargetkan hasil web.

AzureBlobKnowledgeSource

Konfigurasi untuk sumber pengetahuan Azure Blob Storage.

Nama	Diperlukan	Jenis	Deskripsi
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Jenis sumber pengetahuan.
kind	True	string: azureBlob	Jenis sumber pengetahuan.
name	True	string	Nama sumber pengetahuan.
@odata.etag		string	ETag dari sumber pengetahuan.
description		string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey		SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.

IndexedOneLakeKnowledgeSource

Konfigurasi untuk sumber pengetahuan OneLake.

Nama	Diperlukan	Jenis	Deskripsi
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Parameter untuk sumber pengetahuan.
kind	True	string: indexedOneLake	Jenis sumber pengetahuan.
name	True	string	Nama sumber pengetahuan.
@odata.etag		string	ETag dari sumber pengetahuan.
description		string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey		SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.

IndexedSharePointKnowledgeSource

Konfigurasi untuk sumber pengetahuan SharePoint.

Nama	Diperlukan	Jenis	Deskripsi
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Parameter untuk sumber pengetahuan.
kind	True	string: indexedSharePoint	Jenis sumber pengetahuan.
name	True	string	Nama sumber pengetahuan.
@odata.etag		string	ETag dari sumber pengetahuan.
description		string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey		SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.

RemoteSharePointKnowledgeSource

Konfigurasi untuk sumber pengetahuan SharePoint jarak jauh.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: remoteSharePoint	Jenis sumber pengetahuan.
name	True	string	Nama sumber pengetahuan.
@odata.etag		string	ETag dari sumber pengetahuan.
description		string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey		SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	Parameter untuk sumber pengetahuan SharePoint jarak jauh.

SearchIndexKnowledgeSource

Sumber Pengetahuan menargetkan indeks penelusuran.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: searchIndex	Jenis sumber pengetahuan.
name	True	string	Nama sumber pengetahuan.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Parameter untuk sumber pengetahuan.
@odata.etag		string	ETag dari sumber pengetahuan.
description		string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey		SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.

WebKnowledgeSource

Sumber Pengetahuan menargetkan hasil web.

Nama	Diperlukan	Jenis	Deskripsi
kind	True	string: web	Jenis sumber pengetahuan.
name	True	string	Nama sumber pengetahuan.
@odata.etag		string	ETag dari sumber pengetahuan.
description		string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey		SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
webParameters		WebKnowledgeSourceParameters	Parameter untuk sumber pengetahuan web.

Respons

Nama	Jenis	Deskripsi
200 OK	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Permintaan telah berhasil.
201 Created	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://search.azure.com/.default

Contoh

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSource

Permintaan sampel

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>"
    }
  }
}

Respon sampel

Kode status:: 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": "*"
      }
    ]
  }
}

Kode status:: 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

Permintaan sampel

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>"
    }
  }
}

Respon sampel

Kode status:: 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"
    }
  }
}

Kode status:: 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

Permintaan sampel

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>"
    }
  }
}

Respon sampel

Kode status:: 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"
      }
    }
  }
}

Kode status:: 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

Permintaan sampel

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>"
    }
  }
}

Respon sampel

Kode status:: 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"
      }
    }
  }
}

Kode status:: 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

Permintaan sampel

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>"
    }
  }
}

Respon sampel

Kode status:: 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
        }
      ]
    }
  }
}

Kode status:: 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
        }
      ]
    }
  }
}

Definisi

Nama	Deskripsi
Accept	Header Terima.
AIServices	Parameter untuk Layanan AI.
AzureBlobKnowledgeSource	Konfigurasi untuk sumber pengetahuan Azure Blob Storage.
AzureBlobKnowledgeSourceParameters	Parameter untuk sumber pengetahuan Azure Blob Storage.
AzureOpenAIModelName	Nama model Azure Open AI yang akan dipanggil.
AzureOpenAIVectorizerParameters	Menentukan parameter untuk menyambungkan ke sumber daya Azure OpenAI.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
IndexedOneLakeKnowledgeSource	Konfigurasi untuk sumber pengetahuan OneLake.
IndexedOneLakeKnowledgeSourceParameters	Parameter untuk sumber pengetahuan OneLake.
IndexedSharePointContainerName	Menentukan pustaka SharePoint mana yang akan diakses.
IndexedSharePointKnowledgeSource	Konfigurasi untuk sumber pengetahuan SharePoint.
IndexedSharePointKnowledgeSourceParameters	Parameter untuk sumber pengetahuan SharePoint.
IndexingSchedule	Mewakili jadwal untuk eksekusi pengindeks.
KnowledgeBaseAzureOpenAIModel	Menentukan sumber daya Azure OpenAI yang digunakan untuk melakukan perencanaan kueri.
KnowledgeBaseModelKind	Model AI yang akan digunakan untuk perencanaan kueri.
KnowledgeSourceAzureOpenAIVectorizer	Menentukan sumber daya Azure OpenAI yang digunakan untuk mengvektorkan string kueri.
KnowledgeSourceIngestionParameters	Mengkonsolidasikan semua pengaturan penyerapan umum untuk sumber pengetahuan.
KnowledgeSourceIngestionPermissionOption	Jenis izin untuk diserap bersama dengan konten dokumen.
KnowledgeSourceKind	Jenis sumber pengetahuan.
Prefer	Untuk permintaan HTTP PUT, menginstruksikan layanan untuk mengembalikan sumber daya yang dibuat/diperbarui setelah berhasil.
RemoteSharePointKnowledgeSource	Konfigurasi untuk sumber pengetahuan SharePoint jarak jauh.
RemoteSharePointKnowledgeSourceParameters	Parameter untuk sumber pengetahuan SharePoint jarak jauh.
SearchIndexerDataNoneIdentity	Menghapus properti identitas sumber data.
SearchIndexerDataUserAssignedIdentity	Menentukan identitas untuk sumber data yang akan digunakan.
SearchIndexFieldReference	Referensi bidang untuk indeks pencarian.
SearchIndexKnowledgeSource	Sumber Pengetahuan menargetkan indeks penelusuran.
SearchIndexKnowledgeSourceParameters	Parameter untuk sumber pengetahuan indeks pencarian.
SearchResourceEncryptionKey	Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data-at-rest, seperti indeks dan peta sinonim.
VectorSearchVectorizerKind	Metode vektorisasi yang akan digunakan selama waktu kueri.
WebKnowledgeSource	Sumber Pengetahuan menargetkan hasil web.
WebKnowledgeSourceDomain	Konfigurasi untuk domain sumber pengetahuan web.
WebKnowledgeSourceDomains	Konfigurasi izinkan/blokir domain untuk sumber pengetahuan web.
WebKnowledgeSourceParameters	Parameter untuk sumber pengetahuan web.

Accept

Enumerasi

Header Terima.

Nilai	Deskripsi
application/json;odata.metadata=minimal

AIServices

Objek

Parameter untuk Layanan AI.

Nama	Jenis	Deskripsi
apiKey	string	Kunci API untuk mengakses Layanan AI.
uri	string (uri)	URI titik akhir Layanan AI.

AzureBlobKnowledgeSource

Objek

Konfigurasi untuk sumber pengetahuan Azure Blob Storage.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag dari sumber pengetahuan.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Jenis sumber pengetahuan.
description	string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
kind	string: azureBlob	Jenis sumber pengetahuan.
name	string	Nama sumber pengetahuan.

AzureBlobKnowledgeSourceParameters

Objek

Parameter untuk sumber pengetahuan Azure Blob Storage.

Nama	Jenis	Nilai default	Deskripsi
connectionString	string		String koneksi berbasis kunci atau format ResourceId jika menggunakan identitas terkelola.
containerName	string		Nama kontainer penyimpanan blob.
createdResources	object		Sumber daya yang dibuat oleh sumber pengetahuan.
folderPath	string		Jalur folder opsional dalam kontainer.
ingestionParameters	KnowledgeSourceIngestionParameters		Mengkonsolidasikan semua pengaturan penyerapan umum.
isADLSGen2	boolean	False	Atur ke true jika terhubung ke akun penyimpanan ADLS Gen2. Secara default adalah false.

AzureOpenAIModelName

Enumerasi

Nama model Azure Open AI yang akan dipanggil.

Nilai	Deskripsi
text-embedding-ada-002	TextEmbeddingAda002 model.
text-embedding-3-large	TextEmbedding3Model besar.
text-embedding-3-small	TextEmbedding3Model kecil.
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

Objek

Menentukan parameter untuk menyambungkan ke sumber daya Azure OpenAI.

Nama	Jenis	Deskripsi
apiKey	string	Kunci API dari sumber daya Azure OpenAI yang ditunjuk.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar.
deploymentId	string	ID penyebaran model Azure OpenAI pada sumber daya yang ditunjuk.
modelName	AzureOpenAIModelName	Nama model penyematan yang disebarkan di jalur deploymentId yang disediakan.
resourceUri	string (uri)	URI sumber daya sumber daya Azure OpenAI.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IndexedOneLakeKnowledgeSource

Objek

Konfigurasi untuk sumber pengetahuan OneLake.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag dari sumber pengetahuan.
description	string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Parameter untuk sumber pengetahuan.
kind	string: indexedOneLake	Jenis sumber pengetahuan.
name	string	Nama sumber pengetahuan.

IndexedOneLakeKnowledgeSourceParameters

Objek

Parameter untuk sumber pengetahuan OneLake.

Nama	Jenis	Deskripsi
createdResources	object	Sumber daya yang dibuat oleh sumber pengetahuan.
fabricWorkspaceId	string	ID ruang kerja OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Mengkonsolidasikan semua pengaturan penyerapan umum.
lakehouseId	string	Menentukan rumah danau OneLake mana yang akan diakses.
targetPath	string	Folder atau pintasan OneLakehouse opsional untuk memfilter konten OneLake.

IndexedSharePointContainerName

Enumerasi

Menentukan pustaka SharePoint mana yang akan diakses.

Nilai	Deskripsi
defaultSiteLibrary	Indeks konten dari pustaka dokumen default situs.
allSiteLibraries	Indeks konten dari setiap pustaka dokumen di situs.
useQuery	Gunakan kueri untuk memfilter konten SharePoint.

IndexedSharePointKnowledgeSource

Objek

Konfigurasi untuk sumber pengetahuan SharePoint.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag dari sumber pengetahuan.
description	string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Parameter untuk sumber pengetahuan.
kind	string: indexedSharePoint	Jenis sumber pengetahuan.
name	string	Nama sumber pengetahuan.

IndexedSharePointKnowledgeSourceParameters

Objek

Parameter untuk sumber pengetahuan SharePoint.

Nama	Jenis	Deskripsi
connectionString	string	String koneksi SharePoint dengan format: SharePointOnlineEndpoint=[URL situs SharePoint]; ApplicationId=[ID Aplikasi Azure AD]; ApplicationSecret=[Rahasia klien Aplikasi Azure AD]; TenantId=[ID penyewa situs SharePoint]
containerName	IndexedSharePointContainerName	Menentukan pustaka SharePoint mana yang akan diakses.
createdResources	object	Sumber daya yang dibuat oleh sumber pengetahuan.
ingestionParameters	KnowledgeSourceIngestionParameters	Mengkonsolidasikan semua pengaturan penyerapan umum.
query	string	Kueri opsional untuk memfilter konten SharePoint.

IndexingSchedule

Objek

Mewakili jadwal untuk eksekusi pengindeks.

Nama	Jenis	Deskripsi
interval	string (duration)	Interval waktu antara eksekusi pengindeks.
startTime	string (date-time)	Waktu ketika pengindeks harus mulai berjalan.

KnowledgeBaseAzureOpenAIModel

Objek

Menentukan sumber daya Azure OpenAI yang digunakan untuk melakukan perencanaan kueri.

Nama	Jenis	Deskripsi
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Parameter Azure OpenAI.
kind	string: azureOpenAI	Model AI yang akan digunakan untuk perencanaan kueri.

KnowledgeBaseModelKind

Enumerasi

Model AI yang akan digunakan untuk perencanaan kueri.

Nilai	Deskripsi
azureOpenAI	Gunakan model Azure Open AI untuk perencanaan kueri.

KnowledgeSourceAzureOpenAIVectorizer

Objek

Menentukan sumber daya Azure OpenAI yang digunakan untuk mengvektorkan string kueri.

Nama	Jenis	Deskripsi
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Berisi parameter khusus untuk vektorisasi penyematan Azure OpenAI.
kind	string: azureOpenAI	Nama jenis metode vektorisasi yang dikonfigurasi untuk digunakan dengan pencarian vektor.

KnowledgeSourceIngestionParameters

Objek

Mengkonsolidasikan semua pengaturan penyerapan umum untuk sumber pengetahuan.

Nama	Jenis	Nilai default	Deskripsi
aiServices	AIServices		Konfigurasi Layanan AI opsional untuk pemrosesan konten.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Model penyelesaian obrolan opsional untuk verbalisasi gambar atau ekstraksi konteks.
contentExtractionMode	enum: minimal standard	minimal	Mode ekstraksi konten opsional. Defaultnya adalah 'minimal'.
disableImageVerbalization	boolean	False	Menunjukkan apakah verbalisasi gambar harus dinonaktifkan. Secara default adalah false.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Konfigurasi vektor opsional untuk vektorisasi konten.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Identitas eksplisit untuk digunakan untuk sumber pengetahuan ini.
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		Daftar opsional jenis izin untuk diserap bersama dengan konten dokumen. Jika ditentukan, ini akan mengatur opsi izin pengindeks untuk sumber data.
ingestionSchedule	IndexingSchedule		Jadwal opsional untuk penyerapan data.

KnowledgeSourceIngestionPermissionOption

Enumerasi

Jenis izin untuk diserap bersama dengan konten dokumen.

Nilai	Deskripsi
userIds	Menyerap ID pengguna eksplisit bersama konten dokumen.
groupIds	Menyerap pengidentifikasi grup bersama konten dokumen.
rbacScope	Menyerap informasi cakupan RBAC bersama konten dokumen.

KnowledgeSourceKind

Enumerasi

Jenis sumber pengetahuan.

Nilai	Deskripsi
searchIndex	Sumber pengetahuan yang membaca data dari Indeks Pencarian.
azureBlob	Sumber pengetahuan yang membaca dan menyerap data dari Azure Blob Storage ke Indeks Pencarian.
indexedSharePoint	Sumber pengetahuan yang membaca data dari SharePoint yang diindeks.
indexedOneLake	Sumber pengetahuan yang membaca data dari OneLake yang diindeks.
web	Sumber pengetahuan yang membaca data dari web.
remoteSharePoint	Sumber pengetahuan yang membaca data dari SharePoint jarak jauh.

Prefer

Enumerasi

Untuk permintaan HTTP PUT, menginstruksikan layanan untuk mengembalikan sumber daya yang dibuat/diperbarui setelah berhasil.

Nilai	Deskripsi
return=representation

RemoteSharePointKnowledgeSource

Objek

Konfigurasi untuk sumber pengetahuan SharePoint jarak jauh.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag dari sumber pengetahuan.
description	string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
kind	string: remoteSharePoint	Jenis sumber pengetahuan.
name	string	Nama sumber pengetahuan.
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	Parameter untuk sumber pengetahuan SharePoint jarak jauh.

RemoteSharePointKnowledgeSourceParameters

Objek

Parameter untuk sumber pengetahuan SharePoint jarak jauh.

Nama	Jenis	Deskripsi
containerTypeId	string	ID Kontainer untuk koneksi SharePoint Embedded. Jika ini null, itu akan menggunakan SharePoint Online.
filterExpression	string	Ekspresi Bahasa Kueri Kata Kunci (KQL) dengan properti dan atribut SharePoint yang dapat dikueri untuk menjangkau pengambilan sebelum kueri berjalan.
resourceMetadata	string[]	Daftar bidang metadata yang akan dikembalikan untuk setiap item dalam respons. Hanya properti metadata yang dapat diambil yang dapat disertakan dalam daftar ini. Secara default, tidak ada metadata yang dikembalikan.

SearchIndexerDataNoneIdentity

Objek

Menghapus properti identitas sumber data.

Nama	Jenis	Deskripsi
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragmen URI yang menentukan jenis identitas.

SearchIndexerDataUserAssignedIdentity

Objek

Menentukan identitas untuk sumber data yang akan digunakan.

Nama	Jenis	Deskripsi
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragmen URI yang menentukan jenis identitas.
userAssignedIdentity	string	Id sumber daya Azure yang memenuhi syarat penuh dari identitas terkelola yang ditetapkan pengguna biasanya dalam bentuk "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" yang seharusnya ditetapkan ke layanan pencarian.

SearchIndexFieldReference

Objek

Referensi bidang untuk indeks pencarian.

Nama	Jenis	Deskripsi
name	string	Nama bidang.

SearchIndexKnowledgeSource

Objek

Sumber Pengetahuan menargetkan indeks penelusuran.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag dari sumber pengetahuan.
description	string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
kind	string: searchIndex	Jenis sumber pengetahuan.
name	string	Nama sumber pengetahuan.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Parameter untuk sumber pengetahuan.

SearchIndexKnowledgeSourceParameters

Objek

Parameter untuk sumber pengetahuan indeks pencarian.

Nama	Jenis	Deskripsi
searchFields	SearchIndexFieldReference[]	Digunakan untuk membatasi bidang mana yang akan dicari di indeks pencarian.
searchIndexName	string	Nama indeks Pencarian.
semanticConfigurationName	string	Digunakan untuk menentukan konfigurasi semantik yang berbeda pada indeks pencarian target selain yang default.
sourceDataFields	SearchIndexFieldReference[]	Digunakan untuk meminta bidang tambahan untuk data sumber yang direferensikan.

SearchResourceEncryptionKey

Objek

Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data-at-rest, seperti indeks dan peta sinonim.

Nama	Jenis	Deskripsi
accessCredentials.applicationId	string	ID Aplikasi AAD yang diberikan izin akses yang diperlukan ke Azure Key Vault yang akan digunakan saat mengenkripsi data Anda tidak aktif. ID Aplikasi tidak boleh bingung dengan ID Objek untuk Aplikasi AAD Anda.
accessCredentials.applicationSecret	string	Kunci autentikasi aplikasi AAD yang ditentukan.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identitas terkelola eksplisit yang digunakan untuk kunci enkripsi ini. Jika tidak ditentukan dan properti kredensial akses null, identitas terkelola yang ditetapkan sistem akan digunakan. Pada pembaruan ke sumber daya, jika identitas eksplisit tidak ditentukan, identitas tersebut tetap tidak berubah. Jika "tidak ada" ditentukan, nilai properti ini akan dihapus.
keyVaultKeyName	string	Nama kunci Azure Key Vault Anda yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif.
keyVaultKeyVersion	string	Versi kunci Azure Key Vault Anda yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif.
keyVaultUri	string	URI Azure Key Vault Anda, juga disebut sebagai nama DNS, yang berisi kunci yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif. Contoh URI mungkin `https://my-keyvault-name.vault.azure.net`.

VectorSearchVectorizerKind

Enumerasi

Metode vektorisasi yang akan digunakan selama waktu kueri.

Nilai	Deskripsi
azureOpenAI	Buat penyematan menggunakan sumber daya Azure OpenAI pada waktu kueri.
customWebApi	Buat penyematan menggunakan titik akhir web kustom pada waktu kueri.
aiServicesVision	Buat penyematan untuk input gambar atau teks pada waktu kueri menggunakan AZURE AI Services Vision Vectorize API.
aml	Hasilkan penyematan menggunakan titik akhir Azure Machine Learning yang disebarkan melalui Katalog Model Azure AI Foundry pada waktu kueri.

WebKnowledgeSource

Objek

Sumber Pengetahuan menargetkan hasil web.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag dari sumber pengetahuan.
description	string	Deskripsi opsional yang ditentukan pengguna.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi sumber pengetahuan Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi sumber pengetahuan Anda, definisi tersebut akan selalu dienkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi sumber pengetahuan Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan pencarian gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019.
kind	string: web	Jenis sumber pengetahuan.
name	string	Nama sumber pengetahuan.
webParameters	WebKnowledgeSourceParameters	Parameter untuk sumber pengetahuan web.

WebKnowledgeSourceDomain

Objek

Konfigurasi untuk domain sumber pengetahuan web.

Nama	Jenis	Deskripsi
address	string	Alamat domain.
includeSubpages	boolean	Apakah akan menyertakan subhalaman dari domain ini atau tidak.

WebKnowledgeSourceDomains

Objek

Konfigurasi izinkan/blokir domain untuk sumber pengetahuan web.

Nama	Jenis	Deskripsi
allowedDomains	WebKnowledgeSourceDomain[]	Domain yang diizinkan untuk hasil web.
blockedDomains	WebKnowledgeSourceDomain[]	Domain yang diblokir dari hasil web.

WebKnowledgeSourceParameters

Objek

Parameter untuk sumber pengetahuan web.

Nama	Jenis	Deskripsi
domains	WebKnowledgeSourceDomains	Konfigurasi domain izinkan/blokir untuk hasil web.