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 do URI

Name	Em	Obrigatório	Tipo	Descrição
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 utilizar para esta operação.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
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 do Pedido

O corpo de pedido pode ser um dos seguintes:

Name	Descrição
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 da Fabric Ontology.
FileKnowledgeSource	Configuração para fonte de conhecimento de ficheiro que suporta upload e indexação direta de ficheiros.
IndexedOneLakeKnowledgeSource	Configuração para a fonte de conhecimento do OneLake.
IndexedSharePointKnowledgeSource	Configuração para fonte de conhecimento do SharePoint.
IndexedSqlKnowledgeSource	Configuração para a fonte de conhecimento SQL indexada.
McpServerKnowledgeSource	Configuração para uma fonte de conhecimento apoiada 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 direcionada para resultados da Web.
WorkIQKnowledgeSource	Configuração para a fonte de conhecimento do WorkIQ.

AzureBlobKnowledgeSource

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

Name	Obrigatório	Tipo	Descrição
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	O tipo de fonte de conhecimento.
kind	True	string: azureBlob	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

FabricDataAgentKnowledgeSource

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

Name	Obrigatório	Tipo	Descrição
fabricDataAgentParameters	True	FabricDataAgentKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do Fabric Data Agent.
kind	True	string: fabricDataAgent	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

FabricOntologyKnowledgeSource

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

Name	Obrigatório	Tipo	Descrição
fabricOntologyParameters	True	FabricOntologyKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Fabric Ontology.
kind	True	string: fabricOntology	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

FileKnowledgeSource

Configuração para fonte de conhecimento de ficheiro que suporta upload e indexação direta de ficheiros.

Name	Obrigatório	Tipo	Descrição
fileParameters	True	FileKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do ficheiro.
kind	True	string: file	O tipo de 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 a Partilha de Recursos entre Origens (CORS) para os endpoints do ficheiro da fonte de conhecimento do ficheiro (upload, listagem, atualização, eliminação).
description		string	Descrição opcional definida pelo usuário.
encryptionKey		SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

IndexedOneLakeKnowledgeSource

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

Name	Obrigatório	Tipo	Descrição
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	True	string: indexedOneLake	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

IndexedSharePointKnowledgeSource

Configuração para fonte de conhecimento do SharePoint.

Name	Obrigatório	Tipo	Descrição
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	True	string: indexedSharePoint	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

IndexedSqlKnowledgeSource

Configuração para a fonte de conhecimento SQL indexada.

Name	Obrigatório	Tipo	Descrição
indexedSqlParameters	True	IndexedSqlKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento SQL.
kind	True	string: indexedSql	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

McpServerKnowledgeSource

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

Name	Obrigatório	Tipo	Descrição
kind	True	string: mcpServer	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

RemoteSharePointKnowledgeSource

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

Name	Obrigatório	Tipo	Descrição
kind	True	string: remoteSharePoint	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	Os parâmetros para a fonte remota de conhecimento do SharePoint.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

SearchIndexKnowledgeSource

Fonte de conhecimento direcionada a um índice de pesquisa.

Name	Obrigatório	Tipo	Descrição
kind	True	string: searchIndex	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

WebKnowledgeSource

Fonte de conhecimento direcionada para resultados da Web.

Name	Obrigatório	Tipo	Descrição
kind	True	string: web	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.
webParameters		WebKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Web.

WorkIQKnowledgeSource

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

Name	Obrigatório	Tipo	Descrição
kind	True	string: workIQ	O tipo de 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 da aplicação Entra, 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

Respostas

Name	Tipo	Descrição
201 Created	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

Name	Descrição
https://search.azure.com/.default

Exemplos

SearchServiceCreateKnowledgeSource

SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSourceFabricDataAgent

SearchServiceCreateKnowledgeSourceFabricOntology

SearchServiceCreateKnowledgeSourceFile

SearchServiceCreateKnowledgeSourceIndexedOneLake

SearchServiceCreateKnowledgeSourceIndexedSharePoint

