Knowledge Sources - Get

Mengambil definisi sumber pengetahuan.

GET {endpoint}/knowledgesources('{sourceName}')?api-version=2026-05-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 akan digunakan untuk operasi ini.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
Accept

Accept

Header Terima.

x-ms-client-request-id

string (uuid)

Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Respons

Nama Jenis Deskripsi
200 OK KnowledgeSource:

Permintaan telah berhasil.

Other Status Codes

ErrorResponse

Respons kesalahan yang tidak 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

SearchServiceGetKnowledgeSource
SearchServiceGetKnowledgeSourceAzureBlob
SearchServiceGetKnowledgeSourceFabricDataAgent
SearchServiceGetKnowledgeSourceFabricOntology
SearchServiceGetKnowledgeSourceIndexedOneLake
SearchServiceGetKnowledgeSourceIndexedSharePoint
SearchServiceGetKnowledgeSourceMcpServer
SearchServiceGetKnowledgeSourceWeb
SearchServiceGetKnowledgeSourceWorkIQ

SearchServiceGetKnowledgeSource

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@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": "*"
      }
    ]
  }
}

SearchServiceGetKnowledgeSourceAzureBlob

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@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": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceFabricDataAgent

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-fabric-agent-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabric-agent-test",
  "kind": "fabricDataAgent",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  }
}

SearchServiceGetKnowledgeSourceFabricOntology

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-fabricontology-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabricontology-test",
  "kind": "fabricOntology",
  "description": "Description of the Fabric Ontology knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  }
}

SearchServiceGetKnowledgeSourceIndexedOneLake

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@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": "<redacted>",
    "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": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceIndexedSharePoint

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@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": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceMcpServer

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "mcpServer",
  "description": "Description of the MCP server knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "inclusionMode": "reranked",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceGetKnowledgeSourceWeb

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@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
        }
      ]
    }
  }
}

SearchServiceGetKnowledgeSourceWorkIQ

Permintaan sampel

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-workiq-test')?api-version=2026-05-01-preview

Respon sampel

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-workiq-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definisi

Nama Deskripsi
Accept

Header Terima.

AIServices

Parameter untuk Layanan AI.

AssetStore

Konfigurasi untuk penyimpanan aset yang digunakan untuk menyimpan aset yang diekstrak seperti gambar.

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.

ContentColumnMapping

Memetakan kolom SQL ke bidang indeks pencarian.

EmbeddingColumnMapping

Memetakan kolom SQL ke bidang vektor untuk disematkan.

ErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan 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.).

FabricDataAgentKnowledgeSource

Konfigurasi untuk sumber pengetahuan Fabric Data Agent.

FabricDataAgentKnowledgeSourceParameters

Parameter untuk sumber pengetahuan Fabric Data Agent.

FabricOntologyKnowledgeSource

Konfigurasi untuk sumber pengetahuan Fabric Ontology.

FabricOntologyKnowledgeSourceParameters

Parameter untuk sumber pengetahuan Fabric Ontology.

FileKnowledgeSource

Konfigurasi untuk sumber pengetahuan File yang mendukung pengunggahan dan pengindeksan file langsung.

FileKnowledgeSourceParameters

Parameter untuk sumber pengetahuan file.

FreshnessPolicy

Konfigurasi untuk pengambilan sadar kesegaran. Saat ditetapkan, dokumen yang lebih baru menerima peningkatan peringkat selama pengambilan.

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.

IndexedSqlKnowledgeSource

Konfigurasi untuk sumber pengetahuan SQL yang diindeks.

IndexedSqlKnowledgeSourceParameters

Parameter untuk sumber pengetahuan SQL yang diindeks.

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.

McpServerAuthenticationKind

Jenis autentikasi untuk server MCP.

McpServerAutoOutputParsing

Secara otomatis mendeteksi format output dan mengurai yang sesuai.

McpServerFoundryConnectionAuthentication

Autentikasi menggunakan koneksi Azure AI Foundry.

