Knowledge Sources - Get

Haalt een definitie van een kennisbron op.

GET {endpoint}/knowledgesources('{sourceName}')?api-version=2026-05-01-preview

URI-parameters

Name In Vereist Type Description
endpoint
path True

string (uri)

De eindpunt-URL van de zoekservice.

sourceName
path True

string

De naam van de kennisbron.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
Accept

Accept

De Accepteer kop.

x-ms-client-request-id

string (uuid)

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name Type Description
200 OK KnowledgeSource:

De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

SearchServiceGetKnowledgeSource
SearchServiceGetKnowledgeSourceAzureBlob
SearchServiceGetKnowledgeSourceFabricDataAgent
SearchServiceGetKnowledgeSourceFabricOntology
SearchServiceGetKnowledgeSourceIndexedOneLake
SearchServiceGetKnowledgeSourceIndexedSharePoint
SearchServiceGetKnowledgeSourceMcpServer
SearchServiceGetKnowledgeSourceWeb
SearchServiceGetKnowledgeSourceWorkIQ

SearchServiceGetKnowledgeSource

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
Accept

De Accepteer kop.

AIServices

Parameters voor AI-services.

AssetStore

Configuratie voor een asset store die wordt gebruikt om geëxtraheerde assets zoals afbeeldingen op te slaan.

AzureBlobKnowledgeSource

Configuratie voor kennisbron Azure Blob Storage.

AzureBlobKnowledgeSourceParameters

Parameters voor Azure Blob Storage-kennisbron.

AzureOpenAIModelName

De Azure Open AI-modelnaam die wordt aangeroepen.

AzureOpenAIVectorizerParameters

Hiermee geeft u de parameters voor het maken van verbinding met de Azure OpenAI-resource.

ContentColumnMapping

Koppelt een SQL-kolom aan een zoekindexveld.

EmbeddingColumnMapping

Mappt een SQL-kolom aan een vectorveld voor embedding.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

Het foutdetail.

ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

FabricDataAgentKnowledgeSource

Configuratie voor kennisbron van Fabric Data Agent.

FabricDataAgentKnowledgeSourceParameters

Parameters voor kennisbron van Fabric Data Agent.

FabricOntologyKnowledgeSource

Configuratie voor kennisbron van Fabric Ontology.

FabricOntologyKnowledgeSourceParameters

Parameters voor kennisbron van Fabric Ontology.

FileKnowledgeSource

Configuratie voor de kennisbron van bestanden die directe bestandsupload en indexering ondersteunt.

FileKnowledgeSourceParameters

Parameters voor de kennisbron van het bestand.

FreshnessPolicy

Configuratie voor versheidsbewuste opvraging. Wanneer ingesteld, krijgen nieuwere documenten een rankingverhoging tijdens het ophalen.

IndexedOneLakeKnowledgeSource

Configuratie voor OneLake kennisbron.

IndexedOneLakeKnowledgeSourceParameters

Parameters voor OneLake kennisbron.

IndexedSharePointContainerName

Hiermee geeft u op welke SharePoint-bibliotheken toegang moeten krijgen.

IndexedSharePointKnowledgeSource

Configuratie voor SharePoint-kennisbron.

IndexedSharePointKnowledgeSourceParameters

Parameters voor SharePoint-kennisbron.

IndexedSqlKnowledgeSource

Configuratie voor geïndexeerde SQL-kennisbron.

IndexedSqlKnowledgeSourceParameters

Parameters voor geïndexeerde SQL-kennisbron.

IndexingSchedule

Vertegenwoordigt een schema voor de uitvoering van de indexeerfunctie.

KnowledgeBaseAzureOpenAIModel

Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om queryplanning uit te voeren.

KnowledgeBaseModelKind

Het AI-model dat moet worden gebruikt voor queryplanning.

KnowledgeSourceAzureOpenAIVectorizer

Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om een querytekenreeks te vectoriseren.

KnowledgeSourceIngestionParameters

Consolidatie van alle algemene invoerinstellingen voor kennisbronnen.

KnowledgeSourceIngestionPermissionOption

Toestemmingstypen om samen met documentinhoud te verwerken.

KnowledgeSourceKind

Het soort kennisbron.

McpServerAuthenticationKind

Het soort authenticatie voor een MCP-server.

McpServerAutoOutputParsing

Automatisch het uitvoerformaat detecteren en dienovereenkomstig analyseren.

McpServerFoundryConnectionAuthentication

Authenticatie via een Azure AI Foundry-verbinding.

McpServerFoundryConnectionParameters

