Knowledge Sources - Create

Serviço:: Search Service

Versão da API:: 2026-08-01-preview

Cria uma nova fonte de conhecimento.

POST {endpoint}/knowledgesources?api-version=2026-08-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome	Description
AzureBlobKnowledgeSource	Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.
FabricDataAgentKnowledgeSource	Configuração para a fonte de conhecimento do Fabric Data Agent.
FabricOntologyKnowledgeSource	Configuração para a fonte de conhecimento do Fabric Ontology.
FileKnowledgeSource	Configuração para fonte de conhecimento de arquivos que suporta upload direto e indexação de arquivos.
IndexedOneLakeKnowledgeSource	Configuração para a fonte de conhecimento do OneLake.
IndexedSharePointKnowledgeSource	Configuração para a fonte de conhecimento do SharePoint.
IndexedSqlKnowledgeSource	Configuração para fonte de conhecimento SQL indexada.
McpServerKnowledgeSource	Configuração para uma fonte de conhecimento respaldada por um servidor MCP (Model Context Protocol).
RemoteSharePointKnowledgeSource	Configuração para fonte de conhecimento remota do SharePoint.
SearchIndexKnowledgeSource	Fonte de conhecimento direcionada a um índice de pesquisa.
WebKnowledgeSource	Fonte de conhecimento direcionando resultados da Web.
WorkIQKnowledgeSource	Configuração para fonte de conhecimento do WorkIQ.

AzureBlobKnowledgeSource

Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.

Nome	Obrigatório	Tipo	Description
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	O tipo da fonte de conhecimento.
kind	True	string: azureBlob	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

FabricDataAgentKnowledgeSource

Configuração para a fonte de conhecimento do Fabric Data Agent.

Nome	Obrigatório	Tipo	Description
fabricDataAgentParameters	True	FabricDataAgentKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do Fabric Data Agent.
kind	True	string: fabricDataAgent	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

FabricOntologyKnowledgeSource

Configuração para a fonte de conhecimento do Fabric Ontology.

Nome	Obrigatório	Tipo	Description
fabricOntologyParameters	True	FabricOntologyKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Fabric Ontology.
kind	True	string: fabricOntology	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

FileKnowledgeSource

Configuração para fonte de conhecimento de arquivos que suporta upload direto e indexação de arquivos.

Nome	Obrigatório	Tipo	Description
fileParameters	True	FileKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do arquivo.
kind	True	string: file	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
corsOptions		CorsOptions	Opções para controlar o Compartilhamento de Recursos de Origem Cruzada (CORS) para os endpoints de arquivo da fonte de conhecimento do arquivo (upload, listagem, atualização, exclusão).
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

IndexedOneLakeKnowledgeSource

Configuração para a fonte de conhecimento do OneLake.

Nome	Obrigatório	Tipo	Description
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	True	string: indexedOneLake	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

IndexedSharePointKnowledgeSource

Configuração para a fonte de conhecimento do SharePoint.

Nome	Obrigatório	Tipo	Description
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	True	string: indexedSharePoint	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

IndexedSqlKnowledgeSource

Configuração para fonte de conhecimento SQL indexada.

Nome	Obrigatório	Tipo	Description
indexedSqlParameters	True	IndexedSqlKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento SQL.
kind	True	string: indexedSql	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

McpServerKnowledgeSource

Configuração para uma fonte de conhecimento respaldada por um servidor MCP (Model Context Protocol).

Nome	Obrigatório	Tipo	Description
kind	True	string: mcpServer	O tipo da fonte de conhecimento.
mcpServerParameters	True	McpServerKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do servidor MCP.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

RemoteSharePointKnowledgeSource

Configuração para fonte de conhecimento remota do SharePoint.

Nome	Obrigatório	Tipo	Description
kind	True	string: remoteSharePoint	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	Os parâmetros para a fonte remota de conhecimento do SharePoint.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

SearchIndexKnowledgeSource

Fonte de conhecimento direcionada a um índice de pesquisa.

Nome	Obrigatório	Tipo	Description
kind	True	string: searchIndex	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

WebKnowledgeSource

Fonte de conhecimento direcionando resultados da Web.

Nome	Obrigatório	Tipo	Description
kind	True	string: web	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.
webParameters		WebKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Web.

WorkIQKnowledgeSource

Configuração para fonte de conhecimento do WorkIQ.

Nome	Obrigatório	Tipo	Description
kind	True	string: workIQ	O tipo da fonte de conhecimento.
name	True	string	O nome da fonte de conhecimento.
workIQParameters	True	WorkIQKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do WorkIQ, incluindo a configuração do aplicativo Entra, de propriedade do cliente, usada para autenticação em nome do cliente.
@odata.etag		string	O ETag da fonte de conhecimento.
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

Respostas

Nome	Tipo	Description
201 Created	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

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

Exemplos

SearchServiceCreateKnowledgeSource

SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSourceFabricDataAgent

SearchServiceCreateKnowledgeSourceFabricOntology

SearchServiceCreateKnowledgeSourceFile

SearchServiceCreateKnowledgeSourceIndexedOneLake

SearchServiceCreateKnowledgeSourceIndexedSharePoint

SearchServiceCreateKnowledgeSourceIndexedSql

SearchServiceCreateKnowledgeSourceMcpServer

SearchServiceCreateKnowledgeSourceWeb

SearchServiceCreateKnowledgeSourceWorkIQ

SearchServiceCreateKnowledgeSource

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "resultsProcessing": "none",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceAzureBlob

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      },
      "networkAccessMode": "private"
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "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": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateKnowledgeSourceFabricDataAgent

Solicitação de exemplo

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview


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

Resposta de exemplo