McpServerFoundryConnectionParameters

Parameter untuk autentikasi koneksi Foundry.

McpServerJsonOutputParsing

Mengurai output sebagai dokumen JSON menggunakan parameter JSON yang dikonfigurasi.

McpServerKnowledgeSource

Konfigurasi untuk sumber pengetahuan yang didukung oleh server MCP (Model Context Protocol).

McpServerKnowledgeSourceParameters

Parameter untuk sumber pengetahuan server MCP.

McpServerNoneOutputParsing

Perlakukan output sebagai satu blok tanpa penguraian apa pun.

McpServerOutputParsingJsonParameters

Parameter untuk penguraian output JSON.

McpServerOutputParsingKind

Jenis penguraian output untuk alat server MCP.

McpServerOutputParsingSplitParameters

Parameter untuk penguraian output terpisah.

McpServerSplitOutputParsing

Pisahkan output menjadi beberapa halaman menggunakan parameter pemisahan yang dikonfigurasi.

McpServerStoredHeadersAuthentication

Autentikasi menggunakan header HTTP yang disimpan.

McpServerStoredHeadersParameters

Parameter untuk autentikasi header yang disimpan.

McpServerTool

Mewakili satu alat dalam sumber pengetahuan server MCP.

McpServerToolInclusionMode

Mengontrol bagaimana hasil alat MCP yang diurai diintegrasikan ke dalam kumpulan hasil akhir.

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.

SplitSkillLanguage

Kode bahasa yang didukung untuk teks input oleh SplitSkill.

TextSplitMode

Nilai yang menunjukkan mode pemisahan mana yang akan dilakukan.

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.

WorkIQKnowledgeSource

Konfigurasi untuk sumber pengetahuan WorkIQ.

Accept

Header Terima.

Nilai Deskripsi
application/json;odata.metadata=minimal

AIServices

Parameter untuk Layanan AI.

Nama Jenis Deskripsi
apiKey

string

Kunci API untuk mengakses Layanan AI.

uri

string (uri)

URI titik akhir Layanan AI.

AssetStore

Konfigurasi untuk penyimpanan aset yang digunakan untuk menyimpan aset yang diekstrak seperti gambar.

Nama Jenis Deskripsi
connectionString

string

string koneksi untuk penyimpanan aset.

containerName

string

Nama kontainer blob dalam penyimpanan aset tempat aset yang diekstrak (misalnya, gambar) disimpan.

AzureBlobKnowledgeSource

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

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

Nama model Azure Open AI yang akan dipanggil.

Nilai Deskripsi
text-embedding-ada-002

TextEmbeddingModel Ada002.

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.

gpt-5.1

Model Gpt51.

gpt-5.2

Model Gpt52.

gpt-5.4

Model Gpt54.

gpt-5.4-mini

Model Gpt54Mini.

gpt-5.4-nano

Model Gpt54Nano.

gpt-5.5

Model GPT55.

AzureOpenAIVectorizerParameters

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:

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.

ContentColumnMapping

Memetakan kolom SQL ke bidang indeks pencarian.

Nama Jenis Deskripsi
name

string

Nama bidang indeks target.

searchFieldType

string

Jenis bidang Pencarian Azure AI (misalnya, Edm.String, Edm.Int32).

sourceField

string

Nama kolom SQL.

EmbeddingColumnMapping

Memetakan kolom SQL ke bidang vektor untuk disematkan.

Nama Jenis Deskripsi
name

string

Nama bidang vektor target dalam indeks pencarian.

sourceField

string

Kolom SQL digunakan sebagai input untuk pembuatan penyematan.

ErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

Nama Jenis Deskripsi
info

Info tambahan.

type

string

Jenis informasi tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Informasi tambahan tentang kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Rincian kesalahan.

message

string

Pesan kesalahan.

target

string

Sasaran 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.).

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

FabricDataAgentKnowledgeSource

Konfigurasi untuk sumber pengetahuan Fabric Data Agent.

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.