SearchServiceCreateKnowledgeSourceIndexedSql

SearchServiceCreateKnowledgeSourceMcpServer

SearchServiceCreateKnowledgeSourceWeb

SearchServiceCreateKnowledgeSourceWorkIQ

SearchServiceCreateKnowledgeSource

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Descrição
Accept	O cabeçalho Aceitar.
AIServices	Parâmetros para Serviços de IA.
AssetStore	Configuração de 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 de IA aberta do Azure que será chamado.
AzureOpenAIVectorizerParameters	Especifica os parâmetros para se conectar ao recurso OpenAI do Azure.
ContentColumnMapping	Mapeia uma coluna SQL para um campo de índice de pesquisa.
CorsOptions	Define opções para controlar o CORS (Cross-Origin Resource Sharing) para um índice.
EmbeddingColumnMapping	Mapeia uma coluna SQL para um campo vetorial para embedding.
EntraAppAuthentication	Configuração para o registo de uma aplicação Microsoft Entra detida pelo cliente, usada para autenticação baseada em credenciais federadas em nome do cliente.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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 da Fabric Ontology.
FabricOntologyKnowledgeSourceParameters	Fonte de conhecimento sobre parâmetros para a Fabric Ontology.
FileKnowledgeSource	Configuração para fonte de conhecimento de ficheiro que suporta upload e indexação direta de ficheiros.
FileKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do ficheiro.
FreshnessPolicy	Configuração para recuperação consciente da frescura. Quando definidos, os 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 OneLake.
IndexedSharePointContainerName	Especifica quais bibliotecas SharePoint aceder.
IndexedSharePointKnowledgeSource	Configuração para fonte de conhecimento do SharePoint.
IndexedSharePointKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do SharePoint.
IndexedSqlKnowledgeSource	Configuração para a fonte de conhecimento SQL indexada.
IndexedSqlKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento SQL indexada.
IndexingSchedule	Representa uma agenda para a execução do indexador.
KnowledgeBaseAzureOpenAIModel	Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consultas.
KnowledgeBaseModelKind	O modelo de IA a ser usado para o planejamento de consultas.
KnowledgeSourceAzureOpenAIVectorizer	Especifica o recurso do Azure OpenAI 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 juntamente 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	Controla se os resultados de uma fonte de conhecimento são reclassificados.
McpServerAuthenticationKind	O tipo de autenticação para um servidor MCP.
McpServerAutoOutputParsing	Detetar automaticamente o formato de saída e analisar em conformidade.
McpServerFoundryConnectionAuthentication	Autenticação usando uma ligação Azure AI Foundry.
McpServerFoundryConnectionParameters	Parâmetros para autenticação de ligação Foundry.
McpServerJsonOutputParsing	Analise a saída como um documento JSON usando os parâmetros JSON configurados.
McpServerKnowledgeSource	Configuração para uma fonte de conhecimento apoiada por um servidor MCP (Model Context Protocol).
McpServerKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento de um servidor MCP.
McpServerNoneOutputParsing	Trata a saída como um único bloco sem qualquer análise sintática.
McpServerOutputParsingJsonParameters	Parâmetros para análise 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	Divide 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 da fonte de conhecimento de um servidor MCP.
RemoteSharePointKnowledgeSource	Configuração para fonte de conhecimento remota do SharePoint.
RemoteSharePointKnowledgeSourceParameters	Parâmetros para fonte de conhecimento remota do SharePoint.
SearchIndexerDataNoneIdentity	Limpa a propriedade identity de uma fonte de dados.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade a ser usada por uma fonte de dados.
SearchIndexFieldReference	Referência de campo para um índice de pesquisa.
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 pesquisa.
SearchIndexKnowledgeSourceFieldValueBoost	Uma dica que melhora documentos com base no valor de um campo.
SearchIndexKnowledgeSourceFilterHint	Uma dica que identifica um campo e valores representativos que o planeador de consultas pode usar ao construir um filtro.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Uma dica que melhora documentos com base numa expressão de várias palavras.
SearchIndexKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento do índice de pesquisa.
SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros úteis e reforços para uma fonte de conhecimento de índice de pesquisa.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Cofre de Chaves do Azure. 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 suportados 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 direcionada para resultados da Web.
WebKnowledgeSourceDomain	Configuração para domínio de origem de conhecimento web.
WebKnowledgeSourceDomains	Configuração de domínio permitir/bloquear para a fonte de conhecimento web.
WebKnowledgeSourceParameters	Parâmetros para a fonte de conhecimento web.
WorkIQKnowledgeSource	Configuração para a fonte de conhecimento do WorkIQ.
WorkIQKnowledgeSourceParameters	Parâmetros para uma fonte de conhecimento WorkIQ.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Descrição
application/json;odata.metadata=minimal

