Knowledge Sources - Create

Usługa:: Search Service

Wersja interfejsu API:: 2025-11-01-preview

Tworzy nowe źródło wiedzy.

POST {endpoint}/knowledgesources?api-version=2025-11-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Accept		Accept	Nagłówek Accept.
x-ms-client-request-id		string (uuid)	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa	Opis
AzureBlobKnowledgeSource	Konfiguracja źródła wiedzy Azure Blob Storage.
IndexedOneLakeKnowledgeSource	Konfiguracja dla źródła wiedzy OneLake.
IndexedSharePointKnowledgeSource	Konfiguracja źródła wiedzy programu SharePoint.
RemoteSharePointKnowledgeSource	Konfiguracja zdalnego źródła wiedzy programu SharePoint.
SearchIndexKnowledgeSource	Źródło wiedzy przeznaczone dla indeksu wyszukiwania.
WebKnowledgeSource	Źródło wiedzy kierowane na wyniki w internecie.

AzureBlobKnowledgeSource

Konfiguracja źródła wiedzy Azure Blob Storage.

Nazwa	Wymagane	Typ	Opis
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Typ źródła wiedzy.
kind	True	string: azureBlob	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
@odata.etag		string	ETag źródła wiedzy.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.

IndexedOneLakeKnowledgeSource

Konfiguracja dla źródła wiedzy OneLake.

Nazwa	Wymagane	Typ	Opis
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Parametry źródła wiedzy.
kind	True	string: indexedOneLake	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
@odata.etag		string	ETag źródła wiedzy.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.

IndexedSharePointKnowledgeSource

Konfiguracja źródła wiedzy programu SharePoint.

Nazwa	Wymagane	Typ	Opis
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Parametry źródła wiedzy.
kind	True	string: indexedSharePoint	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
@odata.etag		string	ETag źródła wiedzy.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.

RemoteSharePointKnowledgeSource

Konfiguracja zdalnego źródła wiedzy programu SharePoint.

Nazwa	Wymagane	Typ	Opis
kind	True	string: remoteSharePoint	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
@odata.etag		string	ETag źródła wiedzy.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	Parametry zdalnego źródła wiedzy SharePoint.

SearchIndexKnowledgeSource

Źródło wiedzy przeznaczone dla indeksu wyszukiwania.

Nazwa	Wymagane	Typ	Opis
kind	True	string: searchIndex	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Parametry źródła wiedzy.
@odata.etag		string	ETag źródła wiedzy.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.

WebKnowledgeSource

Źródło wiedzy kierowane na wyniki w internecie.

Nazwa	Wymagane	Typ	Opis
kind	True	string: web	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
@odata.etag		string	ETag źródła wiedzy.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
webParameters		WebKnowledgeSourceParameters	Parametry internetowego źródła wiedzy.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://search.azure.com/.default

Przykłady

SearchServiceCreateKnowledgeSource

SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSourceIndexedOneLake

SearchServiceCreateKnowledgeSourceIndexedSharePoint

SearchServiceCreateKnowledgeSourceWeb

SearchServiceCreateKnowledgeSource

Przykładowe żądanie

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?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>"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:: 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": "*"
      }
    ]
  }
}

SearchServiceCreateKnowledgeSourceAzureBlob

Przykładowe żądanie

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?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>"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedOneLake

Przykładowe żądanie

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?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>"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedSharePoint

Przykładowe żądanie

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?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>"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:: 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"
      }
    }
  }
}

SearchServiceCreateKnowledgeSourceWeb

Przykładowe żądanie

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?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>"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:: 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
        }
      ]
    }
  }
}

Definicje