Parameters voor authenticatie van Foundry-verbindingen.

McpServerJsonOutputParsing

Parse de uitvoer als een JSON-document met behulp van de geconfigureerde JSON-parameters.

McpServerKnowledgeSource

Configuratie voor een kennisbron die wordt ondersteund door een MCP (Model Context Protocol) server.

McpServerKnowledgeSourceParameters

Parameters voor een kennisbron van een MCP-server.

McpServerNoneOutputParsing

Behandel de output als één blok zonder parsing.

McpServerOutputParsingJsonParameters

Parameters voor JSON-uitvoerparsing.

McpServerOutputParsingKind

Het soort output parsing voor een MCP-servertool.

McpServerOutputParsingSplitParameters

Parameters voor split output parsing.

McpServerSplitOutputParsing

Splits de output op in pagina's met behulp van de geconfigureerde splitparameters.

McpServerStoredHeadersAuthentication

Authenticatie met opgeslagen HTTP-headers.

McpServerStoredHeadersParameters

Parameters voor authenticatie van opgeslagen headers.

McpServerTool

Vertegenwoordigt een enkel hulpmiddel binnen een MCP-serverkennisbron.

McpServerToolInclusionMode

Regelt hoe de resultaten van de geparseerde MCP-tools worden geïntegreerd in de eindresultaatset.

RemoteSharePointKnowledgeSource

Configuratie voor externe SharePoint-kennisbron.

RemoteSharePointKnowledgeSourceParameters

Parameters voor externe SharePoint-kennisbron.

SearchIndexerDataNoneIdentity

Hiermee wist u de identiteitseigenschap van een gegevensbron.

SearchIndexerDataUserAssignedIdentity

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.

SearchIndexFieldReference

Veldreferentie voor een zoekindex.

SearchIndexKnowledgeSource

Kennisbron die zich richt op een zoekindex.

SearchIndexKnowledgeSourceParameters

Parameters voor zoekindex kennisbron.

SearchResourceEncryptionKey

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.

SplitSkillLanguage

De taalcodes die door SplitSkill worden ondersteund voor invoertekst.

TextSplitMode

Een waarde die aangeeft welke splitsmodus moet worden uitgevoerd.

VectorSearchVectorizerKind

De vectorisatiemethode die moet worden gebruikt tijdens de zoekopdracht.

WebKnowledgeSource

Kennisbron gericht op webresultaten.

WebKnowledgeSourceDomain

Configuratie voor het domein van webkennisbronnen.

WebKnowledgeSourceDomains

Domein toestaan/blokkeren configuratie voor webkennisbron.

WebKnowledgeSourceParameters

Parameters voor de webkennisbron.

WorkIQKnowledgeSource

Configuratie voor WorkIQ kennisbron.

Accept

De Accepteer kop.

Waarde Description
application/json;odata.metadata=minimal

AIServices

Parameters voor AI-services.

Name Type Description
apiKey

string

De API-sleutel voor toegang tot AI-diensten.

uri

string (uri)

De URI van het AI Services-eindpunt.

AssetStore

Configuratie voor een asset store die wordt gebruikt om geëxtraheerde assets zoals afbeeldingen op te slaan.

Name Type Description
connectionString

string

De verbindingsreeks voor de asset store.

containerName

string

De naam van de blobcontainer binnen de asset store waar geëxtraheerde assets (bijvoorbeeld images) worden opgeslagen.

AzureBlobKnowledgeSource

Configuratie voor kennisbron Azure Blob Storage.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

azureBlobParameters

AzureBlobKnowledgeSourceParameters

Het type kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

kind string:

azureBlob

Het type kennisbron.

name

string

De naam van de kennisbron.

AzureBlobKnowledgeSourceParameters

Parameters voor Azure Blob Storage-kennisbron.

Name Type Default value Description
connectionString

string

Op sleutel gebaseerde verbindingsreeks of de ResourceId-indeling als u een beheerde identiteit gebruikt.

containerName

string

De naam van de blob-opslagcontainer.

createdResources

object

Bronnen die zijn gemaakt door de kennisbron.

folderPath

string

Optioneel mappad in de container.

ingestionParameters

KnowledgeSourceIngestionParameters

Consolideert alle algemene opname-instellingen.

isADLSGen2

boolean

False

Stel in op true als u verbinding maakt met een ADLS Gen2-opslagaccount. De standaardwaarde is vals.

AzureOpenAIModelName

De Azure Open AI-modelnaam die wordt aangeroepen.

Waarde Description
text-embedding-ada-002