AIServices

Object

Parâmetros para Serviços de IA.

Name	Tipo	Descrição
apiKey	string	A chave API para aceder a Serviços de IA.
uri	string (uri)	O URI do endpoint de Serviços de IA.

AssetStore

Object

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

Name	Tipo	Descrição
connectionString	string	A cadeia de ligação para a asset store.
containerName	string	O nome do contentor de blob dentro do asset store onde os assets extraídos (por exemplo, imagens) são armazenados.

AzureBlobKnowledgeSource

Object

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

Name	Tipo	Descrição
@odata.etag	string	O ETag da fonte de conhecimento.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	O tipo de 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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
kind	string: azureBlob	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

AzureBlobKnowledgeSourceParameters

Object

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

Name	Tipo	Valor predefinido	Descrição
connectionString	string		Cadeia de conexão baseada em chave ou o formato ResourceId se estiver usando uma identidade gerenciada.
containerName	string		O nome do contêiner de armazenamento de blob.
createdResources	object		Recursos criados pela fonte de conhecimento.
folderPath	string		Caminho de pasta opcional dentro do contêiner.
ingestionParameters	KnowledgeSourceIngestionParameters		Consolida todas as definições gerais de ingestão.
isADLSGen2	boolean	False	Defina para verdadeiro se estiver a ligar a uma conta de armazenamento ADLS Gen2. O valor padrão é falso.
queryHints	SearchIndexKnowledgeSourceQueryHints		Dicas padrão que orientam o planeamento de consultas para filtros e reforços úteis para esta fonte de conhecimento baseada em índices. As dicas de consulta no momento do pedido substituem estes valores predefinidos como um objeto completo.

AzureOpenAIModelName

Enumeração

O nome do modelo de IA aberta do Azure que será chamado.

Valor	Descrição
text-embedding-ada-002	Modelo TextEmbeddingAda002.
text-embedding-3-large	TextEmbedding3 Modelo grande.
text-embedding-3-small	TextEmbedding3Small model.
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

Object

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

Name	Tipo	Descrição
apiKey	string	Chave de API do recurso OpenAI do Azure 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 do modelo OpenAI do Azure no recurso designado.
modelName	AzureOpenAIModelName	O nome do modelo de incorporação implantado no caminho deploymentId fornecido.
resourceUri	string (uri)	O URI do recurso Azure OpenAI.

ContentColumnMapping

Object

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

Name	Tipo	Descrição
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

Object

Define opções para controlar o CORS (Cross-Origin Resource Sharing) para um índice.

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

EmbeddingColumnMapping

Object

Mapeia uma coluna SQL para um campo vetorial para embedding.

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

EntraAppAuthentication

Object

Configuração para o registo de uma aplicação Microsoft Entra detida pelo cliente, usada para autenticação baseada em credenciais federadas em nome do cliente.

Name	Tipo	Descrição
applicationId	string (uuid)	O ID da aplicação (cliente) do registo da aplicação Entra, propriedade do cliente.
federatedCredentialId	string (uuid)	O ID de credencial federado configurado no registo da aplicação, permitindo que o serviço de pesquisa se autentique como a aplicação sem um segredo de cliente armazenado.
tenantId	string (uuid)	O ID do inquilino do registo da aplicação. É obrigatório quando o registo da aplicação está num tenant diferente do serviço de pesquisa. Se for omitido, o inquilino do serviço de pesquisa é utilizado.

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	As 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