Nazwa	Opis
Accept	Nagłówek Accept.
AIServices	Parametry dla usług AI.
AzureBlobKnowledgeSource	Konfiguracja źródła wiedzy Azure Blob Storage.
AzureBlobKnowledgeSourceParameters	Parametry źródła wiedzy Azure Blob Storage.
AzureOpenAIModelName	Nazwa modelu Azure Open AI, który zostanie wywołany.
AzureOpenAIVectorizerParameters	Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
IndexedOneLakeKnowledgeSource	Konfiguracja dla źródła wiedzy OneLake.
IndexedOneLakeKnowledgeSourceParameters	Parametry źródła wiedzy OneLake.
IndexedSharePointContainerName	Określa, do których bibliotek programu SharePoint należy uzyskać dostęp.
IndexedSharePointKnowledgeSource	Konfiguracja źródła wiedzy programu SharePoint.
IndexedSharePointKnowledgeSourceParameters	Parametry źródła wiedzy programu SharePoint.
IndexingSchedule	Reprezentuje harmonogram wykonywania indeksatora.
KnowledgeBaseAzureOpenAIModel	Określa zasób usługi Azure OpenAI używany do planowania zapytań.
KnowledgeBaseModelKind	Model sztucznej inteligencji, który ma być używany do planowania zapytań.
KnowledgeSourceAzureOpenAIVectorizer	Określa zasób usługi Azure OpenAI używany do wektoryzacji ciągu zapytania.
KnowledgeSourceIngestionParameters	Konsoliduje wszystkie ogólne ustawienia pozyskiwania dla źródeł wiedzy.
KnowledgeSourceIngestionPermissionOption	Rodzaje uprawnień do pobierania razem z treścią dokumentu.
KnowledgeSourceKind	Rodzaj źródła wiedzy.
RemoteSharePointKnowledgeSource	Konfiguracja zdalnego źródła wiedzy programu SharePoint.
RemoteSharePointKnowledgeSourceParameters	Parametry zdalnego źródła wiedzy programu SharePoint.
SearchIndexerDataNoneIdentity	Czyści właściwość tożsamości źródła danych.
SearchIndexerDataUserAssignedIdentity	Określa tożsamość źródła danych do użycia.
SearchIndexFieldReference	Referencja polowa dla indeksu wyszukiwania.
SearchIndexKnowledgeSource	Źródło wiedzy przeznaczone dla indeksu wyszukiwania.
SearchIndexKnowledgeSourceParameters	Parametry źródła wiedzy indeksu wyszukiwania.
SearchResourceEncryptionKey	Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.
VectorSearchVectorizerKind	Metoda wektoryzacji, która ma być używana w czasie wykonywania zapytania.
WebKnowledgeSource	Źródło wiedzy kierowane na wyniki w internecie.
WebKnowledgeSourceDomain	Konfiguracja domeny źródła wiedzy sieci Web.
WebKnowledgeSourceDomains	Konfiguracja zezwalania/blokowania domeny dla internetowego źródła wiedzy.
WebKnowledgeSourceParameters	Parametry źródła wiedzy internetowej.

Accept

Wyliczenie

Nagłówek Accept.

Wartość	Opis
application/json;odata.metadata=minimal

AIServices

Objekt

Parametry dla usług AI.

Nazwa	Typ	Opis
apiKey	string	Klucz interfejsu API służący do uzyskiwania dostępu do usług AI.
uri	string (uri)	Identyfikator URI punktu końcowego usług AI.

AzureBlobKnowledgeSource

Objekt

Konfiguracja źródła wiedzy Azure Blob Storage.

Nazwa	Typ	Opis
@odata.etag	string	ETag źródła wiedzy.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Typ źródła wiedzy.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
kind	string: azureBlob	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.

AzureBlobKnowledgeSourceParameters

Objekt

Parametry źródła wiedzy Azure Blob Storage.

Nazwa	Typ	Domyślna wartość	Opis
connectionString	string		Parametry połączenia oparte na kluczach lub format ResourceId w przypadku korzystania z tożsamości zarządzanej.
containerName	string		Nazwa kontenera usługi Blob Storage.
createdResources	object		Zasoby utworzone przez źródło wiedzy.
folderPath	string		Opcjonalna ścieżka folderu w kontenerze.
ingestionParameters	KnowledgeSourceIngestionParameters		Konsoliduje wszystkie ogólne ustawienia pozyskiwania.
isADLSGen2	boolean	False	Ustaw wartość true w przypadku nawiązywania połączenia z kontem magazynu usługi ADLS Gen2. Wartość domyślna to „false”.

AzureOpenAIModelName

Wyliczenie

Nazwa modelu Azure Open AI, który zostanie wywołany.

Wartość	Opis
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

Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI.