fabricDataAgentParameters

FabricDataAgentKnowledgeSourceParameters

Parameter untuk sumber pengetahuan Fabric Data Agent.

kind string:

fabricDataAgent

Jenis sumber pengetahuan.

name

string

Nama sumber pengetahuan.

FabricDataAgentKnowledgeSourceParameters

Parameter untuk sumber pengetahuan Fabric Data Agent.

Nama Jenis Deskripsi
dataAgentId

string

Menentukan Agen Data Fabric mana yang akan diakses.

workspaceId

string

ID ruang kerja Fabric.

FabricOntologyKnowledgeSource

Konfigurasi untuk sumber pengetahuan Fabric Ontology.

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.

fabricOntologyParameters

FabricOntologyKnowledgeSourceParameters

Parameter untuk sumber pengetahuan Fabric Ontology.

kind string:

fabricOntology

Jenis sumber pengetahuan.

name

string

Nama sumber pengetahuan.

FabricOntologyKnowledgeSourceParameters

Parameter untuk sumber pengetahuan Fabric Ontology.

Nama Jenis Deskripsi
ontologyId

string

ID ontologi yang akan digunakan dari ruang kerja Fabric.

workspaceId

string

ID ruang kerja Fabric yang berisi ontologi.

FileKnowledgeSource

Konfigurasi untuk sumber pengetahuan File yang mendukung pengunggahan dan pengindeksan file langsung.

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.

fileParameters

FileKnowledgeSourceParameters

Parameter untuk sumber pengetahuan File.

kind string:

file

Jenis sumber pengetahuan.

name

string

Nama sumber pengetahuan.

FileKnowledgeSourceParameters

Parameter untuk sumber pengetahuan file.

Nama Jenis Deskripsi
createdResources

object

Sumber daya yang dibuat oleh sumber pengetahuan file.

ingestionParameters

KnowledgeSourceIngestionParameters

Mengonsolidasikan semua pengaturan umum untuk sumber pengetahuan File, termasuk mode ekstraksi konten dan embeddingModel opsional.

FreshnessPolicy

Konfigurasi untuk pengambilan sadar kesegaran. Saat ditetapkan, dokumen yang lebih baru menerima peningkatan peringkat selama pengambilan.

Nama Jenis Deskripsi
boostingDuration

string

Durasi ISO 8601 untuk jendela peningkatan kesegaran (misalnya 'P90D' selama 90 hari). Dokumen yang lebih baru dari durasi ini menerima peningkatan peringkat selama pengambilan.

IndexedOneLakeKnowledgeSource

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

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

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

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

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.

IndexedSqlKnowledgeSource

Konfigurasi untuk sumber pengetahuan SQL yang diindeks.

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.

indexedSqlParameters

IndexedSqlKnowledgeSourceParameters

Parameter untuk sumber pengetahuan SQL.

kind string:

indexedSql

Jenis sumber pengetahuan.

name

string

Nama sumber pengetahuan.

IndexedSqlKnowledgeSourceParameters

Parameter untuk sumber pengetahuan SQL yang diindeks.

Nama Jenis Deskripsi
connectionString

string

string koneksi untuk Azure SQL Database atau SQL Managed Instance.

contentColumns

ContentColumnMapping[]

Pemetaan kolom opsional untuk bidang konten. Jika dihilangkan, semua kolom akan ditemukan secara otomatis.

createdResources

object

Sumber daya yang dibuat oleh sumber pengetahuan.

embeddingColumns

EmbeddingColumnMapping[]

Pemetaan kolom opsional untuk menyematkan bidang vektor. Jika dihilangkan, tidak ada bidang vektor yang dibuat.

highWaterMarkColumnName

string

Nama kolom opsional untuk deteksi perubahan tanda air tinggi. Jika disediakan, gunakan HighWaterMarkChangeDetectionPolicy.

ingestionParameters

KnowledgeSourceIngestionParameters