Object

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

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

FabricDataAgentKnowledgeSource

Object

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

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
fabricDataAgentParameters	FabricDataAgentKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do Fabric Data Agent.
kind	string: fabricDataAgent	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

FabricDataAgentKnowledgeSourceParameters

Object

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

Name	Tipo	Descrição
dataAgentId	string	Especifica qual o Fabric Data Agent a aceder.
workspaceId	string	ID do espaço de trabalho Fabric.

FabricOntologyKnowledgeSource

Object

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

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
fabricOntologyParameters	FabricOntologyKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Fabric Ontology.
kind	string: fabricOntology	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

FabricOntologyKnowledgeSourceParameters

Object

Fonte de conhecimento sobre parâmetros para a Fabric Ontology.

Name	Tipo	Descrição
ontologyId	string	O ID da ontologia a usar a partir do espaço de trabalho Fabric.
workspaceId	string	O ID do espaço de trabalho Fabric contém a ontologia.

FileKnowledgeSource

Object

Configuração para fonte de conhecimento de ficheiro que suporta upload e indexação direta de ficheiros.

Name	Tipo	Descrição
@odata.etag	string	O ETag da fonte de conhecimento.
corsOptions	CorsOptions	Opções para controlar a Partilha de Recursos entre Origens (CORS) para os endpoints do ficheiro da fonte de conhecimento do ficheiro (upload, listagem, atualização, eliminação).
description	string	Descrição opcional definida pelo usuário.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
fileParameters	FileKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do ficheiro.
kind	string: file	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

FileKnowledgeSourceParameters

Object

Parâmetros para a fonte de conhecimento do ficheiro.

Name	Tipo	Descrição
createdResources	object	Recursos criados pela fonte de conhecimento do ficheiro.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as definições gerais de ingestão para a fonte de conhecimento do ficheiro, incluindo o modo de extração de conteúdo e um embeddingModel opcional.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planeamento de consultas para filtros e reforços úteis para esta fonte de conhecimento baseada em índices. As dicas de consulta no momento do pedido substituem estes valores predefinidos como um objeto completo.

FreshnessPolicy

Object

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

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

IndexedOneLakeKnowledgeSource

Object

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

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	string: indexedOneLake	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

IndexedOneLakeKnowledgeSourceParameters

Object

Parâmetros para a fonte de conhecimento OneLake.

Name	Tipo	Descrição
createdResources	object	Recursos criados pela fonte de conhecimento.
fabricWorkspaceId	string	ID do espaço de trabalho OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as definições gerais de ingestão.
lakehouseId	string	Especifica qual casa do lago OneLake deve ser acessada.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planeamento de consultas para filtros e reforços úteis para esta fonte de conhecimento baseada em índices. As dicas de consulta no momento do pedido substituem estes valores predefinidos 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 SharePoint aceder.

Valor	Descrição
defaultSiteLibrary	Indexe 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 conteúdos do SharePoint.

IndexedSharePointKnowledgeSource

Object

Configuração para fonte de conhecimento do SharePoint.

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento.
kind	string: indexedSharePoint	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

IndexedSharePointKnowledgeSourceParameters

Object

Parâmetros para a fonte de conhecimento do SharePoint.

Name	Tipo	Descrição
connectionString	string	String de ligação SharePoint com formato: SharePointOnlineEndpoint=[URL do site SharePoint]; ApplicationId=[Azure AD App ID]; ApplicationSecret=[Azure AD App client secret]; TenantId=[SharePoint site tenant id]
containerName	IndexedSharePointContainerName	Especifica quais bibliotecas SharePoint aceder.
createdResources	object	Recursos criados pela fonte de conhecimento.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as definições gerais de ingestão.
query	string	Consulta opcional para filtrar conteúdo do SharePoint.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planeamento de consultas para filtros e reforços úteis para esta fonte de conhecimento baseada em índices. As dicas de consulta no momento do pedido substituem estes valores predefinidos como um objeto completo.