Nazwa	Typ	Opis
apiKey	string	Klucz interfejsu API wyznaczonego zasobu usługi Azure OpenAI.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Tożsamość zarządzana przypisana przez użytkownika używana na potrzeby połączeń wychodzących.
deploymentId	string	Identyfikator wdrożenia modelu Usługi Azure OpenAI w wyznaczonym zasobie.
modelName	AzureOpenAIModelName	Nazwa modelu osadzania wdrożonego w podanej ścieżce deploymentId.
resourceUri	string (uri)	Identyfikator URI zasobu usługi Azure OpenAI.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info		Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

IndexedOneLakeKnowledgeSource

Objekt

Konfiguracja dla źródła wiedzy OneLake.

Nazwa	Typ	Opis
@odata.etag	string	ETag źródła wiedzy.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Parametry źródła wiedzy.
kind	string: indexedOneLake	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.

IndexedOneLakeKnowledgeSourceParameters

Objekt

Parametry źródła wiedzy OneLake.

Nazwa	Typ	Opis
createdResources	object	Zasoby utworzone przez źródło wiedzy.
fabricWorkspaceId	string	Identyfikator obszaru roboczego usługi OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Konsoliduje wszystkie ogólne ustawienia pozyskiwania.
lakehouseId	string	Określa, do którego lakehouse'u OneLake chcesz uzyskać dostęp.
targetPath	string	Opcjonalny folder lub skrót OneLakehouse do filtrowania zawartości OneLake.

IndexedSharePointContainerName

Wyliczenie

Określa, do których bibliotek programu SharePoint należy uzyskać dostęp.

Wartość	Opis
defaultSiteLibrary	Indeksowanie zawartości z domyślnej biblioteki dokumentów witryny.
allSiteLibraries	Indeksowanie zawartości z każdej biblioteki dokumentów w witrynie.
useQuery	Użyj zapytania, aby filtrować zawartość SharePoint.

IndexedSharePointKnowledgeSource

Objekt

Konfiguracja źródła wiedzy programu SharePoint.

Nazwa	Typ	Opis
@odata.etag	string	ETag źródła wiedzy.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Parametry źródła wiedzy.
kind	string: indexedSharePoint	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.

IndexedSharePointKnowledgeSourceParameters

Objekt

Parametry źródła wiedzy programu SharePoint.

Nazwa	Typ	Opis
connectionString	string	Parametry połączenia z programem SharePoint w formacie: SharePointOnlineEndpoint=[Adres URL witryny programu SharePoint]; ApplicationId=[Identyfikator aplikacji Azure AD]; ApplicationSecret=[Klucz tajny klienta aplikacji Azure AD]; TenantId=[Identyfikator dzierżawy witryny SharePoint]
containerName	IndexedSharePointContainerName	Określa, do których bibliotek programu SharePoint należy uzyskać dostęp.
createdResources	object	Zasoby utworzone przez źródło wiedzy.
ingestionParameters	KnowledgeSourceIngestionParameters	Konsoliduje wszystkie ogólne ustawienia pozyskiwania.
query	string	Opcjonalne zapytanie do filtrowania zawartości programu SharePoint.

IndexingSchedule

Objekt

Reprezentuje harmonogram wykonywania indeksatora.

Nazwa	Typ	Opis
interval	string (duration)	Interwał czasu między wykonaniami indeksatora.
startTime	string (date-time)	Czas, w którym indeksator powinien zacząć działać.

KnowledgeBaseAzureOpenAIModel

Objekt

Określa zasób usługi Azure OpenAI używany do planowania zapytań.

Nazwa	Typ	Opis
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI parametry.
kind	string: azureOpenAI	Model sztucznej inteligencji, który ma być używany do planowania zapytań.

KnowledgeBaseModelKind

Wyliczenie

Model sztucznej inteligencji, który ma być używany do planowania zapytań.

Wartość	Opis
azureOpenAI	Używanie modeli sztucznej inteligencji usługi Azure Open do planowania zapytań.

KnowledgeSourceAzureOpenAIVectorizer

Objekt

Określa zasób usługi Azure OpenAI używany do wektoryzacji ciągu zapytania.

Nazwa	Typ	Opis
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Zawiera parametry specyficzne dla wektoryzacji osadzania usługi Azure OpenAI.
kind	string: azureOpenAI	Nazwa rodzaju metody wektoryzacji konfigurowanej do użycia z wyszukiwaniem wektorowym.

KnowledgeSourceIngestionParameters

Objekt

Konsoliduje wszystkie ogólne ustawienia pozyskiwania dla źródeł wiedzy.