Mengkonsolidasikan semua pengaturan penyerapan umum termasuk model penyematan, jadwal, dan identitas.

tableOrView

string

Nama tabel atau tampilan yang akan diindeks. Dapat memenuhi syarat skema (misalnya, 'dbo. Meja-Saya').

IndexingSchedule

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

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

Model AI yang akan digunakan untuk perencanaan kueri.

Nilai Deskripsi
azureOpenAI

Gunakan model Azure Open AI untuk perencanaan kueri.

KnowledgeSourceAzureOpenAIVectorizer

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

Mengkonsolidasikan semua pengaturan penyerapan umum untuk sumber pengetahuan.

Nama Jenis Nilai default Deskripsi
aiServices

AIServices

Konfigurasi Layanan AI opsional untuk pemrosesan konten.

assetStore

AssetStore

Konfigurasi penyimpanan aset opsional untuk menyimpan aset yang diekstrak seperti gambar.

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.

freshnessPolicy

FreshnessPolicy

Kebijakan kesegaran opsional untuk pengambilan bias terhadap dokumen yang lebih baru.

identity SearchIndexerDataIdentity:

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

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.

sensitivityLabels

Menyerap label sensitivitas Microsoft Purview bersama konten dokumen.

KnowledgeSourceKind

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.

indexedSql

Sumber pengetahuan yang mengambil dan menyerap data dari Azure SQL Database atau SQL Managed Instance ke Indeks Pencarian.

web

Sumber pengetahuan yang membaca data dari web.

remoteSharePoint

Sumber pengetahuan yang membaca data dari SharePoint jarak jauh.

workIQ

Sumber pengetahuan yang membaca data dari IQ kerja

file

Sumber pengetahuan yang mendukung pengunggahan dan pengindeksan file langsung.

mcpServer

Sumber pengetahuan yang didukung oleh server MCP (Model Context Protocol).

fabricDataAgent

Sumber pengetahuan yang mengambil data dari Agen Data Fabric.

fabricOntology

Sumber pengetahuan yang mengambil data dari ontologi Microsoft Fabric Ontology.

McpServerAuthenticationKind

Jenis autentikasi untuk server MCP.

Nilai Deskripsi
foundryConnection

Autentikasi menggunakan koneksi Azure AI Foundry.

storedHeaders

Autentikasi menggunakan header HTTP yang disimpan.

McpServerAutoOutputParsing

Secara otomatis mendeteksi format output dan mengurai yang sesuai.

Nama Jenis Deskripsi
kind string:

auto

Jenis penguraian output yang akan diterapkan.

McpServerFoundryConnectionAuthentication

Autentikasi menggunakan koneksi Azure AI Foundry.

Nama Jenis Deskripsi
foundryConnectionParameters

McpServerFoundryConnectionParameters

Parameter untuk autentikasi koneksi Foundry.

kind string:

foundryConnection

Jenis otentikasi yang akan digunakan.

McpServerFoundryConnectionParameters

Parameter untuk autentikasi koneksi Foundry.

Nama Jenis Deskripsi
connectionId

string

Pengidentifikasi koneksi Azure AI Foundry.

McpServerJsonOutputParsing

Mengurai output sebagai dokumen JSON menggunakan parameter JSON yang dikonfigurasi.

Nama Jenis Deskripsi
jsonParameters

McpServerOutputParsingJsonParameters

Parameter untuk penguraian output JSON. Diperlukan ketika jenis adalah 'json'.

kind string:

json

Jenis penguraian output yang akan diterapkan.

McpServerKnowledgeSource

Konfigurasi untuk sumber pengetahuan yang didukung oleh server MCP (Model Context Protocol).

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:

mcpServer

Jenis sumber pengetahuan.

mcpServerParameters

McpServerKnowledgeSourceParameters

Parameter untuk sumber pengetahuan server MCP.

name

string

Nama sumber pengetahuan.

McpServerKnowledgeSourceParameters

Parameter untuk sumber pengetahuan server MCP.