IndexedSqlKnowledgeSource

Object

Configuração para a fonte de conhecimento SQL indexada.

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
indexedSqlParameters	IndexedSqlKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento SQL.
kind	string: indexedSql	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

IndexedSqlKnowledgeSourceParameters

Object

Parâmetros para a fonte de conhecimento SQL indexada.

Name	Tipo	Descrição
connectionString	string	A cadeia de ligação para o Base de Dados SQL do Azure ou SQL Managed Instance.
contentColumns	ContentColumnMapping[]	Mapeamentos opcionais de colunas para campos de conteúdo. Se omitida, 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 omitidos, não são criados campos vetoriais.
highWaterMarkColumnName	string	Nome opcional da coluna para deteção de alterações de marcas de alta margem. Se fornecida, utiliza HighWaterMarkChangeDetectionPolicy.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolida todas as definições gerais de ingestão, incluindo o modelo de incorporação, o horário e a identidade.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planeamento de consultas para filtros e reforços úteis para esta fonte de conhecimento baseada em índices. As dicas de consulta no momento do pedido substituem estes valores predefinidos como um objeto completo.
tableOrView	string	O nome da tabela ou vista a indexar. Pode ser qualificado por esquema (por exemplo, 'dbo. MyTable').

IndexingSchedule

Object

Representa uma agenda para a execução do indexador.

Name	Tipo	Descrição
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

Object

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

Name	Tipo	Descrição
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Parâmetros Azure OpenAI.
kind	string: azureOpenAI	O modelo de IA a ser usado para o planejamento de consultas.

KnowledgeBaseModelKind

Enumeração

O modelo de IA a ser usado para o planejamento de consultas.

Valor	Descrição
azureOpenAI	Use modelos de IA aberta do Azure para planejamento de consultas.

KnowledgeSourceAzureOpenAIVectorizer

Object

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

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

KnowledgeSourceIngestionParameters

Object

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

Name	Tipo	Valor predefinido	Descrição
aiServices	AIServices		Configuração opcional de Serviços de IA para processamento de conteúdo.
assetStore	AssetStore		Configuração opcional de asset store para armazenar assets extraídos, como imagens.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Modelo opcional de conclusão de chat 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 valor padrão é falso.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Configuração opcional do vetorizador para vetorização de conteúdo.
freshnessPolicy	FreshnessPolicy		Política opcional de atualização para enviesar a 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ões a ingerir juntamente 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		Horário 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 num ambiente de execução privada que possa aceder a fontes de dados e dependências através 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 juntamente com o conteúdo do documento.

Valor	Descrição
userIds	Ingerir identificadores de utilizador explícitos juntamente com o conteúdo do documento.
groupIds	Ingerir identificadores de grupo juntamente com o conteúdo do documento.
rbacScope	Ingerir a informação do âmbito do RBAC juntamente com o conteúdo do documento.
sensitivityLabels	Ingerir as etiquetas de sensibilidade da Microsoft Purview juntamente com o conteúdo do documento.

KnowledgeSourceKind

Enumeração

O tipo de fonte de conhecimento.

Valor	Descrição
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 para 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 Base de Dados SQL do Azure ou SQL Managed Instance para um Índice de Pesquisa.
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 de trabalho
file	Uma fonte de conhecimento que suporta o upload e indexação direta de ficheiros.
mcpServer	Uma fonte de conhecimento apoiada 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 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	Descrição
public	A ingestão corre no ambiente de execução padrão, acessível publicamente. Este é o padrão.
private	A ingestão corre num ambiente de execução privada para poder aceder a fontes de dados e dependências através de uma rede privada (endpoint privado / ligação privada partilhada).

KnowledgeSourceResultsProcessing

Enumeração

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

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

McpServerAuthenticationKind

Enumeração

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

Valor	Descrição
foundryConnection	Autentique usando uma ligação Azure AI Foundry.
storedHeaders	Autenticar usando cabeçalhos HTTP armazenados.