Nazwa	Typ	Domyślna wartość	Opis
aiServices	AIServices		Opcjonalna konfiguracja usług AI Services do przetwarzania zawartości.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Opcjonalny model uzupełniania czatu do werbalizacji obrazu lub wyodrębniania kontekstu.
contentExtractionMode	enum: minimal standard	minimal	Opcjonalny tryb wyodrębniania zawartości. Wartość domyślna to "minimalny".
disableImageVerbalization	boolean	False	Wskazuje, czy werbalizacja obrazu powinna być wyłączona. Wartość domyślna to „false”.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Opcjonalna konfiguracja wektoryzatora do wektoryzacji zawartości.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Jawna tożsamość do użycia dla tego źródła wiedzy.
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		Opcjonalna lista typów uprawnień do pozyskiwania wraz z zawartością dokumentu. Jeśli zostanie określony, ustawi opcje uprawnień indeksatora dla źródła danych.
ingestionSchedule	IndexingSchedule		Opcjonalny harmonogram pozyskiwania danych.

KnowledgeSourceIngestionPermissionOption

Wyliczenie

Rodzaje uprawnień do pobierania razem z treścią dokumentu.

Wartość	Opis
userIds	Pozyskiwanie jawnych identyfikatorów użytkowników wraz z zawartością dokumentu.
groupIds	Pozyskiwanie identyfikatorów grup wraz z zawartością dokumentu.
rbacScope	Pozyskiwanie informacji o zakresie RBAC wraz z zawartością dokumentu.

KnowledgeSourceKind

Wyliczenie

Rodzaj źródła wiedzy.

Wartość	Opis
searchIndex	Źródło wiedzy, które odczytuje dane z indeksu wyszukiwania.
azureBlob	Źródło wiedzy, które odczytuje i pozyskuje dane z Azure Blob Storage do indeksu wyszukiwania.
indexedSharePoint	Źródło wiedzy odczytujące dane z indeksowanego SharePoint.
indexedOneLake	Źródło wiedzy odczytujące dane z indeksowanego OneLake.
web	Źródło wiedzy, które odczytuje dane z internetu.
remoteSharePoint	Źródło wiedzy, które odczytuje dane ze zdalnego SharePoint.

RemoteSharePointKnowledgeSource

Objekt

Konfiguracja zdalnego źródła wiedzy programu SharePoint.

Nazwa	Typ	Opis
@odata.etag	string	ETag źródła wiedzy.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
kind	string: remoteSharePoint	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	Parametry zdalnego źródła wiedzy SharePoint.

RemoteSharePointKnowledgeSourceParameters

Objekt

Parametry zdalnego źródła wiedzy programu SharePoint.

Nazwa	Typ	Opis
containerTypeId	string	Identyfikator kontenera dla połączenia z systemem SharePoint Embedded. Jeśli ta wartość ma wartość null, będzie używać usługi SharePoint Online.
filterExpression	string	Wyrażenie języka KQL (Keyword Query Language) z właściwościami i atrybutami programu SharePoint z możliwością wykonywania zapytań w celu określenia zakresu pobierania przed uruchomieniem zapytania.
resourceMetadata	string[]	Lista pól metadanych, które mają zostać zwrócone dla każdego elementu w odpowiedzi. Na tej liście można uwzględnić tylko właściwości metadanych, które można pobrać. Domyślnie nie są zwracane żadne metadane.

SearchIndexerDataNoneIdentity

Objekt

Czyści właściwość tożsamości źródła danych.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identyfikatora URI określający typ tożsamości.

SearchIndexerDataUserAssignedIdentity

Objekt

Określa tożsamość źródła danych do użycia.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identyfikatora URI określający typ tożsamości.
userAssignedIdentity	string	W pełni kwalifikowany identyfikator zasobu platformy Azure tożsamości zarządzanej przypisanej przez użytkownika zwykle w postaci "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", który powinien zostać przypisany do usługi wyszukiwania.

SearchIndexFieldReference

Objekt

Referencja polowa dla indeksu wyszukiwania.

Nazwa	Typ	Opis
name	string	Nazwa pola.

SearchIndexKnowledgeSource

Objekt

Źródło wiedzy przeznaczone dla indeksu wyszukiwania.