TextEmbeddingAda002 model.

text-embedding-3-large

TextEmbedding3Groot model.

text-embedding-3-small

TextEmbedding3Small-model.

gpt-4o

Gpt4o model.

gpt-4o-mini

Gpt4oMini model.

gpt-4.1

Gpt41-model.

gpt-4.1-mini

Gpt41Mini model.

gpt-4.1-nano

Gpt41Nano-model.

gpt-5

Gpt5-model.

gpt-5-mini

Gpt5Mini model.

gpt-5-nano

Gpt5Nano-model.

gpt-5.1

Gpt51 model.

gpt-5.2

Gpt52-model.

gpt-5.4

Gpt54 model.

gpt-5.4-mini

Gpt54Mini model.

gpt-5.4-nano

Gpt54Nano model.

gpt-5.5

Gpt55 model.

AzureOpenAIVectorizerParameters

Hiermee geeft u de parameters voor het maken van verbinding met de Azure OpenAI-resource.

Name Type Description
apiKey

string

API-sleutel van de aangewezen Azure OpenAI-resource.

authIdentity SearchIndexerDataIdentity:

De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen.

deploymentId

string

ID van de implementatie van het Azure OpenAI-model op de aangewezen resource.

modelName

AzureOpenAIModelName

De naam van het insluitmodel dat is geïmplementeerd op het opgegeven deploymentId-pad.

resourceUri

string (uri)

De resource-URI van de Azure OpenAI-resource.

ContentColumnMapping

Koppelt een SQL-kolom aan een zoekindexveld.

Name Type Description
name

string

Naam van het veldwoord van de doelindex.

searchFieldType

string

Azure AI Zoeken field type (bijv. Edm.String, Edm.Int32).

sourceField

string

SQL-kolomnaam.

EmbeddingColumnMapping

Mappt een SQL-kolom aan een vectorveld voor embedding.

Name Type Description
name

string

Naam van het doelvectorveld in de zoekindex.

sourceField

string

De SQL-kolom wordt gebruikt als invoer voor embeddinggeneratie.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

Het foutdetail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

Aanvullende informatie over de fout.

code

string

De foutcode.

details

ErrorDetail[]

De foutgegevens.

message

string

Het foutbericht.

target

string

Het foutdoelwit.

ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error

ErrorDetail

Het foutobject.

FabricDataAgentKnowledgeSource

Configuratie voor kennisbron van Fabric Data Agent.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

fabricDataAgentParameters

FabricDataAgentKnowledgeSourceParameters

De parameters voor de kennisbron van de Fabric Data Agent.

kind string:

fabricDataAgent

Het type kennisbron.

name

string

De naam van de kennisbron.

FabricDataAgentKnowledgeSourceParameters

Parameters voor kennisbron van Fabric Data Agent.

Name Type Description
dataAgentId

string

Geeft aan welke Fabric Data Agent geraadpleegd moet worden.

workspaceId

string

Fabric workspace ID.

FabricOntologyKnowledgeSource

Configuratie voor kennisbron van Fabric Ontology.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

fabricOntologyParameters

FabricOntologyKnowledgeSourceParameters

De parameters voor de kennisbron van Fabric Ontology.

kind string:

fabricOntology

Het type kennisbron.

name

string

De naam van de kennisbron.

FabricOntologyKnowledgeSourceParameters

Parameters voor kennisbron van Fabric Ontology.

Name Type Description
ontologyId

string

De ID van de ontologie die gebruikt moet worden vanuit de Fabric-werkruimte.

workspaceId

string

De Fabric workspace ID met de ontologie.

FileKnowledgeSource

Configuratie voor de kennisbron van bestanden die directe bestandsupload en indexering ondersteunt.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

fileParameters

FileKnowledgeSourceParameters

De parameters voor de kennisbron van het bestand.

kind string:

file

Het type kennisbron.

name

string

De naam van de kennisbron.

FileKnowledgeSourceParameters

Parameters voor de kennisbron van het bestand.

Name Type Description
createdResources

object

Bronnen gemaakt door de bestandskennis bron.

ingestionParameters

KnowledgeSourceIngestionParameters

Consolidatie van alle algemene invoerinstellingen voor de bestandskennisbron, inclusief de contentextractiemodus en een optioneel embeddingModel.

FreshnessPolicy

Configuratie voor versheidsbewuste opvraging. Wanneer ingesteld, krijgen nieuwere documenten een rankingverhoging tijdens het ophalen.

Name Type Description
boostingDuration

string