McpServerAutoOutputParsing

Object

Detetar automaticamente o formato de saída e analisar em conformidade.

Name	Tipo	Descrição
kind	string: auto	O tipo de análise de saída a aplicar.

McpServerFoundryConnectionAuthentication

Object

Autenticação usando uma ligação Azure AI Foundry.

Name	Tipo	Descrição
foundryConnectionParameters	McpServerFoundryConnectionParameters	Parâmetros para autenticação de ligação Foundry.
kind	string: foundryConnection	O tipo de autenticação a usar.

McpServerFoundryConnectionParameters

Object

Parâmetros para autenticação de ligação Foundry.

Name	Tipo	Descrição
connectionId	string	O identificador de ligação Azure AI Foundry.

McpServerJsonOutputParsing

Object

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

Name	Tipo	Descrição
jsonParameters	McpServerOutputParsingJsonParameters	Parâmetros para análise de saída JSON. É obrigatório quando o tipo é 'json'.
kind	string: json	O tipo de análise de saída a aplicar.

McpServerKnowledgeSource

Object

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

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
kind	string: mcpServer	O tipo de 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 desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

McpServerKnowledgeSourceParameters

Object

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

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

McpServerNoneOutputParsing

Object

Trata a saída como um único bloco sem qualquer análise sintática.

Name	Tipo	Descrição
kind	string: none	O tipo de análise de saída a aplicar.

McpServerOutputParsingJsonParameters

Object

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

Name	Tipo	Descrição
documentsPath	string	O caminho JSON para o array de documentos na saída da ferramenta.
includeContext	boolean	Se deve incluir o contexto circundante da saída JSON juntamente com documentos extraídos.

McpServerOutputParsingKind

Enumeração

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

Valor	Descrição
auto	Detetar automaticamente o formato de saída e analisar em conformidade.
json	Analise a saída como um documento JSON usando os parâmetros JSON configurados.
split	Divide a saída em páginas usando os parâmetros de divisão configurados.
none	Trata a saída como um único bloco sem qualquer análise sintática.

McpServerOutputParsingSplitParameters

Object

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

Name	Tipo	Descrição
defaultLanguageCode	SplitSkillLanguage	Um valor que indica qual código de idioma usar. A predefiniçã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 retirar da saída.
pageOverlapLength	integer (int32)	O número de caracteres a sobrepor entre páginas.
textSplitMode	TextSplitMode	O modo de divisão de texto para usar.

McpServerSplitOutputParsing

Object

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

Name	Tipo	Descrição
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

Object

Autenticação usando cabeçalhos HTTP armazenados.

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

McpServerStoredHeadersParameters

Object

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

Name	Tipo	Descrição
headers	object	Os cabeçalhos HTTP armazenados para incluir nos pedidos do servidor MCP.

McpServerTool

Object

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

Name	Tipo	Descrição
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 invocar.
outputParsing	McpServerOutputParsing: McpServerAutoOutputParsing McpServerJsonOutputParsing McpServerNoneOutputParsing McpServerSplitOutputParsing	Configuração opcional para analisar a saída da ferramenta.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados analisados desta ferramenta são reclassificados. Por defeito é 'reclassificado' quando não especificado.

RemoteSharePointKnowledgeSource

Object

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

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
kind	string: remoteSharePoint	O tipo de 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 desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.

RemoteSharePointKnowledgeSourceParameters

Object

Parâmetros para fonte de conhecimento remota do SharePoint.

Name	Tipo	Descrição
containerTypeId	string	ID do contentor para ligação embutida do SharePoint. Quando isso for nulo, ele usará o SharePoint Online.
filterExpression	string	Expressão KQL (Keyword Query Language) com propriedades e atributos do SharePoint consultáveis para definir o escopo da recuperação antes que a consulta seja executada.
resourceMetadata	string[]	Uma lista de campos de metadados a serem retornados para cada item na resposta. Apenas propriedades de metadados recuperáveis podem ser incluídas nesta lista. Por defeito, não são devolvidos metadados.

