Knowledge Sources - Get

Recupera uma definição de fonte de conhecimento.

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

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string (uri)

A URL do ponto de extremidade do serviço de pesquisa.

sourceName
path True

string

O nome da fonte de conhecimento.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name Necessário Tipo Description
Accept

Accept

O cabeçalho Aceitar.

x-ms-client-request-id

string (uuid)

Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido.

Respostas

Name Tipo Description
200 OK KnowledgeSource:

O pedido foi bem-sucedido.

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 Description
https://search.azure.com/.default

Exemplos

SearchServiceGetKnowledgeSource
SearchServiceGetKnowledgeSourceAzureBlob
SearchServiceGetKnowledgeSourceIndexedOneLake
SearchServiceGetKnowledgeSourceWeb

SearchServiceGetKnowledgeSource

Pedido de amostra

GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01

Resposta da amostra

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "example-index",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceGetKnowledgeSourceAzureBlob

Pedido de amostra

GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01

Resposta da amostra

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}

SearchServiceGetKnowledgeSourceIndexedOneLake

Pedido de amostra

GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01

Resposta da amostra

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "<redacted>",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}

SearchServiceGetKnowledgeSourceWeb

Pedido de amostra

GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01

Resposta da amostra

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

Definições

Name Description
Accept

O cabeçalho Aceitar.

AIServices

Parâmetros para Serviços de IA.

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.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

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

IndexedOneLakeKnowledgeSource

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

IndexedOneLakeKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento OneLake.

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.

KnowledgeSourceKind

O tipo de fonte de conhecimento.

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.

SearchIndexKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento do í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.

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.

Accept

O cabeçalho Aceitar.

Valor Description
application/json;odata.metadata=minimal

AIServices

Parâmetros para Serviços de IA.

Name Tipo Description
apiKey

string

A chave API para aceder a Serviços de IA.

uri

string (uri)

O URI do endpoint de Serviços de IA.

AzureBlobKnowledgeSource

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

Name Tipo Description
@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.

AzureBlobKnowledgeSourceParameters

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

Name Tipo Default value Description
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 predefinido é falso.

AzureOpenAIModelName

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

Valor Description
text-embedding-ada-002

Modelo TextEmbeddingAda002.

text-embedding-3-large

TextEmbedding3 Modelo grande.

text-embedding-3-small

TextEmbedding3Small model.

gpt-5-mini

Modelo Gpt5Mini.

gpt-5-nano

Modelo Gpt5Nano.

gpt-5.4-mini

Modelo Gpt54Mini.

gpt-5.4-nano

Modelo Gpt54Nano.

AzureOpenAIVectorizerParameters

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

Name Tipo Description
apiKey

string

Chave de API do recurso OpenAI do Azure designado.

authIdentity SearchIndexerDataIdentity:

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.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

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

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

Name Tipo Description
error

ErrorDetail

O objeto de erro.

IndexedOneLakeKnowledgeSource

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

Name Tipo Description
@odata.etag

string

O ETag da fonte de conhecimento.

description

string

Descrição opcional definida pelo usuário.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no 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.

IndexedOneLakeKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento OneLake.

Name Tipo Description
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.

targetPath

string

Pasta ou atalho opcional do OneLakehouse para filtrar o conteúdo do OneLake.

IndexingSchedule

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

Name Tipo Description
interval

string (duration)

O intervalo de tempo entre as execuções do indexador.

startTime

string (date-time)

A hora em que um indexador deve começar a ser executado.

KnowledgeBaseAzureOpenAIModel

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

Name Tipo Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Parâmetros Azure OpenAI.

kind string:

azureOpenAI

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

KnowledgeBaseModelKind

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

Valor Description
azureOpenAI

Use modelos de IA aberta do Azure para planejamento de consultas.

KnowledgeSourceAzureOpenAIVectorizer

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

Name Tipo Description
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

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

Name Tipo Default value Description
aiServices

AIServices

Configuração opcional de Serviços de IA para processamento de conteúdo.

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 predefinido é falso.

embeddingModel KnowledgeSourceVectorizer:

KnowledgeSourceAzureOpenAIVectorizer

Configuração opcional do vetorizador para vetorização de conteúdo.

identity SearchIndexerDataIdentity:

Uma identidade explícita a ser usada para essa fonte de conhecimento.

ingestionSchedule

IndexingSchedule

Horário opcional para ingestão de dados.

KnowledgeSourceKind

O tipo de fonte de conhecimento.

Valor Description
searchIndex

Uma fonte de conhecimento que lê dados de um índice de pesquisa.

azureBlob

Uma fonte de conhecimento que lê e ingere dados do Armazenamento de Blobs do Azure para um Índice de Pesquisa.

indexedOneLake

Uma fonte de conhecimento que lê dados do OneLake indexado.

web

Uma fonte de conhecimento que lê dados da web.

SearchIndexerDataNoneIdentity

Limpa a propriedade identity de uma fonte de dados.

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

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

Name Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Um fragmento de URI especificando o tipo de identidade.

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

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

Name Tipo Description
name

string

O nome do campo.

SearchIndexKnowledgeSource

Fonte de conhecimento direcionada a um índice de pesquisa.

Name Tipo Description
@odata.etag

string

O ETag da fonte de conhecimento.

description

string

Descrição opcional definida pelo usuário.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no 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.

searchIndexParameters

SearchIndexKnowledgeSourceParameters

Os parâmetros para a fonte de conhecimento.

SearchIndexKnowledgeSourceParameters

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

Name Tipo Description
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.

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.

Name Tipo Description
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:

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.

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.

VectorSearchVectorizerKind

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

Valor Description
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

Fonte de conhecimento direcionada para resultados da Web.

Name Tipo Description
@odata.etag

string

O ETag da fonte de conhecimento.

description

string

Descrição opcional definida pelo usuário.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no 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.

webParameters

WebKnowledgeSourceParameters

Os parâmetros para a fonte de conhecimento da Web.

WebKnowledgeSourceDomain

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

Name Tipo Description
address

string

O endereço do domínio.

includeSubpages

boolean

Se deve ou não incluir subpáginas deste domínio.

WebKnowledgeSourceDomains

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

Name Tipo Description
allowedDomains

WebKnowledgeSourceDomain[]

Domínios que são permitidos para resultados web.

blockedDomains

WebKnowledgeSourceDomain[]

Domínios bloqueados de resultados web.

WebKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento web.

Name Tipo Description
domains

WebKnowledgeSourceDomains

Configuração de domínio/bloqueio para resultados da Web.