ISO 8601-duur voor het versheidsverhogingsvenster (bijv. 'P90D' voor 90 dagen). Documenten die nieuwer zijn dan deze duur krijgen een rankingverhoging tijdens het ophalen.

IndexedOneLakeKnowledgeSource

Configuratie voor OneLake kennisbron.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

indexedOneLakeParameters

IndexedOneLakeKnowledgeSourceParameters

De parameters voor de kennisbron.

kind string:

indexedOneLake

Het type kennisbron.

name

string

De naam van de kennisbron.

IndexedOneLakeKnowledgeSourceParameters

Parameters voor OneLake kennisbron.

Name Type Description
createdResources

object

Bronnen die zijn gemaakt door de kennisbron.

fabricWorkspaceId

string

OneLake-werkruimte-ID.

ingestionParameters

KnowledgeSourceIngestionParameters

Consolideert alle algemene opname-instellingen.

lakehouseId

string

Geeft aan tot welk OneLake-meerhuis toegang moet worden verkregen.

targetPath

string

Optionele OneLakehouse-map of snelkoppeling om OneLake-inhoud te filteren.

IndexedSharePointContainerName

Hiermee geeft u op welke SharePoint-bibliotheken toegang moeten krijgen.

Waarde Description
defaultSiteLibrary

Indexeer inhoud uit de standaard documentbibliotheek van de site.

allSiteLibraries

Indexeer de inhoud van elke documentbibliotheek op de site.

useQuery

Gebruik een query om SharePoint-inhoud te filteren.

IndexedSharePointKnowledgeSource

Configuratie voor SharePoint-kennisbron.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

indexedSharePointParameters

IndexedSharePointKnowledgeSourceParameters

De parameters voor de kennisbron.

kind string:

indexedSharePoint

Het type kennisbron.

name

string

De naam van de kennisbron.

IndexedSharePointKnowledgeSourceParameters

Parameters voor SharePoint-kennisbron.

Name Type Description
connectionString

string

SharePoint-verbindingsreeks met de volgende indeling: SharePointOnlineEndpoint=[SharePoint-site-URL]; ApplicationId=[Azure AD-app-id]; ApplicationSecret=[Geheim van Azure AD-app-client]; TenantId=[Tenant-id SharePoint-site]

containerName

IndexedSharePointContainerName

Hiermee geeft u op welke SharePoint-bibliotheken toegang moeten krijgen.

createdResources

object

Bronnen die zijn gemaakt door de kennisbron.

ingestionParameters

KnowledgeSourceIngestionParameters

Consolideert alle algemene opname-instellingen.

query

string

Optionele zoekopdracht om SharePoint-inhoud te filteren.

IndexedSqlKnowledgeSource

Configuratie voor geïndexeerde SQL-kennisbron.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

indexedSqlParameters

IndexedSqlKnowledgeSourceParameters

De parameters voor de SQL-kennisbron.

kind string:

indexedSql

Het type kennisbron.

name

string

De naam van de kennisbron.

IndexedSqlKnowledgeSourceParameters

Parameters voor geïndexeerde SQL-kennisbron.

Name Type Description
connectionString

string

De verbindingsreeks voor de Azure SQL Database of SQL Managed Instance.

contentColumns

ContentColumnMapping[]

Optionele kolomtoewijzingen voor inhoudsvelden. Als ze worden weggelaten, worden alle kolommen automatisch ontdekt.

createdResources

object

Bronnen die zijn gemaakt door de kennisbron.

embeddingColumns

EmbeddingColumnMapping[]

Optionele kolomafbeeldingen voor het inbedden van vectorvelden. Als deze wordt weggelaten, worden er geen vectorvelden gecreëerd.

highWaterMarkColumnName

string

Optionele kolomnaam voor het detecteren van verandering van hoge watermerken. Indien beschikbaar, gebruik HighWaterMarkChangeDetectionPolicy.

ingestionParameters

KnowledgeSourceIngestionParameters

Consolidatie van alle algemene invoerinstellingen, inclusief embedding model, planning en identiteit.

tableOrView

string

De naam van de tabel of weergave om te indexeren. Kan schema-gekwalificeerd worden (bijv. 'dbo. MyTable').

IndexingSchedule

Vertegenwoordigt een schema voor de uitvoering van de indexeerfunctie.

Name Type Description
interval

string (duration)

Het tijdsinterval tussen de uitvoeringen van de indexeerfunctie.

startTime

string (date-time)

Het tijdstip waarop een indexeerfunctie moet beginnen met werken.

KnowledgeBaseAzureOpenAIModel

Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om queryplanning uit te voeren.