Código de status:: 201

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

SearchServiceCreateKnowledgeSourceFabricOntology

Solicitação de exemplo

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview


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

Resposta de exemplo

Código de status:: 201

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

SearchServiceCreateKnowledgeSourceFile

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the File knowledge source.",
  "kind": "file",
  "fileParameters": {
    "ingestionParameters": {
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "index": "ks-preview-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

SearchServiceCreateKnowledgeSourceIndexedOneLake

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the OneLake knowledge source.",
  "kind": "indexedOneLake",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedSharePoint

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the SharePoint knowledge source.",
  "kind": "indexedSharePoint",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "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"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedSql

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-test",
  "description": "Description of the SQL knowledge source.",
  "kind": "indexedSql",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "minimal"
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSql",
  "description": "Description of the SQL 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>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceMcpServer

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Resposta de exemplo

Código de status:: 201

{
  "@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",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceCreateKnowledgeSourceWeb

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "web",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "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
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceWorkIQ

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Resposta de exemplo

Código de status:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ 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>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
AIServices	Parâmetros para Serviços de IA.
AssetStore	Configuração para um asset store usado para armazenar assets extraídos, como imagens.
AzureBlobKnowledgeSource	Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.
AzureBlobKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do Armazenamento de Blobs do Azure.
AzureOpenAIModelName	O nome do modelo do Azure Open AI que será chamado.
AzureOpenAIVectorizerParameters	Especifica os parâmetros para se conectar ao recurso do Azure OpenAI.
ContentColumnMapping	Mapeia uma coluna SQL para um campo índice de busca.
CorsOptions	Define opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para um índice.
EmbeddingColumnMapping	Mapeia uma coluna SQL para um campo vetorial para embedding.
EntraAppAuthentication	Configuração para um registro de aplicativo Microsoft Entra de propriedade do cliente, usado para autenticação baseada em credenciais federadas em nome de Trust.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
FabricDataAgentKnowledgeSource	Configuração para a fonte de conhecimento do Fabric Data Agent.
FabricDataAgentKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do Fabric Data Agent.
FabricOntologyKnowledgeSource	Configuração para a fonte de conhecimento do Fabric Ontology.
FabricOntologyKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento sobre Fabric Ontology.
FileKnowledgeSource	Configuração para fonte de conhecimento de arquivos que suporta upload direto e indexação de arquivos.
FileKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do arquivo.
FreshnessPolicy	Configuração para recuperação consciente da frescura. Quando definidos, documentos mais recentes recebem um aumento de classificação durante a recuperação.
IndexedOneLakeKnowledgeSource	Configuração para a fonte de conhecimento do OneLake.
IndexedOneLakeKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do OneLake.
IndexedSharePointContainerName	Especifica quais bibliotecas do SharePoint acessar.
IndexedSharePointKnowledgeSource	Configuração para a fonte de conhecimento do SharePoint.
IndexedSharePointKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do SharePoint.
IndexedSqlKnowledgeSource	Configuração para fonte de conhecimento SQL indexada.
IndexedSqlKnowledgeSourceParameters	Parâmetros para fonte de conhecimento SQL indexada.
IndexingSchedule	Representa um agendamento para a execução do indexador.
KnowledgeBaseAzureOpenAIModel	Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consulta.
KnowledgeBaseModelKind	O modelo de IA a ser usado para planejamento de consulta.
KnowledgeSourceAzureOpenAIVectorizer	Especifica o recurso OpenAI do Azure usado para vetorizar uma cadeia de caracteres de consulta.
KnowledgeSourceIngestionParameters	Consolida todas as configurações gerais de ingestão para fontes de conhecimento.
KnowledgeSourceIngestionPermissionOption	Tipos de permissão para ingerir junto com o conteúdo do documento.
KnowledgeSourceKind	O tipo de fonte de conhecimento.
KnowledgeSourceNetworkAccessMode	Especifica o modo de acesso à rede para a ingestão de fontes de conhecimento. O padrão é 'público'.
KnowledgeSourceResultsProcessing	Controle se os resultados de uma fonte de conhecimento são reclassificados.
McpServerAuthenticationKind	O tipo de autenticação para um servidor MCP.
McpServerAutoOutputParsing	Detecte automaticamente o formato de saída e analise de acordo.
McpServerFoundryConnectionAuthentication	Autenticação usando uma conexão Fábrica de IA do Azure.
McpServerFoundryConnectionParameters	Parâmetros para autenticação de conexão com Foundry.
McpServerJsonOutputParsing	Analise a saída como um documento JSON usando os parâmetros JSON configurados.
McpServerKnowledgeSource	Configuração para uma fonte de conhecimento respaldada por um servidor MCP (Model Context Protocol).
McpServerKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento de um servidor MCP.
McpServerNoneOutputParsing	Trate a saída como um único bloco sem nenhum processamento sintácico.
McpServerOutputParsingJsonParameters	Parâmetros para análise sintática de saída JSON.
McpServerOutputParsingKind	O tipo de análise de saída para uma ferramenta de servidor MCP.
McpServerOutputParsingSplitParameters	Parâmetros para análise sintática de saída dividida.
McpServerSplitOutputParsing	Divida a saída em páginas usando os parâmetros de divisão configurados.
McpServerStoredHeadersAuthentication	Autenticação usando cabeçalhos HTTP armazenados.
McpServerStoredHeadersParameters	Parâmetros para autenticação de cabeçalhos armazenados.
McpServerTool	Representa uma única ferramenta dentro de uma fonte de conhecimento de servidor MCP.
RemoteSharePointKnowledgeSource	Configuração para fonte de conhecimento remota do SharePoint.
RemoteSharePointKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento remota do SharePoint.
SearchIndexerDataNoneIdentity	Limpa a propriedade de identidade de uma fonte de dados.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade de uma fonte de dados a ser usada.
SearchIndexFieldReference	Referência de campo para um índice de busca.
SearchIndexKnowledgeSource	Fonte de conhecimento direcionada a um índice de pesquisa.
SearchIndexKnowledgeSourceBoostKind	O tipo de dica de impulso para uma fonte de conhecimento de índice de busca.
SearchIndexKnowledgeSourceFieldValueBoost	Uma dica que impulsiona documentos com base no valor de um campo.
SearchIndexKnowledgeSourceFilterHint	Uma dica que identifica um campo e valores representativos que o planejador de consultas pode usar ao construir um filtro.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Uma dica que melhora documentos com base em uma expressão de várias palavras.
SearchIndexKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do índice de pesquisa.
SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planejamento de consultas para filtros úteis e reforços para uma fonte de conhecimento de índice de busca.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.
SplitSkillLanguage	Os códigos de idioma com suporte para texto de entrada por SplitSkill.
TextSplitMode	Um valor que indica qual modo de divisão executar.
VectorSearchVectorizerKind	O método de vetorização a ser usado durante o tempo de consulta.
WebKnowledgeSource	Fonte de conhecimento direcionando resultados da Web.
WebKnowledgeSourceDomain	Configuração para domínio de fonte de conhecimento da Web.
WebKnowledgeSourceDomains	Configuração de permissão/bloqueio de domínio para fonte de conhecimento da Web.
WebKnowledgeSourceParameters	Parâmetros para fonte de conhecimento da Web.
WorkIQKnowledgeSource	Configuração para fonte de conhecimento do WorkIQ.
WorkIQKnowledgeSourceParameters	Parâmetros para uma fonte de conhecimento do WorkIQ.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

AIServices

Objeto

Parâmetros para Serviços de IA.

Nome	Tipo	Description
apiKey	string	A chave de API para acessar os Serviços de IA.
uri	string (uri)	O URI do endpoint dos Serviços de IA.

AssetStore

Objeto

Configuração para um asset store usado para armazenar assets extraídos, como imagens.

Nome	Tipo	Description
connectionString	string	A cadeia de conexão para o asset store.
containerName	string	O nome do contêiner de blob dentro do asset store onde os assets extraídos (por exemplo, imagens) são armazenados.

AzureBlobKnowledgeSource

Objeto

Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	O tipo da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
kind	string: azureBlob	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

AzureBlobKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento do Armazenamento de Blobs do Azure.

Nome	Tipo	Valor padrão	Description
connectionString	string		Cadeia de conexão baseada em chave ou no formato ResourceId se estiver usando uma identidade gerenciada.
containerName	string		O nome do contêiner de armazenamento de blobs.
createdResources	object		Recursos criados pela fonte de conhecimento.
folderPath	string		Caminho de pasta opcional dentro do contêiner.
ingestionParameters	KnowledgeSourceIngestionParameters		Consolida todas as configurações gerais de ingestão.
isADLSGen2	boolean	False	Defina como true se estiver se conectando a uma conta de armazenamento do ADLS Gen2. O padrão é false.
queryHints	SearchIndexKnowledgeSourceQueryHints		Dicas padrão que orientam o planejamento de consultas para filtros úteis e reforços para essa fonte de conhecimento baseada em índices. Dicas de consulta em tempo de solicitação substituem esses padrões como um objeto completo.

AzureOpenAIModelName

Enumeração

O nome do modelo do Azure Open AI que será chamado.

Valor	Description
text-embedding-ada-002	TextEmbeddingAda002 modelo.
text-embedding-3-large	TextEmbedding3 Modelo grande.
text-embedding-3-small	TextEmbedding3Small modelo.
gpt-4o	Modelo GPT4o.
gpt-4o-mini	Modelo Gpt4oMini.
gpt-4.1	Modelo GPT41.
gpt-4.1-mini	Modelo GPT41Mini.
gpt-4.1-nano	Modelo GPT41Nano.
gpt-5	Modelo GPT5.
gpt-5-mini	Modelo Gpt5Mini.
gpt-5-nano	Modelo Gpt5Nano.
gpt-5.1	Modelo GPT51.
gpt-5.2	Modelo GPT52.
gpt-5.4	Modelo GPT54.
gpt-5.4-mini	Modelo Gpt54Mini.
gpt-5.4-nano	Modelo Gpt54Nano.
gpt-5.5	Modelo GPT55.
gpt-5.6-sol	Modelo Gpt56Sol.
gpt-5.6-terra	Modelo GPT56Terra.
gpt-5.6-luna	Modelo Gpt56Luna.

AzureOpenAIVectorizerParameters

Objeto

Especifica os parâmetros para se conectar ao recurso do Azure OpenAI.

Nome	Tipo	Description
apiKey	string	Chave de API do recurso Azure OpenAI designado.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída.
deploymentId	string	ID da implantação de modelo do Azure OpenAI no recurso designado.
modelName	AzureOpenAIModelName	O nome do modelo de inserção implantado no caminho deploymentId fornecido.
resourceUri	string (uri)	O URI do recurso do Azure OpenAI.

ContentColumnMapping

Objeto

Mapeia uma coluna SQL para um campo índice de busca.

Nome	Tipo	Description
name	string	Nome do campo do índice alvo.
searchFieldType	string	Tipo de campo Pesquisa de IA do Azure (por exemplo, Edm.String, Edm.Int32).
sourceField	string	Nome da coluna SQL.

CorsOptions

Objeto

Define opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para um índice.

Nome	Tipo	Description
allowedOrigins	string[]	A lista de origens das quais o código JavaScript terá acesso ao índice. Pode conter uma lista de hosts no formato {protocol}://{fully-qualified-domain-name}[:{port#}] ou um único '*' para permitir todas as origens (não recomendado).
maxAgeInSeconds	integer (int64)	A duração pela qual os navegadores devem armazenar em cache as respostas de comprovação do CORS. O padrão é 5 minutos.

EmbeddingColumnMapping

Objeto

Mapeia uma coluna SQL para um campo vetorial para embedding.

Nome	Tipo	Description
name	string	Nome do campo vetorial alvo no índice de busca.
sourceField	string	Coluna SQL usada como entrada para geração de embedding.

EntraAppAuthentication

Objeto

Configuração para um registro de aplicativo Microsoft Entra de propriedade do cliente, usado para autenticação baseada em credenciais federadas em nome de Trust.

Nome	Tipo	Description
applicationId	string (uuid)	O ID do aplicativo (cliente) do registro do aplicativo Entra, de propriedade do cliente.
federatedCredentialId	string (uuid)	O ID federado de credencial configurado no registro do app, permitindo que o serviço de busca autentique como o app sem um segredo de cliente armazenado.
tenantId	string (uuid)	O ID do inquilino do registro do app. É obrigatório quando o registro do aplicativo está em um tenant diferente do serviço de busca. Se omitido, o inquilino do serviço de busca é utilizado.

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Objeto

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FabricDataAgentKnowledgeSource

Objeto

Configuração para a fonte de conhecimento do Fabric Data Agent.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
fabricDataAgentParameters	FabricDataAgentKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do Fabric Data Agent.
kind	string: fabricDataAgent	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

FabricDataAgentKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento do Fabric Data Agent.

Nome	Tipo	Description
dataAgentId	string	Especifica qual Fabric Data Agent deve ser acessado.
workspaceId	string	ID de espaço de trabalho Fabric.

FabricOntologyKnowledgeSource

Objeto

Configuração para a fonte de conhecimento do Fabric Ontology.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
fabricOntologyParameters	FabricOntologyKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Fabric Ontology.
kind	string: fabricOntology	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

FabricOntologyKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento sobre Fabric Ontology.

Nome	Tipo	Description
ontologyId	string	O ID da ontologia a ser usada do espaço de trabalho Fabric.
workspaceId	string	O ID do espaço de trabalho Fabric contendo a ontologia.

FileKnowledgeSource

Objeto

Configuração para fonte de conhecimento de arquivos que suporta upload direto e indexação de arquivos.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
corsOptions	CorsOptions	Opções para controlar o Compartilhamento de Recursos de Origem Cruzada (CORS) para os endpoints de arquivo da fonte de conhecimento do arquivo (upload, listagem, atualização, exclusão).
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
fileParameters	FileKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do arquivo.
kind	string: file	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

FileKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento do arquivo.

Nome	Tipo	Description
createdResources	object	Recursos criados pela fonte de conhecimento do arquivo.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as configurações gerais de ingestão para a fonte de conhecimento do arquivo, incluindo o modo de extração de conteúdo e um embeddingModel opcional.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planejamento de consultas para filtros úteis e reforços para essa fonte de conhecimento baseada em índices. Dicas de consulta em tempo de solicitação substituem esses padrões como um objeto completo.

FreshnessPolicy

Objeto

Configuração para recuperação consciente da frescura. Quando definidos, documentos mais recentes recebem um aumento de classificação durante a recuperação.

Nome	Tipo	Description
boostingDuration	string	Duração ISO 8601 para a janela de aumento de frescura (por exemplo, 'P90D' por 90 dias). Documentos mais recentes que essa duração recebem um aumento de classificação durante a recuperação.

IndexedOneLakeKnowledgeSource

Objeto

Configuração para a fonte de conhecimento do OneLake.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	string: indexedOneLake	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

IndexedOneLakeKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento do OneLake.

Nome	Tipo	Description
createdResources	object	Recursos criados pela fonte de conhecimento.
fabricWorkspaceId	string	ID do espaço de trabalho do OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as configurações gerais de ingestão.
lakehouseId	string	Especifica qual lakehouse do OneLake acessar.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planejamento de consultas para filtros úteis e reforços para essa fonte de conhecimento baseada em índices. Dicas de consulta em tempo de solicitação substituem esses padrões como um objeto completo.
targetPath	string	Pasta ou atalho opcional do OneLakehouse para filtrar o conteúdo do OneLake.

IndexedSharePointContainerName

Enumeração

Especifica quais bibliotecas do SharePoint acessar.

Valor	Description
defaultSiteLibrary	Indexar o conteúdo da biblioteca de documentos padrão do site.
allSiteLibraries	Indexe o conteúdo de todas as bibliotecas de documentos do site.
useQuery	Use uma consulta para filtrar o conteúdo do SharePoint.

IndexedSharePointKnowledgeSource

Objeto

Configuração para a fonte de conhecimento do SharePoint.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	string: indexedSharePoint	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

IndexedSharePointKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento do SharePoint.

Nome	Tipo	Description
connectionString	string	Cadeia de conexão do SharePoint com formato: SharePointOnlineEndpoint=[URL do site do SharePoint]; ApplicationId=[ID do aplicativo Azure AD]; ApplicationSecret=[Segredo do cliente do aplicativo Azure AD]; TenantId=[ID do locatário do site do SharePoint]
containerName	IndexedSharePointContainerName	Especifica quais bibliotecas do SharePoint acessar.
createdResources	object	Recursos criados pela fonte de conhecimento.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as configurações gerais de ingestão.
query	string	Consulta opcional para filtrar o conteúdo do SharePoint.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planejamento de consultas para filtros úteis e reforços para essa fonte de conhecimento baseada em índices. Dicas de consulta em tempo de solicitação substituem esses padrões como um objeto completo.

IndexedSqlKnowledgeSource

Objeto

Configuração para fonte de conhecimento SQL indexada.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
indexedSqlParameters	IndexedSqlKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento SQL.
kind	string: indexedSql	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

IndexedSqlKnowledgeSourceParameters

Objeto

Parâmetros para fonte de conhecimento SQL indexada.

Nome	Tipo	Description
connectionString	string	A cadeia de conexão para o Banco de Dados SQL do Azure ou Instância Gerenciada de SQL.
contentColumns	ContentColumnMapping[]	Mapeamentos opcionais de colunas para campos de conteúdo. Se omitidas, todas as colunas são descobertas automaticamente.
createdResources	object	Recursos criados pela fonte de conhecimento.
embeddingColumns	EmbeddingColumnMapping[]	Mapeamentos opcionais de colunas para incorporar campos vetoriais. Se omitido, nenhum campo vetorial é criado.
highWaterMarkColumnName	string	Nome opcional de coluna para detecção de mudança de marca de água alta. Se fornecida, utiliza HighWaterMarkChangeDetectionPolicy.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as configurações gerais de ingestão, incluindo modelo de incorporação, cronograma e identidade.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planejamento de consultas para filtros úteis e reforços para essa fonte de conhecimento baseada em índices. Dicas de consulta em tempo de solicitação substituem esses padrões como um objeto completo.
tableOrView	string	O nome da tabela ou visualização para indexar. Pode ser qualificado por esquema (por exemplo, 'dbo. MyTable').

IndexingSchedule

Objeto

Representa um agendamento para a execução do indexador.

Nome	Tipo	Description
interval	string (duration)	O intervalo de tempo entre as execuções do indexador.
startTime	string (date-time)	A hora em que um indexador deve começar a ser executado.

KnowledgeBaseAzureOpenAIModel

Objeto

Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consulta.

Nome	Tipo	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI.
kind	string: azureOpenAI	O modelo de IA a ser usado para planejamento de consulta.

KnowledgeBaseModelKind

Enumeração

O modelo de IA a ser usado para planejamento de consulta.

Valor	Description
azureOpenAI	Use modelos de IA aberta do Azure para planejamento de consulta.

KnowledgeSourceAzureOpenAIVectorizer

Objeto

Especifica o recurso OpenAI do Azure usado para vetorizar uma cadeia de caracteres de consulta.

Nome	Tipo	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Contém os parâmetros específicos para a vetorização de inserção do OpenAI do Azure.
kind	string: azureOpenAI	O nome do tipo de método de vetorização que está sendo configurado para uso com a pesquisa vetorial.

KnowledgeSourceIngestionParameters

Objeto

Consolida todas as configurações gerais de ingestão para fontes de conhecimento.

Nome	Tipo	Valor padrão	Description
aiServices	AIServices		Configuração opcional de serviços de IA para processamento de conteúdo.
assetStore	AssetStore		Configuração opcional de armazenamento de ativos para armazenar ativos extraídos, como imagens.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Modelo opcional de conclusão de bate-papo para verbalização de imagem ou extração de contexto.
contentExtractionMode	enum: minimal standard	minimal	Modo de extração de conteúdo opcional. O padrão é 'mínimo'.
disableImageVerbalization	boolean	False	Indica se a verbalização da imagem deve ser desativada. O padrão é false.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Configuração de vetorizador opcional para vetorizar conteúdo.
freshnessPolicy	FreshnessPolicy		Política opcional de atualização para viés na recuperação em direção a documentos mais recentes.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Uma identidade explícita a ser usada para essa fonte de conhecimento.
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		Lista opcional de tipos de permissão a serem assimilados junto com o conteúdo do documento. Se especificado, ele definirá as opções de permissão do indexador para a fonte de dados.
ingestionSchedule	IndexingSchedule		Agendamento opcional para ingestão de dados.
networkAccessMode	KnowledgeSourceNetworkAccessMode	public	Modo opcional de acesso à rede para ingestão. Defina para 'privado' para executar a ingestão em um ambiente de execução privada que possa alcançar fontes de dados e dependências por meio de uma rede privada. O padrão é 'público'. Esta é uma configuração de criação e não pode ser alterada após a criação da fonte de conhecimento.

KnowledgeSourceIngestionPermissionOption

Enumeração

Tipos de permissão para ingerir junto com o conteúdo do documento.

Valor	Description
userIds	Ingerir identificadores de usuário explícitos junto com o conteúdo do documento.
groupIds	Ingerir identificadores de grupo junto com o conteúdo do documento.
rbacScope	Ingira informações do escopo do RBAC junto com o conteúdo do documento.
sensitivityLabels	Ingera os rótulos de sensibilidade do Microsoft Purview junto com o conteúdo do documento.

KnowledgeSourceKind

Enumeração

O tipo de fonte de conhecimento.

Valor	Description
searchIndex	Uma fonte de conhecimento que lê dados de um Índice de Pesquisa.
azureBlob	Uma fonte de conhecimento que lê e ingere dados do Armazenamento de Blobs do Azure em um Índice de Pesquisa.
indexedSharePoint	Uma fonte de conhecimento que lê dados do SharePoint indexado.
indexedOneLake	Uma fonte de conhecimento que lê dados do OneLake indexado.
indexedSql	Uma fonte de conhecimento que recupera e ingere dados do Banco de Dados SQL do Azure ou Instância Gerenciada de SQL para um Índice de Busca.
web	Uma fonte de conhecimento que lê dados da web.
remoteSharePoint	Uma fonte de conhecimento que lê dados do SharePoint remoto.
workIQ	Uma fonte de conhecimento que lê dados do QI no trabalho
file	Uma fonte de conhecimento que suporta upload direto de arquivos e indexação.
mcpServer	Uma fonte de conhecimento respaldada por um servidor MCP (Model Context Protocol).
fabricDataAgent	Uma fonte de conhecimento que recupera dados de um Fabric Data Agent.
fabricOntology	Uma fonte de conhecimento que recupera dados das ontologias do Microsoft Fabric Ontology.

KnowledgeSourceNetworkAccessMode

Enumeração

Especifica o modo de acesso à rede para a ingestão de fontes de conhecimento. O padrão é 'público'.

Valor	Description
public	A ingestão roda no ambiente padrão de execução publicamente acessível. Este é o padrão.
private	A ingestão roda em um ambiente de execução privada para que possa alcançar fontes de dados e dependências por meio de uma rede privada (endpoint privado / link privado compartilhado).

KnowledgeSourceResultsProcessing

Enumeração

Controle se os resultados de uma fonte de conhecimento são reclassificados.

Valor	Description
rerank	Os resultados dessa fonte de conhecimento passam pelo pipeline de reclassificação. Esse é o comportamento padrão.
none	Os resultados dessa fonte de conhecimento contornam a reclassificação e preservam sua ordem subjacente.

McpServerAuthenticationKind

Enumeração

O tipo de autenticação para um servidor MCP.

Valor	Description
foundryConnection	Autentique usando uma conexão do Fábrica de IA do Azure.
storedHeaders	Autentique usando cabeçalhos HTTP armazenados.

McpServerAutoOutputParsing

Objeto

Detecte automaticamente o formato de saída e analise de acordo.

Nome	Tipo	Description
kind	string: auto	O tipo de análise de saída a aplicar.

McpServerFoundryConnectionAuthentication

Objeto

Autenticação usando uma conexão Fábrica de IA do Azure.

Nome	Tipo	Description
foundryConnectionParameters	McpServerFoundryConnectionParameters	Parâmetros para autenticação de conexão com Foundry.
kind	string: foundryConnection	O tipo de autenticação a usar.

McpServerFoundryConnectionParameters

Objeto

Parâmetros para autenticação de conexão com Foundry.

Nome	Tipo	Description
connectionId	string	O identificador de conexão Fábrica de IA do Azure.

McpServerJsonOutputParsing

Objeto

Analise a saída como um documento JSON usando os parâmetros JSON configurados.

Nome	Tipo	Description
jsonParameters	McpServerOutputParsingJsonParameters	Parâmetros para análise sintática de saída JSON. Exigido quando o tipo é 'json'.
kind	string: json	O tipo de análise de saída a aplicar.

McpServerKnowledgeSource

Objeto

Configuração para uma fonte de conhecimento respaldada por um servidor MCP (Model Context Protocol).

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
kind	string: mcpServer	O tipo da fonte de conhecimento.
mcpServerParameters	McpServerKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do servidor MCP.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

McpServerKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento de um servidor MCP.

Nome	Tipo	Description
authentication	McpServerAuthentication: McpServerFoundryConnectionAuthentication McpServerStoredHeadersAuthentication	A configuração de autenticação para o servidor MCP.
serverURL	string	A URL do endpoint do servidor MCP.
tools	McpServerTool[]	A lista de ferramentas para invocar no servidor MCP.

McpServerNoneOutputParsing

Objeto

Trate a saída como um único bloco sem nenhum processamento sintácico.

Nome	Tipo	Description
kind	string: none	O tipo de análise de saída a aplicar.

McpServerOutputParsingJsonParameters

Objeto

Parâmetros para análise sintática de saída JSON.

Nome	Tipo	Description
documentsPath	string	O caminho JSON para o array de documentos na saída da ferramenta.
includeContext	boolean	Se deve incluir o contexto ao redor da saída JSON junto com documentos extraídos.

McpServerOutputParsingKind

Enumeração

O tipo de análise de saída para uma ferramenta de servidor MCP.

Valor	Description
auto	Detecte automaticamente o formato de saída e analise de acordo.
json	Analise a saída como um documento JSON usando os parâmetros JSON configurados.
split	Divida a saída em páginas usando os parâmetros de divisão configurados.
none	Trate a saída como um único bloco sem nenhum processamento sintácico.

McpServerOutputParsingSplitParameters

Objeto

Parâmetros para análise sintática de saída dividida.

Nome	Tipo	Description
defaultLanguageCode	SplitSkillLanguage	Um valor que indica qual código de idioma usar. O padrão é `en`.
maximumPageLength	integer (int32)	O número máximo de caracteres por página.
maximumPagesToTake	integer (int32)	O número máximo de páginas a serem retiradas da saída.
pageOverlapLength	integer (int32)	O número de caracteres a sobrepor entre as páginas.
textSplitMode	TextSplitMode	O modo de divisão de texto para usar.

McpServerSplitOutputParsing

Objeto

Divida a saída em páginas usando os parâmetros de divisão configurados.

Nome	Tipo	Description
kind	string: split	O tipo de análise de saída a aplicar.
splitParameters	McpServerOutputParsingSplitParameters	Parâmetros para análise sintática de saída dividida.

McpServerStoredHeadersAuthentication

Objeto

Autenticação usando cabeçalhos HTTP armazenados.

Nome	Tipo	Description
kind	string: storedHeaders	O tipo de autenticação a usar.
storedHeadersParameters	McpServerStoredHeadersParameters	Parâmetros para autenticação de cabeçalhos armazenados.

McpServerStoredHeadersParameters

Objeto

Parâmetros para autenticação de cabeçalhos armazenados.

Nome	Tipo	Description
headers	object	Os cabeçalhos HTTP armazenados para incluir em requisições do servidor MCP.

McpServerTool

Objeto

Representa uma única ferramenta dentro de uma fonte de conhecimento de servidor MCP.

Nome	Tipo	Description
maxOutputTokens	integer (int32)	Limite opcional de token pós-análise para a saída desta ferramenta. Deve ser maior que 0 quando especificado.
name	string	O nome da ferramenta MCP a ser invocada.
outputParsing	McpServerOutputParsing: McpServerAutoOutputParsing McpServerJsonOutputParsing McpServerNoneOutputParsing McpServerSplitOutputParsing	Configuração opcional para análise da saída da ferramenta.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados analisados dessa ferramenta são reclassificados. O padrão é 'reranqueado' quando não especificado.

RemoteSharePointKnowledgeSource

Objeto

Configuração para fonte de conhecimento remota do SharePoint.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
kind	string: remoteSharePoint	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	Os parâmetros para a fonte remota de conhecimento do SharePoint.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.

RemoteSharePointKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento remota do SharePoint.

Nome	Tipo	Description
containerTypeId	string	ID do contêiner para conexão do SharePoint Embedded. Quando isso for nulo, ele usará o SharePoint Online.
filterExpression	string	Expressão KQL (Linguagem de Consulta de Palavra-chave) com propriedades e atributos do SharePoint consultáveis para definir o escopo da recuperação antes da execução da consulta.
resourceMetadata	string[]	Uma lista de campos de metadados a serem retornados para cada item na resposta. Somente propriedades de metadados recuperáveis podem ser incluídas nesta lista. Por padrão, nenhum metadado é retornado.

SearchIndexerDataNoneIdentity

Objeto

Limpa a propriedade de identidade de uma fonte de dados.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Objeto

Especifica a identidade de uma fonte de dados a ser usada.

Nome	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI especificando o tipo de identidade.
federatedIdentityClientId	string	Suporte a Identidade Gerenciada User-Assigned Multi-Inquilino: O ID do cliente do aplicativo multi-tentante que foi configurado para federar com a identidade gerenciada atribuída pelo usuário.
userAssignedIdentity	string	A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída pelo usuário normalmente no formato "/subscriptions/12345678-1234-1234-12334-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchIndexFieldReference

Objeto

Referência de campo para um índice de busca.

Nome	Tipo	Description
name	string	O nome do campo.

SearchIndexKnowledgeSource

Objeto

Fonte de conhecimento direcionada a um índice de pesquisa.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
kind	string: searchIndex	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.

SearchIndexKnowledgeSourceBoostKind

Enumeração

O tipo de dica de impulso para uma fonte de conhecimento de índice de busca.

Valor	Description
fieldValue	Impulsione documentos com base no valor de um campo.
multiWordExpression	Impulsione documentos baseados em uma expressão de várias palavras.

SearchIndexKnowledgeSourceFieldValueBoost

Objeto

Uma dica que impulsiona documentos com base no valor de um campo.

Nome	Tipo	Description
boost	number (double)	Um multiplicador para a pontuação do documento. Deve ser um número positivo não igual a 1,0.
boostInstructions	string	Instruções em linguagem natural que explicam quando e como aplicar o impulso.
field	string minLength: 1	O nome do campo índice de busca.
fieldValues	string[]	Valores representativos para o campo.
kind	string: fieldValue	Aquele tipo de dica de impulso.

SearchIndexKnowledgeSourceFilterHint

Objeto

Uma dica que identifica um campo e valores representativos que o planejador de consultas pode usar ao construir um filtro.

Nome	Tipo	Description
field	string minLength: 1	O nome do campo índice de busca filtrável.
fieldValues	string[]	Valores representativos para o campo.
filterInstructions	string	Instruções em linguagem natural que explicam quando e como filtrar no campo.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Objeto

Uma dica que melhora documentos com base em uma expressão de várias palavras.

Nome	Tipo	Description
boost	number (double)	Um multiplicador para a pontuação do documento. Deve ser um número positivo não igual a 1,0.
boostInstructions	string	Instruções em linguagem natural que explicam quando e como aplicar o impulso.
fieldValues	string[]	Valores representativos para o impulso.
kind	string: multiWordExpression	Aquele tipo de dica de impulso.

SearchIndexKnowledgeSourceParameters

Objeto

Parâmetros para a fonte de conhecimento do índice de pesquisa.

Nome	Tipo	Description
baseFilter	string	Uma condição padrão de filtro aplicada ao índice no momento da recuperação (por exemplo, 'State EQ VA'). Pode ser sobrescrito no momento da consulta por meio de parâmetros de runtime da fonte de conhecimento.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planejamento de consultas para filtros úteis e reforços para essa fonte de conhecimento do índice de busca. Dicas de consulta em tempo de solicitação substituem esses padrões como um objeto completo.
searchFields	SearchIndexFieldReference[]	Usado para restringir quais campos pesquisar no índice de pesquisa.
searchIndexName	string	O nome do índice de pesquisa.
semanticConfigurationName	string	Usado para especificar uma configuração semântica diferente no índice de pesquisa de destino diferente do padrão.
sourceDataFields	SearchIndexFieldReference[]	Usado para solicitar campos adicionais para dados de origem referenciados.

SearchIndexKnowledgeSourceQueryHints

Objeto

Dicas que orientam o planejamento de consultas para filtros úteis e reforços para uma fonte de conhecimento de índice de busca.

Nome	Tipo	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Impulsione dicas que identificam condições que o planejador de consultas pode usar para influenciar o ranking do documento.
filters	SearchIndexKnowledgeSourceFilterHint[]	Dicas de filtro que identificam campos e valores representativos que o planejador de consultas pode usar ao construir filtros.

SearchResourceEncryptionKey

Objeto

Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

Nome	Tipo	Valor padrão	Description
accessCredentials.applicationId	string		Uma ID de aplicativo do AAD que recebeu as permissões de acesso necessárias para o Azure Key Vault que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto para seu aplicativo do AAD.
accessCredentials.applicationSecret	string		A chave de autenticação do aplicativo AAD especificado.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída pelo sistema será usada. Ao atualizar para o recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo.
isServiceLevelKey	boolean	False	Um valor opcional indicando se essa chave é uma chave de nível de serviço. O padrão é false.
keyVaultKeyName	string		O nome da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string		A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.
keyVaultUri	string		O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um URI de exemplo pode ser `https://my-keyvault-name.vault.azure.net`.

SplitSkillLanguage

Enumeração

Os códigos de idioma com suporte para texto de entrada por SplitSkill.

Valor	Description
am	Amharic
bs	Bosnian
cs	Tcheco
da	Dinamarquês
de	German
en	Inglês
es	Spanish
et	Estonian
fi	Finlandês
fr	French
he	Hebraico
hi	Hindi
hr	Croatian
hu	Húngaro
id	Indonesian
is	Icelandic
it	Italian
ja	Japanese
ko	Korean
lv	Letão
nb	Norueguês
nl	Holandês
pl	Polonês
pt	Português (Portugal)
pt-br	Português (Brasil)
ru	Russian
sk	Slovak
sl	Esloveno
sr	Sérvio
sv	Sueco
tr	Turco
ur	urdu
zh	Chinês (simplificado)

TextSplitMode

Enumeração

Um valor que indica qual modo de divisão executar.

Valor	Description
pages	Divida o texto em páginas individuais.
sentences	Divida o texto em frases individuais.

VectorSearchVectorizerKind

Enumeração

O método de vetorização a ser usado durante o tempo de consulta.

Valor	Description
azureOpenAI	Gere inserções usando um recurso do Azure OpenAI no momento da consulta.
customWebApi	Gere inserções usando um ponto de extremidade da Web personalizado no momento da consulta.
aiServicesVision	Gere inserções para uma entrada de imagem ou texto no momento da consulta usando a API de Vetorização da Visão dos Serviços de IA do Azure.
aml	Gere inserções usando um ponto de extremidade do Azure Machine Learning implantado por meio do Catálogo de Modelos do Fábrica de IA do Azure no momento da consulta.

WebKnowledgeSource

Objeto

Fonte de conhecimento direcionando resultados da Web.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
kind	string: web	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.
webParameters	WebKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Web.

WebKnowledgeSourceDomain

Objeto

Configuração para domínio de fonte de conhecimento da Web.

Nome	Tipo	Description
address	string	O endereço do domínio.
includeSubpages	boolean	Incluir ou não subpáginas deste domínio.

WebKnowledgeSourceDomains

Objeto

Configuração de permissão/bloqueio de domínio para fonte de conhecimento da Web.

Nome	Tipo	Description
allowedDomains	WebKnowledgeSourceDomain[]	Domínios que são permitidos para resultados web.
blockedDomains	WebKnowledgeSourceDomain[]	Domínios que são bloqueados nos resultados da web.

WebKnowledgeSourceParameters

Objeto

Parâmetros para fonte de conhecimento da Web.

Nome	Tipo	Description
count	integer (int32)	O número padrão de resultados da web a serem retornados. Pode ser sobrescrito no momento da consulta por meio de parâmetros de runtime da fonte de conhecimento.
domains	WebKnowledgeSourceDomains	Configuração de permissão/bloqueio de domínio para resultados da Web.
freshness	string	O filtro padrão de frescura para resultados web. Pode ser sobrescrito no momento da consulta por meio de parâmetros de runtime da fonte de conhecimento.
language	string	O idioma padrão para resultados web. Pode ser sobrescrito no momento da consulta por meio de parâmetros de runtime da fonte de conhecimento.
market	string	O mercado padrão para resultados na web. Pode ser sobrescrito no momento da consulta por meio de parâmetros de runtime da fonte de conhecimento.

WorkIQKnowledgeSource

Objeto

Configuração para fonte de conhecimento do WorkIQ.

Nome	Tipo	Description
@odata.etag	string	O ETag da fonte de conhecimento.
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição da sua fonte de conhecimento quando você quer total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografá-las. Depois que você criptografou sua definição de fonte de conhecimento, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de fonte de conhecimento não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em 1º de janeiro de 2019 ou depois de 1º de janeiro de 2019.
kind	string: workIQ	O tipo da fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados dessa fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. O padrão é 'reranqueado' quando não especificado.
workIQParameters	WorkIQKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do WorkIQ, incluindo a configuração do aplicativo Entra, de propriedade do cliente, usada para autenticação em nome do cliente.

WorkIQKnowledgeSourceParameters

Objeto

Parâmetros para uma fonte de conhecimento do WorkIQ.

Nome	Tipo	Description
entraAppAuthentication	EntraAppAuthentication	A configuração de registro do aplicativo Microsoft Entra, de propriedade do cliente, é usada para autenticação em nome da API Work IQ. O cliente registra um aplicativo Entra de propriedade do locatário, concede a ele a permissão delegada WorkIQAgent.Ask e configura uma credencial federada para que o Pesquisa de IA do Azure possa se autenticar como esse app sem um segredo de cliente armazenado.