SearchIndexerDataNoneIdentity

Object

Limpa a propriedade identity de uma fonte de dados.

Name	Tipo	Descrição
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Object

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

Name	Tipo	Descrição
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI especificando o tipo de identidade.
federatedIdentityClientId	string	Multi-tenant User-Assigned Managed Identity Support: O id do cliente da aplicação multi-tentant que foi configurada para federar com a identidade gerida atribuída pelo utilizador.
userAssignedIdentity	string	A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchIndexFieldReference

Object

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

Name	Tipo	Descrição
name	string	O nome do campo.

SearchIndexKnowledgeSource

Object

Fonte de conhecimento direcionada a um índice de pesquisa.

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
kind	string: searchIndex	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' 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 pesquisa.

Valor	Descrição
fieldValue	Impulsione documentos com base num valor de campo.
multiWordExpression	Impulsione documentos com base numa expressão de várias palavras.

SearchIndexKnowledgeSourceFieldValueBoost

Object

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

Name	Tipo	Descrição
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 pesquisa.
fieldValues	string[]	Valores representativos para o campo.
kind	string: fieldValue	O tipo de dica de boost.

SearchIndexKnowledgeSourceFilterHint

Object

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

Name	Tipo	Descrição
field	string minLength: 1	O nome do campo de índice de pesquisa 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

Object

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

Name	Tipo	Descrição
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	O tipo de dica de boost.

SearchIndexKnowledgeSourceParameters

Object

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

Name	Tipo	Descrição
baseFilter	string	Uma condição padrão de filtro aplicada ao índice na altura da recuperação (por exemplo, 'State EQ VA'). Pode ser sobreposto na altura da consulta através de parâmetros de execução da fonte de conhecimento.
queryHints	SearchIndexKnowledgeSourceQueryHints	Dicas padrão que orientam o planeamento das consultas para filtros úteis e reforços para esta fonte de conhecimento do índice de pesquisa. As dicas de consulta no momento do pedido substituem estes valores predefinidos como um objeto completo.
searchFields	SearchIndexFieldReference[]	Usado para restringir que 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 da padrão.
sourceDataFields	SearchIndexFieldReference[]	Usado para solicitar campos adicionais para dados de origem referenciados.

SearchIndexKnowledgeSourceQueryHints

Object

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

Name	Tipo	Descrição
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Impulsione dicas que identificam condições que o planeador de consultas pode usar para influenciar a classificação dos documentos.
filters	SearchIndexKnowledgeSourceFilterHint[]	Dicas de filtro que identificam campos e valores representativos que o planeador de consultas pode usar ao construir filtros.

SearchResourceEncryptionKey

Object

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

Name	Tipo	Valor predefinido	Descrição
accessCredentials.applicationId	string		Uma ID de Aplicativo AAD que recebeu as permissões de acesso necessárias ao Cofre da Chave do Azure que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto do seu aplicativo 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 ao sistema será usada. Na atualização do 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 que indica se esta chave é uma chave de nível de serviço. O valor padrão é falso.
keyVaultKeyName	string		O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string		A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultUri	string		O URI do seu Cofre da Chave do Azure, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser `https://my-keyvault-name.vault.azure.net`.

SplitSkillLanguage

Enumeração

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

Valor	Descrição
am	Amárico
bs	Bósnio
cs	Checo
da	Dinamarquês
de	German
en	English
es	Spanish
et	Estónio
fi	Finlandês
fr	French
he	Hebraico
hi	Híndi
hr	Croata
hu	Húngaro
id	Indonesian
is	Islandês
it	Italian
ja	Japanese
ko	Korean
lv	Letão
nb	Norueguês
nl	Neerlandês
pl	Polaco
pt	Português (Portugal)
pt-br	Português (Brasil)
ru	Russian
sk	Eslovaco
sl	Esloveno
sr	Sérvio
sv	Sueco
tr	Turco (língua)
ur	Língua Urdu
zh	Chinês (simplificado)