Name Type Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI parameters.

kind string:

azureOpenAI

Het AI-model dat moet worden gebruikt voor queryplanning.

KnowledgeBaseModelKind

Het AI-model dat moet worden gebruikt voor queryplanning.

Waarde Description
azureOpenAI

Gebruik Azure Open AI-modellen voor het plannen van query's.

KnowledgeSourceAzureOpenAIVectorizer

Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om een querytekenreeks te vectoriseren.

Name Type Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Bevat de parameters die specifiek zijn voor Azure OpenAI-inbeddingsvectorisatie.

kind string:

azureOpenAI

De naam van het soort vectorisatiemethode dat wordt geconfigureerd voor gebruik met vectorzoekopdrachten.

KnowledgeSourceIngestionParameters

Consolidatie van alle algemene invoerinstellingen voor kennisbronnen.

Name Type Default value Description
aiServices

AIServices

Optionele AI-dienstenconfiguratie voor contentverwerking.

assetStore

AssetStore

Optionele asset store-configuratie voor het opslaan van extraherde assets zoals afbeeldingen.

chatCompletionModel KnowledgeBaseModel:

KnowledgeBaseAzureOpenAIModel

Optioneel model voor het voltooien van de chat voor het verwoorden van afbeeldingen of het extraheren van contexten.

contentExtractionMode enum:
  • minimal
  • standard
minimal

Optionele contentextractiemodus. De standaard is 'minimaal'.

disableImageVerbalization

boolean

False

Geeft aan of beeldverbalisatie moet worden uitgeschakeld. De standaardwaarde is vals.

embeddingModel KnowledgeSourceVectorizer:

KnowledgeSourceAzureOpenAIVectorizer

Optionele vectorizerconfiguratie voor het vectoriseren van inhoud.

freshnessPolicy

FreshnessPolicy

Optioneel versheidsbeleid voor het bevooroordeeld ophalen richting nieuwere documenten.

identity SearchIndexerDataIdentity:

Een expliciete identiteit om te gebruiken voor deze kennisbron.

ingestionPermissionOptions

KnowledgeSourceIngestionPermissionOption[]

Optionele lijst van toestemmingstypen om samen met documentinhoud te importeren. Indien gespecificeerd, stelt het de indexer-permissieopties voor de databron in.

ingestionSchedule

IndexingSchedule

Optioneel schema voor gegevensopname.

KnowledgeSourceIngestionPermissionOption

Toestemmingstypen om samen met documentinhoud te verwerken.

Waarde Description
userIds

Neem expliciete gebruikers-ID's op naast de inhoud van het document.

groupIds

Registreer groeps-ID's naast documentinhoud.

rbacScope

Registreer RBAC-bereikinformatie naast de inhoud van het document.

sensitivityLabels

Voer Microsoft Purview-gevoeligheidslabels in naast documentinhoud.

KnowledgeSourceKind

Het soort kennisbron.

Waarde Description
searchIndex

Een kennisbron die gegevens uit een zoekindex leest.

azureBlob

Een kennisbron die gegevens van Azure Blob Storage leest en opneemt in een zoekindex.

indexedSharePoint

Een kennisbron die data leest van geïndexeerde SharePoint.

indexedOneLake

Een kennisbron die gegevens leest van geïndexeerde OneLake.

indexedSql

Een kennisbron die gegevens ophaalt en opneemt van Azure SQL Database of SQL Managed Instance naar een Search Index.

web

Een kennisbron die data van het web leest.

remoteSharePoint

Een kennisbron die data leest van remote SharePoint.

workIQ

Een kennisbron die gegevens leest van werk-IQ

file

Een kennisbron die directe bestandsupload en indexering ondersteunt.

mcpServer

Een kennisbron ondersteund door een MCP (Model Context Protocol) server.

fabricDataAgent

Een kennisbron die data ophaalt van een Fabric Data Agent.

fabricOntology

Een kennisbron die data ophaalt uit Microsoft Fabric Ontology ontologieën.

McpServerAuthenticationKind

Het soort authenticatie voor een MCP-server.

Waarde Description
foundryConnection

Authenticeer via een Azure AI Foundry-verbinding.

storedHeaders

Authenticeer met opgeslagen HTTP-headers.

McpServerAutoOutputParsing

Automatisch het uitvoerformaat detecteren en dienovereenkomstig analyseren.

Name Type Description
kind string:

auto

Het soort outputparsing dat je toepast.

McpServerFoundryConnectionAuthentication

Authenticatie via een Azure AI Foundry-verbinding.