Nama Jenis Deskripsi
authentication McpServerAuthentication:

Konfigurasi autentikasi untuk server MCP.

serverURL

string

URL titik akhir server MCP.

tools

McpServerTool[]

Daftar alat untuk dipanggil di server MCP.

McpServerNoneOutputParsing

Perlakukan output sebagai satu blok tanpa penguraian apa pun.

Nama Jenis Deskripsi
kind string:

none

Jenis penguraian output yang akan diterapkan.

McpServerOutputParsingJsonParameters

Parameter untuk penguraian output JSON.

Nama Jenis Deskripsi
documentsPath

string

Jalur JSON ke array dokumen dalam output alat.

includeContext

boolean

Apakah akan menyertakan konteks sekitar dari output JSON bersama dokumen yang diekstrak.

McpServerOutputParsingKind

Jenis penguraian output untuk alat server MCP.

Nilai Deskripsi
auto

Secara otomatis mendeteksi format output dan mengurai yang sesuai.

json

Mengurai output sebagai dokumen JSON menggunakan parameter JSON yang dikonfigurasi.

split

Pisahkan output menjadi beberapa halaman menggunakan parameter pemisahan yang dikonfigurasi.

none

Perlakukan output sebagai satu blok tanpa penguraian apa pun.

McpServerOutputParsingSplitParameters

Parameter untuk penguraian output terpisah.

Nama Jenis Deskripsi
defaultLanguageCode

SplitSkillLanguage

Nilai yang menunjukkan kode bahasa mana yang akan digunakan. Defaultnya adalah en.

maximumPageLength

integer (int32)

Jumlah maksimum karakter per halaman.

maximumPagesToTake

integer (int32)

Jumlah maksimum halaman yang akan diambil dari output.

pageOverlapLength

integer (int32)

Jumlah karakter yang akan tumpang tindih antar halaman.

textSplitMode

TextSplitMode

Mode pemisahan teks yang akan digunakan.

McpServerSplitOutputParsing

Pisahkan output menjadi beberapa halaman menggunakan parameter pemisahan yang dikonfigurasi.

Nama Jenis Deskripsi
kind string:

split

Jenis penguraian output yang akan diterapkan.

splitParameters

McpServerOutputParsingSplitParameters

Parameter untuk penguraian output terpisah.

McpServerStoredHeadersAuthentication

Autentikasi menggunakan header HTTP yang disimpan.

Nama Jenis Deskripsi
kind string:

storedHeaders

Jenis otentikasi yang akan digunakan.

storedHeadersParameters

McpServerStoredHeadersParameters

Parameter untuk autentikasi header yang disimpan.

McpServerStoredHeadersParameters

Parameter untuk autentikasi header yang disimpan.

Nama Jenis Deskripsi
headers

object

Header HTTP yang disimpan untuk disertakan dalam permintaan server MCP.

McpServerTool

Mewakili satu alat dalam sumber pengetahuan server MCP.

Nama Jenis Deskripsi
inclusionMode

McpServerToolInclusionMode

Mengontrol bagaimana hasil yang diurai dari alat ini diintegrasikan ke dalam kumpulan hasil akhir. Default ke 'reranked' saat tidak ditentukan.

maxOutputTokens

integer (int32)

Batas token pasca-penguraian opsional untuk output alat ini. Harus lebih besar dari 0 saat ditentukan.

name

string

Nama alat MCP yang akan dipanggil.

outputParsing McpServerOutputParsing:

Konfigurasi opsional untuk mengurai output alat.

McpServerToolInclusionMode

Mengontrol bagaimana hasil alat MCP yang diurai diintegrasikan ke dalam kumpulan hasil akhir.

Nilai Deskripsi
reranked

Hasil alat melalui alur pemeringkatan ulang dan agregasi bersama dengan hasil dari sumber pengetahuan lainnya. Ini adalah perilaku default.

always

Hasil alat melewati peringkat ulang dan selalu disertakan dalam konteks agen.

RemoteSharePointKnowledgeSource

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

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