Nazwa	Typ	Opis
@odata.etag	string	ETag źródła wiedzy.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
kind	string: searchIndex	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Parametry źródła wiedzy.

SearchIndexKnowledgeSourceParameters

Objekt

Parametry źródła wiedzy indeksu wyszukiwania.

Nazwa	Typ	Opis
searchFields	SearchIndexFieldReference[]	Służy do ograniczania pól do przeszukania w indeksie wyszukiwania.
searchIndexName	string	Nazwa indeksu wyszukiwania.
semanticConfigurationName	string	Służy do określania innej konfiguracji semantycznej w docelowym indeksie wyszukiwania innej niż domyślna.
sourceDataFields	SearchIndexFieldReference[]	Służy do żądania dodatkowych pól dla danych źródłowych, do których się odwołuje.

SearchResourceEncryptionKey

Objekt

Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.

Nazwa	Typ	Opis
accessCredentials.applicationId	string	Identyfikator aplikacji usługi AAD, któremu udzielono wymaganych uprawnień dostępu do usługi Azure Key Vault, która ma być używana podczas szyfrowania danych magazynowanych. Identyfikator aplikacji nie powinien być mylony z identyfikatorem obiektu aplikacji usługi AAD.
accessCredentials.applicationSecret	string	Klucz uwierzytelniania określonej aplikacji usługi AAD.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Jawna tożsamość zarządzana używana dla tego klucza szyfrowania. Jeśli nie zostanie określona, a właściwość poświadczeń dostępu ma wartość null, zostanie użyta tożsamość zarządzana przypisana przez system. Po zaktualizowaniu zasobu, jeśli tożsamość jawna jest nieokreślona, pozostaje niezmieniona. Jeśli określono wartość "none", wartość tej właściwości zostanie wyczyszczone.
keyVaultKeyName	string	Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych.
keyVaultKeyVersion	string	Wersja klucza usługi Azure Key Vault, która ma być używana do szyfrowania danych magazynowanych.
keyVaultUri	string	Identyfikator URI usługi Azure Key Vault, nazywany również nazwą DNS, który zawiera klucz używany do szyfrowania danych magazynowanych. Przykładowy identyfikator URI może być `https://my-keyvault-name.vault.azure.net`.

VectorSearchVectorizerKind

Wyliczenie

Metoda wektoryzacji, która ma być używana w czasie wykonywania zapytania.

Wartość	Opis
azureOpenAI	Generowanie osadzania przy użyciu zasobu usługi Azure OpenAI w czasie wykonywania zapytania.
customWebApi	Generowanie osadzania przy użyciu niestandardowego internetowego punktu końcowego w czasie wykonywania zapytań.
aiServicesVision	Generuj osadzanie dla obrazu lub tekstu wejściowego w czasie wykonywania zapytania przy użyciu interfejsu API przetwarzania obrazów usług Azure AI Services Vision Vectorize.
aml	Generowanie osadzania przy użyciu punktu końcowego usługi Azure Machine Learning wdrożonego za pośrednictwem wykazu modeli usługi Azure AI Foundry w czasie wykonywania zapytania.

WebKnowledgeSource

Objekt

Źródło wiedzy kierowane na wyniki w internecie.

Nazwa	Typ	Opis
@odata.etag	string	ETag źródła wiedzy.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r.
kind	string: web	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.
webParameters	WebKnowledgeSourceParameters	Parametry internetowego źródła wiedzy.

WebKnowledgeSourceDomain

Objekt

Konfiguracja domeny źródła wiedzy sieci Web.

Nazwa	Typ	Opis
address	string	Adres domeny.
includeSubpages	boolean	Czy uwzględnić podstrony z tej domeny, czy nie.

WebKnowledgeSourceDomains

Objekt

Konfiguracja zezwalania/blokowania domeny dla internetowego źródła wiedzy.

Nazwa	Typ	Opis
allowedDomains	WebKnowledgeSourceDomain[]	Domeny dozwolone dla wyników internetowych.
blockedDomains	WebKnowledgeSourceDomain[]	Domeny zablokowane w wynikach wyszukiwania w sieci.

WebKnowledgeSourceParameters

Objekt

Parametry źródła wiedzy internetowej.

Nazwa	Typ	Opis
domains	WebKnowledgeSourceDomains	Konfiguracja zezwalania/blokowania domeny dla wyników internetowych.