Name Type Description
foundryConnectionParameters

McpServerFoundryConnectionParameters

Parameters voor authenticatie van Foundry-verbindingen.

kind string:

foundryConnection

Het soort authenticatie dat je moet gebruiken.

McpServerFoundryConnectionParameters

Parameters voor authenticatie van Foundry-verbindingen.

Name Type Description
connectionId

string

De Azure AI Foundry verbindingsidentificatie.

McpServerJsonOutputParsing

Parse de uitvoer als een JSON-document met behulp van de geconfigureerde JSON-parameters.

Name Type Description
jsonParameters

McpServerOutputParsingJsonParameters

Parameters voor JSON-uitvoerparsing. Vereist wanneer 'vriendelijk' is.

kind string:

json

Het soort outputparsing dat je toepast.

McpServerKnowledgeSource

Configuratie voor een kennisbron die wordt ondersteund door een MCP (Model Context Protocol) server.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

kind string:

mcpServer

Het type kennisbron.

mcpServerParameters

McpServerKnowledgeSourceParameters

De parameters voor de MCP-serverkennis bron.

name

string

De naam van de kennisbron.

McpServerKnowledgeSourceParameters

Parameters voor een kennisbron van een MCP-server.

Name Type Description
authentication McpServerAuthentication:

De authenticatieconfiguratie voor de MCP-server.

serverURL

string

De URL van het MCP-servereindpunt.

tools

McpServerTool[]

De lijst met tools die op de MCP-server moeten worden aangeroepen.

McpServerNoneOutputParsing

Behandel de output als één blok zonder parsing.

Name Type Description
kind string:

none

Het soort outputparsing dat je toepast.

McpServerOutputParsingJsonParameters

Parameters voor JSON-uitvoerparsing.

Name Type Description
documentsPath

string

Het JSON-pad naar de array van documenten in de tooloutput.

includeContext

boolean

Of de context van de JSON-uitvoer naast geëxtraheerde documenten moet worden opgenomen.

McpServerOutputParsingKind

Het soort output parsing voor een MCP-servertool.

Waarde Description
auto

Automatisch het uitvoerformaat detecteren en dienovereenkomstig analyseren.

json

Parse de uitvoer als een JSON-document met behulp van de geconfigureerde JSON-parameters.

split

Splits de output op in pagina's met behulp van de geconfigureerde splitparameters.

none

Behandel de output als één blok zonder parsing.

McpServerOutputParsingSplitParameters

Parameters voor split output parsing.

Name Type Description
defaultLanguageCode

SplitSkillLanguage

Een waarde die aangeeft welke taalcode moet worden gebruikt. De standaardwaarde is en.

maximumPageLength

integer (int32)

Het maximale aantal tekens per pagina.

maximumPagesToTake

integer (int32)

Het maximale aantal pagina's dat uit de output moet worden gehaald.

pageOverlapLength

integer (int32)

Het aantal tekens dat tussen de pagina's overloopt.

textSplitMode

TextSplitMode

De tekstsplitmodus om te gebruiken.

McpServerSplitOutputParsing

Splits de output op in pagina's met behulp van de geconfigureerde splitparameters.

Name Type Description
kind string:

split

Het soort outputparsing dat je toepast.

splitParameters

McpServerOutputParsingSplitParameters

Parameters voor split output parsing.

McpServerStoredHeadersAuthentication

Authenticatie met opgeslagen HTTP-headers.

Name Type Description
kind string:

storedHeaders

Het soort authenticatie dat je moet gebruiken.

storedHeadersParameters

McpServerStoredHeadersParameters

Parameters voor authenticatie van opgeslagen headers.

McpServerStoredHeadersParameters

Parameters voor authenticatie van opgeslagen headers.

Name Type Description
headers

object

De opgeslagen HTTP-headers om op te nemen in MCP-serververzoeken.

McpServerTool

Vertegenwoordigt een enkel hulpmiddel binnen een MCP-serverkennisbron.

Name Type Description
inclusionMode

McpServerToolInclusionMode

Regelt hoe de geanalyseerde resultaten van deze tool worden geïntegreerd in de eindresultaatset. Standaard staat het op 'herrangeerd' als het niet is gespecificeerd.

maxOutputTokens

integer (int32)

Optionele post-parsing tokencap voor de output van deze tool. Moet groter zijn dan 0 wanneer gespecificeerd.

name

string

De naam van het MCP-hulpprogramma dat moet worden aangeroepen.

outputParsing McpServerOutputParsing:

Optionele configuratie voor het parsen van de uitvoer van het gereedschap.

McpServerToolInclusionMode

Regelt hoe de resultaten van de geparseerde MCP-tools worden geïntegreerd in de eindresultaatset.

Waarde Description
reranked

Toolresultaten gaan samen met resultaten uit andere kennisbronnen door de herrangschikking en aggregatiepijplijn. Dit is het standaardgedrag.

always

Toolresultaten omzeilen herrangschikking en worden altijd opgenomen in de context van de agent.

RemoteSharePointKnowledgeSource

Configuratie voor externe SharePoint-kennisbron.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

kind string:

remoteSharePoint

Het type kennisbron.

name

string

De naam van de kennisbron.

remoteSharePointParameters

RemoteSharePointKnowledgeSourceParameters

De parameters voor de remote SharePoint-kennisbron.

RemoteSharePointKnowledgeSourceParameters

Parameters voor externe SharePoint-kennisbron.

Name Type Description
containerTypeId

string

Container-id voor SharePoint Ingesloten verbinding. Wanneer dit null is, wordt SharePoint Online gebruikt.

filterExpression

string

Keyword Query Language (KQL)-expressie met doorzoekbare SharePoint-eigenschappen en -kenmerken om het bereik van het ophalen te bereiken voordat de query wordt uitgevoerd.

resourceMetadata

string[]

Een lijst van metadatavelden die voor elk item in de respons moeten worden teruggegeven. Alleen ophaalbare metadata-eigenschappen kunnen in deze lijst worden opgenomen. Standaard worden er geen metagegevens geretourneerd.

SearchIndexerDataNoneIdentity

Hiermee wist u de identiteitseigenschap van een gegevensbron.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Een URI-fragment dat het type identiteit specificeert.

SearchIndexerDataUserAssignedIdentity

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.

Name Type Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Een URI-fragment dat het type identiteit specificeert.

federatedIdentityClientId

string

Multi-tenant User-Assigned Managed Identity Support: De client-id van de multi-tentant app die is geconfigureerd om te federeren met de door de gebruiker toegewezen beheerde identiteit.

userAssignedIdentity

string

De volledig gekwalificeerde Azure-resource-id van een door de gebruiker toegewezen beheerde identiteit, meestal in de vorm '/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' die aan de zoekservice moet zijn toegewezen.

SearchIndexFieldReference

Veldreferentie voor een zoekindex.

Name Type Description
name

string

De naam van het veld.

SearchIndexKnowledgeSource

Kennisbron die zich richt op een zoekindex.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

kind string:

searchIndex

Het type kennisbron.

name

string

De naam van de kennisbron.

searchIndexParameters

SearchIndexKnowledgeSourceParameters

De parameters voor de kennisbron.

SearchIndexKnowledgeSourceParameters

Parameters voor zoekindex kennisbron.

Name Type Description
baseFilter

string

Een standaardfiltervoorwaarde toegepast op de index bij het ophalen (bijv. 'Toestandsvergelijking VA'). Kan tijdens het query-moment worden overschreven via knowledge source runtime-parameters.

searchFields

SearchIndexFieldReference[]

Wordt gebruikt om te beperken welke velden moeten worden doorzocht in de zoekindex.

searchIndexName

string

De naam van de zoekindex.

semanticConfigurationName

string

Wordt gebruikt om een andere semantische configuratie op te geven in de doelzoekindex dan de standaardconfiguratie.

sourceDataFields

SearchIndexFieldReference[]

Wordt gebruikt om extra velden op te vragen voor brongegevens waarnaar wordt verwezen.

SearchResourceEncryptionKey

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.

Name Type Default value Description
accessCredentials.applicationId

string

Een AAD-toepassings-id waaraan de vereiste toegangsmachtigingen zijn verleend voor de Azure Key Vault die moet worden gebruikt bij het versleutelen van uw data-at-rest. De toepassings-id mag niet worden verward met de object-id voor uw AAD-toepassing.

accessCredentials.applicationSecret

string

De verificatiesleutel van de opgegeven AAD-toepassing.

identity SearchIndexerDataIdentity:

Een expliciete beheerde identiteit die moet worden gebruikt voor deze versleutelingssleutel. Als dit niet is opgegeven en de eigenschap toegangsreferenties null is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Bij het bijwerken van de resource, als de expliciete identiteit niet is opgegeven, blijft deze ongewijzigd. Als 'geen' is opgegeven, wordt de waarde van deze eigenschap gewist.

isServiceLevelKey

boolean

False