Menghapus properti identitas sumber data.

Nama Jenis Deskripsi
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Fragmen URI yang menentukan jenis identitas.

SearchIndexerDataUserAssignedIdentity

Menentukan identitas untuk sumber data yang akan digunakan.

Nama Jenis Deskripsi
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Fragmen URI yang menentukan jenis identitas.

federatedIdentityClientId

string

Dukungan Identitas Terkelola User-Assigned Multi-penyewa: ID klien Aplikasi multi-tentant yang telah dikonfigurasi untuk berfederasi dengan identitas terkelola yang ditetapkan pengguna.

userAssignedIdentity

string

Id sumber daya Azure yang sepenuhnya memenuhi syarat dari identitas terkelola yang ditetapkan pengguna biasanya dalam formulir "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" yang seharusnya ditetapkan ke layanan pencarian.

SearchIndexFieldReference

Referensi bidang untuk indeks pencarian.

Nama Jenis Deskripsi
name

string

Nama bidang.

SearchIndexKnowledgeSource

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

Parameter untuk sumber pengetahuan indeks pencarian.

Nama Jenis Deskripsi
baseFilter

string

Kondisi filter default yang diterapkan ke indeks pada waktu pengambilan (misalnya, 'State eq VA'). Dapat ditimpa pada waktu kueri melalui parameter runtime sumber pengetahuan.

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

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 Nilai default 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:

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.

isServiceLevelKey

boolean

False

Nilai opsional yang menunjukkan apakah kunci ini adalah kunci tingkat layanan. Secara default adalah false.

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.

SplitSkillLanguage

Kode bahasa yang didukung untuk teks input oleh SplitSkill.

Nilai Deskripsi
am

Amharik

bs

Bosnian

cs

Ceko

da

Dansk

de

German

en

Bahasa Inggris

es

Bahasa Spanyol

et

Bahasa Estonia

fi

Bahasa Finlandia

fr

Bahasa Prancis

he

Bahasa Ibrani

hi

Bahasa Hindi

hr

Bahasa Kroasia

hu

Hungarian

id

Indonesian

is

Islandia

it

Italia

ja

Japanese

ko

Bahasa Korea

lv

Bahasa Latvia

nb

Norwegia

nl

Belanda

pl

Bahasa Polandia

pt

Bahasa Portugis (Portugal)

pt-br

Portugis (Brasil)

ru

Bahasa Rusia

sk

Bahasa Slowakia

sl

Bahasa Slovenia

sr

Bahasa Serbia

sv

Bahasa Swedia

tr

Bahasa Turki

ur

Bahasa Urdu

zh

Bahasa Tionghoa (Sederhana)

TextSplitMode

Nilai yang menunjukkan mode pemisahan mana yang akan dilakukan.

Nilai Deskripsi
pages

Pisahkan teks menjadi halaman individual.

sentences

Pisahkan teks menjadi kalimat individual.

VectorSearchVectorizerKind

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

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

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

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

Parameter untuk sumber pengetahuan web.

Nama Jenis Deskripsi
count

integer (int32)

Jumlah default hasil web yang akan ditampilkan. Dapat ditimpa pada waktu kueri melalui parameter runtime sumber pengetahuan.

domains

WebKnowledgeSourceDomains

Konfigurasi domain izinkan/blokir untuk hasil web.

freshness

string

Filter kesegaran default untuk hasil web. Dapat ditimpa pada waktu kueri melalui parameter runtime sumber pengetahuan.

language

string

Bahasa default untuk hasil web. Dapat ditimpa pada waktu kueri melalui parameter runtime sumber pengetahuan.

market

string

Pasar default untuk hasil web. Dapat ditimpa pada waktu kueri melalui parameter runtime sumber pengetahuan.

WorkIQKnowledgeSource

Konfigurasi untuk sumber pengetahuan WorkIQ.

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:

workIQ

Jenis sumber pengetahuan.

name

string

Nama sumber pengetahuan.