TextSplitMode

Enumeração

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

Valor	Descrição
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	Descrição
azureOpenAI	Gere incorporações usando um recurso do Azure OpenAI no momento da consulta.
customWebApi	Gere incorporações usando um ponto de extremidade da Web personalizado no momento da consulta.
aiServicesVision	Gere incorporações para uma entrada de imagem ou texto no momento da consulta usando a API de Vetorização de Visão dos Serviços de IA do Azure.
aml	Gere incorporações usando um ponto de extremidade do Azure Machine Learning implantado por meio do Catálogo de Modelo do Azure AI Foundry no momento da consulta.

WebKnowledgeSource

Object

Fonte de conhecimento direcionada para resultados da Web.

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
kind	string: web	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.
webParameters	WebKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento da Web.

WebKnowledgeSourceDomain

Object

Configuração para domínio de origem de conhecimento web.

Name	Tipo	Descrição
address	string	O endereço do domínio.
includeSubpages	boolean	Se deve ou não incluir subpáginas deste domínio.

WebKnowledgeSourceDomains

Object

Configuração de domínio permitir/bloquear para a fonte de conhecimento web.

Name	Tipo	Descrição
allowedDomains	WebKnowledgeSourceDomain[]	Domínios que são permitidos para resultados web.
blockedDomains	WebKnowledgeSourceDomain[]	Domínios bloqueados de resultados web.

WebKnowledgeSourceParameters

Object

Parâmetros para a fonte de conhecimento web.

Name	Tipo	Descrição
count	integer (int32)	O número padrão de resultados web a devolver. Pode ser sobreposto na altura da consulta através de parâmetros de execução da fonte de conhecimento.
domains	WebKnowledgeSourceDomains	Configuração de domínio/bloqueio para resultados da Web.
freshness	string	O filtro padrão de frescura para resultados web. Pode ser sobreposto na altura da consulta através de parâmetros de execução da fonte de conhecimento.
language	string	A linguagem padrão para resultados web. Pode ser sobreposto na altura da consulta através de parâmetros de execução da fonte de conhecimento.
market	string	O mercado padrão para resultados web. Pode ser sobreposto na altura da consulta através de parâmetros de execução da fonte de conhecimento.

WorkIQKnowledgeSource

Object

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

Name	Tipo	Descrição
@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 Cofre de Chaves do Azure. Esta chave é usada para fornecer um nível adicional de encriptação em repouso para a definição da sua fonte de conhecimento quando quer total garantia de que ninguém, nem sequer a Microsoft, pode desencriptá-las. Depois de encriptar a definição da sua fonte de conhecimento, esta permanecerá sempre encriptada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como null. Pode alterar esta propriedade conforme necessário se quiser rodar a sua chave de encriptação; A definição da tua 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 ou após 1º de janeiro de 2019.
kind	string: workIQ	O tipo de fonte de conhecimento.
name	string	O nome da fonte de conhecimento.
resultsProcessing	KnowledgeSourceResultsProcessing	Controla se os resultados desta fonte de conhecimento são reclassificados antes de serem incluídos no conjunto final de resultados. Por defeito é 'reclassificado' quando não especificado.
workIQParameters	WorkIQKnowledgeSourceParameters	Os parâmetros para a fonte de conhecimento do WorkIQ, incluindo a configuração da aplicação Entra, propriedade do cliente, usada para autenticação em nome do cliente.

WorkIQKnowledgeSourceParameters

Object

Parâmetros para uma fonte de conhecimento WorkIQ.

Name	Tipo	Descrição
entraAppAuthentication	EntraAppAuthentication	A configuração de registo da aplicação Microsoft Entra, propriedade do cliente, é usada para autenticação em nome da API Work IQ. O cliente regista uma aplicação Entra propriedade do inquilino, concede-lhe a permissão delegada WorkIQAgent.Ask e configura uma credencial federada para que o Pesquisa de IA do Azure possa autenticar-se como essa aplicação sem um segredo de cliente armazenado.