Een optionele waarde die aangeeft of deze sleutel een serviceniveausleutel is. De standaardwaarde is vals.

keyVaultKeyName

string

De naam van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.

keyVaultKeyVersion

string

De versie van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.

keyVaultUri

string

De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt voor het versleutelen van uw data-at-rest. Een voorbeeld van een URI kan https://my-keyvault-name.vault.azure.netzijn.

SplitSkillLanguage

De taalcodes die door SplitSkill worden ondersteund voor invoertekst.

Waarde Description
am

Amharic

bs

Bosnisch

cs

Tsjechisch

da

Deens

de

Duits

en

Engels

es

Spaans

et

Estlander

fi

Fins

fr

Frans

he

Hebreeuws

hi

Hindi

hr

Kroatisch

hu

Hongaars

id

Indonesian

is

IJslands

it

Italiaans

ja

De Japanse taal

ko

Koreaans

lv

Letse taal

nb

Noors

nl

Nederlands

pl

Polijsten

pt

Portugees (Portugal)

pt-br

Portugees (Brazilië)

ru

Russisch

sk

Slowaaks

sl

Sloveens

sr

Servisch

sv

Zweeds

tr

Turkse taal

ur

Urdu

zh

Chinees (vereenvoudigd)

TextSplitMode

Een waarde die aangeeft welke splitsmodus moet worden uitgevoerd.

Waarde Description
pages

Splits de tekst in afzonderlijke pagina's.

sentences

Splits de tekst in afzonderlijke zinnen.

VectorSearchVectorizerKind

De vectorisatiemethode die moet worden gebruikt tijdens de zoekopdracht.

Waarde Description
azureOpenAI

Genereer insluitingen met behulp van een Azure OpenAI-resource tijdens het uitvoeren van query's.

customWebApi

Genereer insluitingen met behulp van een aangepast webeindpunt tijdens de query.

aiServicesVision

Genereer insluitingen voor een afbeelding of tekstinvoer tijdens de query met behulp van de Azure AI Services Vision Vectorize-API.

aml

Genereer inbeddingen met behulp van een Azure Machine Learning-eindpunt dat is geïmplementeerd via de Azure AI Foundry Model Catalog op het moment van de query.

WebKnowledgeSource

Kennisbron gericht op webresultaten.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

kind string:

web

Het type kennisbron.

name

string

De naam van de kennisbron.

webParameters

WebKnowledgeSourceParameters

De parameters voor de webkennisbron.

WebKnowledgeSourceDomain

Configuratie voor het domein van webkennisbronnen.

Name Type Description
address

string

Het adres van het domein.

includeSubpages

boolean

Het al dan niet opnemen van subpagina's van dit domein.

WebKnowledgeSourceDomains

Domein toestaan/blokkeren configuratie voor webkennisbron.

Name Type Description
allowedDomains

WebKnowledgeSourceDomain[]

Domeinen die zijn toegestaan voor webresultaten.

blockedDomains

WebKnowledgeSourceDomain[]

Domeinen die geblokkeerd zijn in webresultaten.

WebKnowledgeSourceParameters

Parameters voor de webkennisbron.

Name Type Description
count

integer (int32)

Het standaardaantal webresultaten dat terugkomt. Kan tijdens het query-moment worden overschreven via knowledge source runtime-parameters.

domains

WebKnowledgeSourceDomains

Domein-toelaat/blokkeerconfiguratie voor webresultaten.

freshness

string

Het standaard versheidsfilter voor webresultaten. Kan tijdens het query-moment worden overschreven via knowledge source runtime-parameters.

language

string

De standaardtaal voor webresultaten. Kan tijdens het query-moment worden overschreven via knowledge source runtime-parameters.

market

string

De standaardmarkt voor webresultaten. Kan tijdens het query-moment worden overschreven via knowledge source runtime-parameters.

WorkIQKnowledgeSource

Configuratie voor WorkIQ kennisbron.

Name Type Description
@odata.etag

string

De ETag van de kennisbron.

description

string

Optionele door de gebruiker gedefinieerde beschrijving.

encryptionKey

SearchResourceEncryptionKey

Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van encryptie-at-rest te bieden voor je kennisbrondefinitie wanneer je volledige zekerheid wilt dat niemand, zelfs Microsoft niet, ze kan ontsleutelen. Zodra je je kennisbrondefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap op null in te stellen. Je kunt deze eigenschap aanpassen als je je encryptiesleutel wilt roteren; Je definitie van kennisbron blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

kind string:

workIQ

Het type kennisbron.

name

string

De naam van de kennisbron.