Knowledge Sources - Create
Új tudásforrást hoz létre.
POST {endpoint}/knowledgesources?api-version=2025-08-01-preview
URI-paraméterek
| Name | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
A keresési szolgáltatás végpontjának URL-címe. |
|
api-version
|
query | True |
string |
Ügyfél API verziója. |
Kérelem fejléce
| Name | Kötelező | Típus | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
A hibakeresési kérelemmel küldött nyomkövetési azonosító. |
Kérelem törzse
A kérelem törzse az alábbiak valamelyike lehet:
| Name | Description |
|---|---|
|
Azure |
Az Azure Blob Storage tudásforrás konfigurálása. |
|
Search |
Tudásforrás keresési indexet céloz meg. |
AzureBlobKnowledgeSource
Az Azure Blob Storage tudásforrás konfigurálása.
| Name | Kötelező | Típus | Description |
|---|---|---|---|
| azureBlobParameters | True |
A tudásforrás típusa. |
|
| kind | True |
string:
azure |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
Az ügynök ETag-je. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
A Azure Key Vault létrehozott titkosítási kulcs leírása. Ez a kulcs az inaktív adatok titkosításának további szintjét biztosítja az ügynökdefinícióhoz, ha teljes körű biztosítékot szeretne arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az ügynök definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatja, ha el szeretné forgatni a titkosítási kulcsot; Az ügynök definícióját ez nem érinti. Az ügyfél által felügyelt kulcsokkal való titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
SearchIndexKnowledgeSource
Tudásforrás keresési indexet céloz meg.
| Name | Kötelező | Típus | Description |
|---|---|---|---|
| kind | True |
string:
search |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| searchIndexParameters | True |
A tudásforrás paraméterei. |
|
| @odata.etag |
string |
Az ügynök ETag-je. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
A Azure Key Vault létrehozott titkosítási kulcs leírása. Ez a kulcs az inaktív adatok titkosításának további szintjét biztosítja az ügynökdefinícióhoz, ha teljes körű biztosítékot szeretne arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az ügynök definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatja, ha el szeretné forgatni a titkosítási kulcsot; Az ügynök definícióját ez nem érinti. Az ügyfél által felügyelt kulcsokkal való titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
Válaszok
| Name | Típus | Description |
|---|---|---|
| 201 Created | KnowledgeSource: |
Sikeresen létrehozott egy tudásforrást |
| Other Status Codes |
Hibaválasz. |
Példák
|
Search |
|
Search |
SearchServiceCreateKnowledgeSource
Mintakérelem
POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2025-08-01-preview
{
"searchIndexParameters": {
"searchIndexName": "preview-test",
"sourceDataSelect": "description,category"
},
"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>"
}
}
}
Mintaválasz
{
"@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",
"sourceDataSelect": "description,category"
}
}
SearchServiceCreateKnowledgeSourceAzureBlob
Mintakérelem
POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2025-08-01-preview
{
"azureBlobParameters": {
"identity": {
"userAssignedIdentity": "/my/userassigned/id",
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
},
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "test-container",
"folderPath": "test-path",
"embeddingModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
},
"name": "openai",
"kind": "azureOpenAI"
},
"chatCompletionModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
},
"kind": "azureOpenAI"
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"disableImageVerbalization": false
},
"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>"
}
}
}
Mintaválasz
{
"@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",
"disableImageVerbalization": false,
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"name": "openai",
"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"
}
}
}
Definíciók
| Name | Description |
|---|---|
|
AIFoundry |
A meghívni kívánt Azure AI Foundry katalógus beágyazási modelljének neve. |
|
AIServices |
Megadja a lekérdezési kép vagy szöveg vektorizálásához szükséges AI Services Vision paramétereket. |
|
AIServices |
Megadja a lekérdezési kép vagy szöveg vektorizálásához szükséges AI Services Vision paramétereket. |
| AMLParameters |
Megadja az AML-vektorizálóhoz való csatlakozás tulajdonságait. |
| AMLVectorizer |
Megad egy Azure Machine Learning végpontot, amely az Azure AI Foundry modellkatalógusán keresztül van üzembe helyezve egy lekérdezési sztring vektorbeágyazásának létrehozásához. |
|
Azure |
A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyek a Azure Key Vault tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használatosak. |
|
Azure |
Az Azure Blob Storage tudásforrás konfigurálása. |
|
Azure |
Az Azure Blob Storage tudásforrás paraméterei. |
|
Azure |
Lehetővé teszi vektoros beágyazás létrehozását egy adott szövegbevitelhez az Azure OpenAI-erőforrás használatával. |
|
Azure |
A meghívott Azure Open AI-modell neve. |
|
Azure |
Megadja az Azure OpenAI-erőforráshoz való csatlakozás paramétereit. |
|
Azure |
Megadja a lekérdezési sztring vektorizálásához használt Azure OpenAI-erőforrást. |
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
Hibaválasz |
|
Indexing |
Az indexelő végrehajtásának ütemezését jelöli. |
|
Input |
Képesség beviteli mezőjének leképezése. |
|
Knowledge |
Megadja a lekérdezések tervezéséhez használt Azure OpenAI-erőforrást. |
|
Knowledge |
A lekérdezések tervezéséhez használt AI-modell. |
|
Knowledge |
A tudásforrás fajtája. |
|
Output |
Képesség kimeneti mezőleképezése. |
|
Search |
Törli egy adatforrás identity tulajdonságát. |
|
Search |
Megadja a használni kívánt adatforrás identitását. |
|
Search |
Tudásforrás keresési indexet céloz meg. |
|
Search |
A keresési index tudásforrásának paraméterei. |
|
Search |
Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók. |
|
Vector |
A lekérdezés során használandó vektorizálási módszer. |
|
Web |
Megadja a felhasználó által definiált vektorizálóhoz való csatlakozás tulajdonságait. |
|
Web |
Megad egy felhasználó által definiált vektorizálót a lekérdezési karakterlánc vektorbeágyazásának létrehozásához. A külső vektorizáló integrálása egy képességkészlet egyéni webes API-felületével érhető el. |
AIFoundryModelCatalogName
A meghívni kívánt Azure AI Foundry katalógus beágyazási modelljének neve.
| Érték | Description |
|---|---|
| OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32 | |
| OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336 | |
| Facebook-DinoV2-Image-Embeddings-ViT-Base | |
| Facebook-DinoV2-Image-Embeddings-ViT-Giant | |
| Cohere-embed-v3-english | |
| Cohere-embed-v3-multilingual | |
| Cohere-embed-v4 |
Cohere beágyazott v4 modell szövegből és képekből történő beágyazáshoz. |
AIServicesVisionParameters
Megadja a lekérdezési kép vagy szöveg vektorizálásához szükséges AI Services Vision paramétereket.
| Name | Típus | Description |
|---|---|---|
| apiKey |
string |
A kijelölt AI Services-erőforrás API-kulcsa. |
| authIdentity | SearchIndexerDataIdentity: |
A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás. Ha meg van adva egy authResourceId, és nincs megadva, a rendszer által hozzárendelt felügyelt identitást használja. Az index frissítésekor, ha az identitás nincs megadva, az érték változatlan marad. Ha a "none" értékre van állítva, a tulajdonság értéke törlődik. |
| modelVersion |
string |
A modell AI Services Vision szolgáltatás hívásakor használandó verziója. Alapértelmezés szerint a legújabb elérhető lesz, ha nincs megadva. |
| resourceUri |
string (uri) |
Az AI Services erőforrás URI-ja. |
AIServicesVisionVectorizer
Megadja a lekérdezési kép vagy szöveg vektorizálásához szükséges AI Services Vision paramétereket.
| Name | Típus | Description |
|---|---|---|
| aiServicesVisionParameters |
Az AI Services Vision beágyazott vektorizálására jellemző paramétereket tartalmazza. |
|
| kind |
string:
ai |
A vektoros kereséshez konfigurált vektorizálási módszer neve. |
| name |
string |
Az adott vektorizálási módszerhez társítandó név. |
AMLParameters
Megadja az AML-vektorizálóhoz való csatlakozás tulajdonságait.
| Name | Típus | Description |
|---|---|---|
| key |
string |
(A kulcshitelesítéshez szükséges) Az AML szolgáltatás kulcsa. |
| modelName |
A megadott végponton üzembe helyezett Azure AI Foundry Catalog beágyazási modelljének neve. |
|
| region |
string |
(Jogkivonat-hitelesítéshez nem kötelező). Az a régió, amelyben az AML-szolgáltatás üzembe van helyezve. |
| resourceId |
string |
(A jogkivonat-hitelesítéshez szükséges). Az AML-szolgáltatás Azure Resource Manager erőforrás-azonosítója. A formátumnak a következőnek kell lennie: subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. |
| timeout |
string (duration) |
(Nem kötelező) Ha meg van adva, az API-hívást végző http-ügyfél időtúllépését jelzi. |
| uri |
string (uri) |
(Hitelesítés vagy kulcsos hitelesítés hiányához szükséges) Annak az AML-szolgáltatásnak a pontozási URI-ja, amelybe a JSON-adattartalmat el fogja küldeni. Csak a https URI-séma engedélyezett. |
AMLVectorizer
Megad egy Azure Machine Learning végpontot, amely az Azure AI Foundry modellkatalógusán keresztül van üzembe helyezve egy lekérdezési sztring vektorbeágyazásának létrehozásához.
| Name | Típus | Description |
|---|---|---|
| amlParameters |
Megadja az AML vektorizáló tulajdonságait. |
|
| kind |
string:
aml |
A vektoros kereséshez konfigurált vektorizálási módszer neve. |
| name |
string |
Az adott vektorizálási módszerhez társítandó név. |
AzureActiveDirectoryApplicationCredentials
A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyek a Azure Key Vault tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használatosak.
| Name | Típus | Description |
|---|---|---|
| applicationId |
string |
Egy AAD-alkalmazásazonosító, amely megkapta a szükséges hozzáférési engedélyeket az Azure Key Vaulthoz, amelyet az inaktív adatok titkosításához kell használni. Az alkalmazásazonosító nem tévesztendő össze az AAD-alkalmazás objektumazonosítójával. |
| applicationSecret |
string |
A megadott AAD-alkalmazás hitelesítési kulcsa. |
AzureBlobKnowledgeSource
Az Azure Blob Storage tudásforrás konfigurálása.
| Name | Típus | Description |
|---|---|---|
| @odata.etag |
string |
Az ügynök ETag-je. |
| azureBlobParameters |
A tudásforrás típusa. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
A Azure Key Vault létrehozott titkosítási kulcs leírása. Ez a kulcs az inaktív adatok titkosításának további szintjét biztosítja az ügynökdefinícióhoz, ha teljes körű biztosítékot szeretne arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az ügynök definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatja, ha el szeretné forgatni a titkosítási kulcsot; Az ügynök definícióját ez nem érinti. Az ügyfél által felügyelt kulcsokkal való titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
azure |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
AzureBlobKnowledgeSourceParameters
Az Azure Blob Storage tudásforrás paraméterei.
| Name | Típus | Description |
|---|---|---|
| chatCompletionModel | KnowledgeAgentModel: |
Opcionális csevegési befejezési modell a kép verbalizálásához vagy a kontextus kinyeréséhez. |
| connectionString |
string |
Kulcsalapú kapcsolati sztring vagy a ResourceId formátum, ha felügyelt identitást használ. |
| containerName |
string |
A blob Storage-tároló neve. |
| createdResources |
object |
A tudásforrás által létrehozott erőforrások. |
| disableImageVerbalization |
boolean |
Azt jelzi, hogy a kép verbalizálását le kell-e tiltani. |
| embeddingModel | VectorSearchVectorizer: |
Opcionális vektorizáló konfiguráció a tartalom vektorizálásához. |
| folderPath |
string |
Nem kötelező mappa elérési útja a tárolón belül. |
| identity | SearchIndexerDataIdentity: |
A tudásforráshoz használandó explicit identitás. |
| ingestionSchedule |
Az adatbetöltés nem kötelező ütemezése. |
AzureOpenAIEmbeddingSkill
Lehetővé teszi vektoros beágyazás létrehozását egy adott szövegbevitelhez az Azure OpenAI-erőforrás használatával.
| Name | Típus | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
A képesség típusát meghatározó URI-töredék. |
| apiKey |
string |
A kijelölt Azure OpenAI-erőforrás API-kulcsa. |
| authIdentity | SearchIndexerDataIdentity: |
A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás. |
| context |
string |
A műveletek szintjét jelöli, például a dokumentum gyökerét vagy tartalmát (például /document vagy /document/content). Az alapértelmezett érték a /document. |
| deploymentId |
string |
Az Azure OpenAI-modell üzembe helyezésének azonosítója a kijelölt erőforráson. |
| description |
string |
A készség leírása, amely leírja a képesség bemeneteit, kimeneteit és használatát. |
| dimensions |
integer (int32) |
Az eredményként kapott kimeneti beágyazások dimenzióinak száma. Csak a text-embedding-3 és újabb modellekben támogatott. |
| inputs |
A képességek bemenetei lehetnek a forrásadatkészlet oszlopai vagy egy felsőbb rétegbeli képesség kimenete. |
|
| modelName |
A megadott deploymentId elérési úton üzembe helyezett beágyazási modell neve. |
|
| name |
string |
Annak a képességnek a neve, amely egyedileg azonosítja azt a képességkészleten belül. A név nélküli képességek alapértelmezett nevet kapnak az 1-alapú indexhez a képességtömbben, a "#" karakter előtaggal. |
| outputs |
A képesség kimenete vagy egy keresési index mezője, vagy egy másik képesség által bemenetként felhasznált érték. |
|
| resourceUri |
string (uri) |
Az Azure OpenAI-erőforrás erőforrás-URI-ja. |
AzureOpenAIModelName
A meghívott Azure Open AI-modell neve.
| Érték | Description |
|---|---|
| text-embedding-ada-002 | |
| text-embedding-3-large | |
| text-embedding-3-small | |
| gpt-4o | |
| gpt-4o-mini | |
| gpt-4.1 | |
| gpt-4.1-mini | |
| gpt-4.1-nano |
AzureOpenAIParameters
Megadja az Azure OpenAI-erőforráshoz való csatlakozás paramétereit.
| Name | Típus | Description |
|---|---|---|
| apiKey |
string |
A kijelölt Azure OpenAI-erőforrás API-kulcsa. |
| authIdentity | SearchIndexerDataIdentity: |
A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás. |
| deploymentId |
string |
Az Azure OpenAI-modell üzembe helyezésének azonosítója a kijelölt erőforráson. |
| modelName |
A megadott deploymentId elérési úton üzembe helyezett beágyazási modell neve. |
|
| resourceUri |
string (uri) |
Az Azure OpenAI-erőforrás erőforrás-URI-ja. |
AzureOpenAIVectorizer
Megadja a lekérdezési sztring vektorizálásához használt Azure OpenAI-erőforrást.
| Name | Típus | Description |
|---|---|---|
| azureOpenAIParameters | AzureOpenAIParameters: |
Az Azure OpenAI beágyazott vektorizálásra jellemző paramétereket tartalmazza. |
| kind |
string:
azure |
A vektoros kereséshez konfigurált vektorizálási módszer neve. |
| name |
string |
Az adott vektorizálási módszerhez társítandó név. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Name | Típus | Description |
|---|---|---|
| info |
object |
A további információk. |
| type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
| Name | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
| Name | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |
IndexingSchedule
Az indexelő végrehajtásának ütemezését jelöli.
| Name | Típus | Description |
|---|---|---|
| interval |
string (duration) |
Az indexelő végrehajtásai közötti időintervallum. |
| startTime |
string (date-time) |
Az az időpont, amikor az indexelő elindul. |
InputFieldMappingEntry
Képesség beviteli mezőjének leképezése.
| Name | Típus | Description |
|---|---|---|
| inputs |
A komplex típus létrehozásakor használt rekurzív bemenetek. |
|
| name |
string |
A bemenet neve. |
| source |
string |
A bemenet forrása. |
| sourceContext |
string |
A rekurzív bemenetek kiválasztásához használt forráskörnyezet. |
KnowledgeAgentAzureOpenAIModel
Megadja a lekérdezések tervezéséhez használt Azure OpenAI-erőforrást.
| Name | Típus | Description |
|---|---|---|
| azureOpenAIParameters | AzureOpenAIParameters: |
Az Azure OpenAI-modell végpontjára jellemző paramétereket tartalmazza. |
| kind |
string:
azure |
Az AI-modell típusa. |
KnowledgeAgentModelKind
A lekérdezések tervezéséhez használt AI-modell.
| Érték | Description |
|---|---|
| azureOpenAI |
Lekérdezéstervezéshez használja az Azure Open AI-modelleket. |
KnowledgeSourceKind
A tudásforrás fajtája.
| Érték | Description |
|---|---|
| searchIndex |
Olyan tudásforrás, amely adatokat olvas be egy keresési indexből. |
| azureBlob |
Olyan tudásforrás, amely adatokat olvas és tölt be az Azure Blob Storage-ból egy keresési indexbe. |
OutputFieldMappingEntry
Képesség kimeneti mezőleképezése.
| Name | Típus | Description |
|---|---|---|
| name |
string |
A képesség által meghatározott kimenet neve. |
| targetName |
string |
A kimenet célneve. Ez nem kötelező, és alapértelmezés szerint a név. |
SearchIndexerDataNoneIdentity
Törli egy adatforrás identity tulajdonságát.
| Name | Típus | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Az identitás típusát meghatározó URI-töredék. |
SearchIndexerDataUserAssignedIdentity
Megadja a használni kívánt adatforrás identitását.
| Name | Típus | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Az identitás típusát meghatározó URI-töredék. |
| userAssignedIdentity |
string |
A felhasználó által hozzárendelt felügyelt identitás teljes Azure-erőforrás-azonosítója, általában a következő formátumban: "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", amelyet hozzá kellett volna rendelni a keresési szolgáltatáshoz. |
SearchIndexKnowledgeSource
Tudásforrás keresési indexet céloz meg.
| Name | Típus | Description |
|---|---|---|
| @odata.etag |
string |
Az ügynök ETag-je. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
A Azure Key Vault létrehozott titkosítási kulcs leírása. Ez a kulcs az inaktív adatok titkosításának további szintjét biztosítja az ügynökdefinícióhoz, ha teljes körű biztosítékot szeretne arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az ügynök definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatja, ha el szeretné forgatni a titkosítási kulcsot; Az ügynök definícióját ez nem érinti. Az ügyfél által felügyelt kulcsokkal való titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
search |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| searchIndexParameters |
A tudásforrás paraméterei. |
SearchIndexKnowledgeSourceParameters
A keresési index tudásforrásának paraméterei.
| Name | Típus | Description |
|---|---|---|
| searchIndexName |
string |
A keresési index neve. |
| sourceDataSelect |
string |
A hivatkozott forrásadatok további mezőinek kérésére szolgál. |
SearchResourceEncryptionKey
Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók.
| Name | Típus | Description |
|---|---|---|
| accessCredentials |
A Azure Key Vault eléréséhez használt opcionális Azure Active Directory hitelesítő adatok. Nem szükséges, ha felügyelt identitást használ. |
|
| identity | SearchIndexerDataIdentity: |
A titkosítási kulcshoz használandó explicit felügyelt identitás. Ha nincs megadva, és a hozzáférési hitelesítő adatok tulajdonsága null, a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Az erőforrás frissítésekor, ha az explicit identitás nincs megadva, az változatlan marad. Ha a "nincs" van megadva, a tulajdonság értéke törlődik. |
| keyVaultKeyName |
string |
Az inaktív adatok titkosításához használt Azure Key Vault kulcs neve. |
| keyVaultKeyVersion |
string |
Az Azure Key Vault kulcs verziója, amely az inaktív adatok titkosításához használható. |
| keyVaultUri |
string |
Az Azure Key Vault URI-ja, más néven DNS-név, amely tartalmazza az inaktív adatok titkosításához használt kulcsot. Példa lehet az URI-ra |
VectorSearchVectorizerKind
A lekérdezés során használandó vektorizálási módszer.
| Érték | Description |
|---|---|
| azureOpenAI |
Beágyazások létrehozása egy Azure OpenAI-erőforrással a lekérdezéskor. |
| customWebApi |
Beágyazások létrehozása egyéni webes végponttal a lekérdezéskor. |
| aiServicesVision |
Beágyazásokat hozhat létre egy képhez vagy szövegbevitelhez a lekérdezéskor az Azure AI Services Vision Vectorize API használatával. |
| aml |
Beágyazásokat hozhat létre egy Azure Machine Learning végponttal, amely a lekérdezéskor az Azure AI Foundry modellkatalógusán keresztül van üzembe helyezve. |
WebApiParameters
Megadja a felhasználó által definiált vektorizálóhoz való csatlakozás tulajdonságait.
| Name | Típus | Description |
|---|---|---|
| authIdentity | SearchIndexerDataIdentity: |
A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás. Ha meg van adva egy authResourceId, és nincs megadva, a rendszer által hozzárendelt felügyelt identitást használja. Az indexelő frissítésekor, ha az identitás nincs megadva, az érték változatlan marad. Ha a "none" értékre van állítva, a tulajdonság értéke törlődik. |
| authResourceId |
string |
Olyan egyéni végpontokra vonatkozik, amelyek egy Azure-függvény vagy más alkalmazásban csatlakoznak külső kódhoz, amely biztosítja az átalakításokat. Ennek az értéknek a függvényhez vagy alkalmazáshoz létrehozott alkalmazásazonosítónak kell lennie, amikor regisztrálva lett a Azure Active Directory. Ha meg van adva, a vektorizálás a keresési szolgáltatás felügyelt azonosítójával (rendszer vagy felhasználó által hozzárendelt) és a függvény vagy alkalmazás hozzáférési jogkivonatával csatlakozik a függvényhez vagy alkalmazáshoz, és ezt az értéket használja erőforrás-azonosítóként a hozzáférési jogkivonat hatókörének létrehozásához. |
| httpHeaders |
object |
A HTTP-kérés végrehajtásához szükséges fejlécek. |
| httpMethod |
string |
A HTTP-kérés metódusa. |
| timeout |
string (duration) |
A kérés kívánt időtúllépése. Az alapértelmezett érték 30 másodperc. |
| uri |
string (uri) |
A vektorizálót biztosító webes API URI-ja. |
WebApiVectorizer
Megad egy felhasználó által definiált vektorizálót a lekérdezési karakterlánc vektorbeágyazásának létrehozásához. A külső vektorizáló integrálása egy képességkészlet egyéni webes API-felületével érhető el.
| Name | Típus | Description |
|---|---|---|
| customWebApiParameters |
Megadja a felhasználó által definiált vektorizáló tulajdonságait. |
|
| kind |
string:
custom |
A vektoros kereséshez konfigurált vektorizálási módszer neve. |
| name |
string |
Az adott vektorizálási módszerhez társítandó név. |