Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Importante
Web Knowledge Source, que utiliza Grounding com Bing Search e/ou Grounding com Bing Custom Search, é um Serviço de Consumo de Primeira Parte regido pelos termos de uso do Grounding with Bing e pela Declaração de Privacidade da Microsoft.
O Adendo de Proteção de Dados da Microsoft não se aplica a dados enviados para a Web Knowledge Source. Quando o Cliente utiliza o Web Knowledge Source, os Dados do Cliente fluem para além dos limites de conformidade Azure e Geo. Isto também significa que a utilização do Web Knowledge Source dispensa todos os compromissos elevados de segurança e conformidade da Comunidade Governamental na Cloud, incluindo soberania de dados e apoio baseado em triagem/cidadania, conforme aplicável.
A utilização da Web Knowledge Source implica custos; Saiba mais sobre preços.
Saiba mais sobre como os administradores do Azure podem gerir o acesso ao uso do Web Knowledge Source.
Observação
Esta funcionalidade está atualmente em pré-visualização pública. Esta pré-visualização é fornecida sem um contrato de nível de serviço e não é recomendada para cargas de trabalho de produção. Algumas funcionalidades poderão não ser suportadas ou poderão ter capacidades limitadas. Para obter mais informações, veja Termos Suplementares de Utilização para Pré-visualizações do Microsoft Azure.
O Web Knowledge Source permite a recuperação de dados web em tempo real do Microsoft Bing num pipeline de recuperação baseado em agentes. As fontes de conhecimento são criadas de forma independente, referenciadas numa base de conhecimento e usadas como dados de base quando um agente ou chatbot chama uma ação de recuperação no momento da consulta.
O Bing Custom Search é sempre o fornecedor de pesquisa para a Web Knowledge Source. Embora não possa especificar fornecedores ou motores de busca alternativos, pode incluir ou excluir domínios específicos, como https://learn.microsoft.com. Quando não são especificados domínios, o Web Knowledge Source tem acesso irrestrito a toda a internet pública.
O Web Knowledge Source funciona melhor em conjunto com outras fontes de conhecimento. Use a Web Knowledge Source quando o seu conteúdo proprietário não fornecer respostas completas e atualizadas, ou quando quiser complementar os resultados com informação de um motor de pesquisa comercial.
Quando utiliza o Web Knowledge Source, tenha o seguinte em mente:
A resposta é sempre uma resposta única e formulada à pergunta, em vez de resultados brutos da pesquisa na web.
Como o Web Knowledge Source não suporta dados extrativos, a sua base de conhecimento deve usar síntese de respostas e um esforço de raciocínio baixo ou médio. Também não podes definir instruções de resposta.
Pré-requisitos
Uma subscrição Azure com acesso ao Web Knowledge Source. Por padrão, o acesso está ativado. Contacta o teu administrador se o acesso estiver desativado.
Um serviço Azure AI Search em qualquer região que forneça recuperação agential. Deve ter o ranker semântico ativado. O serviço deve também estar numa região pública Azure, pois o Web Knowledge Source não é suportado em clouds privadas ou soberanas.
A versão de pré-visualização mais recente da
Azure.Search.Documentsbiblioteca cliente para o SDK .NET.Permissão para criar e usar objetos no Azure AI Search. Recomendamos acesso baseado em funções, mas pode usar chaves API se a atribuição de funções não for viável. Para mais informações, consulte Ligar-se a um serviço de pesquisa.
Verifique se há fontes de conhecimento existentes
Uma fonte de conhecimento é um objeto reutilizável de nível superior. Conhecer as fontes de conhecimento existentes é útil para reutilizar ou nomear novos objetos.
Execute o seguinte código para listar as fontes de conhecimento por nome e tipo.
// List knowledge sources by name and type
using Azure.Search.Documents.Indexes;
var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
var knowledgeSources = indexClient.GetKnowledgeSourcesAsync();
Console.WriteLine("Knowledge Sources:");
await foreach (var ks in knowledgeSources)
{
Console.WriteLine($" Name: {ks.Name}, Type: {ks.GetType().Name}");
}
Você também pode retornar uma única fonte de conhecimento pelo nome para revisar sua definição JSON.
using Azure.Search.Documents.Indexes;
using System.Text.Json;
var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
// Specify the knowledge source name to retrieve
string ksNameToGet = "earth-knowledge-source";
// Get its definition
var knowledgeSourceResponse = await indexClient.GetKnowledgeSourceAsync(ksNameToGet);
var ks = knowledgeSourceResponse.Value;
// Serialize to JSON for display
var jsonOptions = new JsonSerializerOptions
{
WriteIndented = true,
DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.Never
};
Console.WriteLine(JsonSerializer.Serialize(ks, ks.GetType(), jsonOptions));
O JSON seguinte é uma resposta de exemplo para um recurso Web Knowledge Source.
{
"WebParameters": {
"Domains": null
},
"Name": "my-web-ks",
"Description": "A sample Web Knowledge Source.",
"EncryptionKey": null,
}
Criar uma fonte de conhecimento
Execute o código seguinte para criar um recurso Web Knowledge Source.
// Create Web Knowledge Source
// Create a Web knowledge source
using Azure.Search.Documents.Indexes;
using Azure.Search.Documents.Indexes.Models;
using Azure;
var indexClient = new SearchIndexClient(new Uri(searchEndpoint), new AzureKeyCredential(apiKey));
var knowledgeSource = new WebKnowledgeSource(name: "my-web-ks")
{
Description = "A sample Web Knowledge Source.",
WebParameters = new WebKnowledgeSourceParameters
{
Domains = new WebKnowledgeSourceDomains
{
AllowedDomains =
{
new WebKnowledgeSourceDomain(address: "learn.microsoft.com") { IncludeSubpages = true }
},
BlockedDomains =
{
new WebKnowledgeSourceDomain(address: "bing.com") { IncludeSubpages = false }
}
}
}
};
await indexClient.CreateOrUpdateKnowledgeSourceAsync(knowledgeSource);
Console.WriteLine($"Knowledge source '{knowledgeSource.Name}' created or updated successfully.");
Propriedades específicas da fonte
Pode passar as seguintes propriedades para criar um recurso Web Knowledge Source.
| Nome | Description | Tipo | Editável | Obrigatório |
|---|---|---|---|---|
Name |
O nome da fonte de conhecimento, que deve ser único dentro da coleção de fontes de conhecimento e seguir as diretrizes de nomenclatura para objetos no Azure AI Search. | Cordão | Yes | Yes |
Description |
Uma descrição da fonte de conhecimento. Quando não especificado, o Azure AI Search aplica uma descrição padrão. | Cordão | Yes | Não |
EncryptionKey |
Uma chave gerida pelo cliente para encriptar informação sensível na fonte de conhecimento. | Objeto | Yes | Não |
WebParameters |
Parâmetros específicos da Web Knowledge Source. Atualmente, isto é apenas Domains. |
Objeto | Yes | Não |
Domains |
Domínios a permitir ou bloquear no espaço de pesquisa. Por padrão, a fonte de conhecimento usa Grounding with Bing Search para pesquisar toda a internet pública. Quando especificas domínios, a fonte de conhecimento usa Grounding com Bing Custom Search para restringir os resultados aos domínios especificados. Em ambos os casos, o Bing Custom Search é o fornecedor de pesquisa. | Objeto | Yes | Não |
AllowedDomains |
Domínios a incluir no espaço de pesquisa. Para cada domínio, deve especificar o seu address no formato website.com. Também pode especificar se deve incluir as subpáginas do domínio definindo IncludeSubpages como true ou false. |
Array | Yes | Não |
BlockedDomains |
Domínios a excluir do espaço de pesquisa. Para cada domínio, deve especificar o seu address no formato website.com. Também pode especificar se deve incluir as subpáginas do domínio definindo IncludeSubpages como true ou false. |
Array | Yes | Não |
Atribuir a uma base de conhecimento
Se estiver satisfeito com a fonte de conhecimento, continue para o passo seguinte: especifique a fonte de conhecimento numa base de conhecimento.
Depois de a base de conhecimento estar configurada, use a ação de recuperar para consultar a fonte de conhecimento.
Excluir uma fonte de conhecimento
Antes de poder eliminar uma fonte de conhecimento, deve eliminar qualquer base de conhecimento que a faça referência ou atualizar a definição da base de conhecimento para remover a referência. Para fontes de conhecimento que geram um pipeline de índice e indexador, todos os objetos gerados também são eliminados. No entanto, se usou um índice existente para criar uma fonte de conhecimento, o seu índice não é eliminado.
Se tentar eliminar uma fonte de conhecimento que está em uso, a ação falha e devolve uma lista das bases de conhecimento afetadas.
Para eliminar uma fonte de conhecimento:
Obtenha uma lista de todas as bases de conhecimento do seu serviço de pesquisa.
using Azure.Search.Documents.Indexes; var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential); var knowledgeBases = indexClient.GetKnowledgeBasesAsync(); Console.WriteLine("Knowledge Bases:"); await foreach (var kb in knowledgeBases) { Console.WriteLine($" - {kb.Name}"); }Um exemplo de resposta pode ter a seguinte aparência:
Knowledge Bases: - earth-knowledge-base - hotels-sample-knowledge-base - my-demo-knowledge-baseObtenha uma definição individual da base de conhecimento para verificar referências de fontes de conhecimento.
using Azure.Search.Documents.Indexes; using System.Text.Json; var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential); // Specify the knowledge base name to retrieve string kbNameToGet = "earth-knowledge-base"; // Get a specific knowledge base definition var knowledgeBaseResponse = await indexClient.GetKnowledgeBaseAsync(kbNameToGet); var kb = knowledgeBaseResponse.Value; // Serialize to JSON for display string json = JsonSerializer.Serialize(kb, new JsonSerializerOptions { WriteIndented = true }); Console.WriteLine(json);Um exemplo de resposta pode ter a seguinte aparência:
{ "Name": "earth-knowledge-base", "KnowledgeSources": [ { "Name": "earth-knowledge-source" } ], "Models": [ {} ], "RetrievalReasoningEffort": {}, "OutputMode": {}, "ETag": "\u00220x8DE278629D782B3\u0022", "EncryptionKey": null, "Description": null, "RetrievalInstructions": null, "AnswerInstructions": null }Ou apaga a base de conhecimento ou atualiza a base de conhecimento para remover a fonte de conhecimento se tiveres várias fontes. Este exemplo mostra a exclusão.
using Azure.Search.Documents.Indexes; var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential); await indexClient.DeleteKnowledgeBaseAsync(knowledgeBaseName); System.Console.WriteLine($"Knowledge base '{knowledgeBaseName}' deleted successfully.");Exclua a fonte de conhecimento.
await indexClient.DeleteKnowledgeSourceAsync(knowledgeSourceName); System.Console.WriteLine($"Knowledge source '{knowledgeSourceName}' deleted successfully.");
Importante
Web Knowledge Source, que utiliza Grounding com Bing Search e/ou Grounding com Bing Custom Search, é um Serviço de Consumo de Primeira Parte regido pelos termos de uso do Grounding with Bing e pela Declaração de Privacidade da Microsoft.
O Adendo de Proteção de Dados da Microsoft não se aplica a dados enviados para a Web Knowledge Source. Quando o Cliente utiliza o Web Knowledge Source, os Dados do Cliente fluem para além dos limites de conformidade Azure e Geo. Isto também significa que a utilização do Web Knowledge Source dispensa todos os compromissos elevados de segurança e conformidade da Comunidade Governamental na Cloud, incluindo soberania de dados e apoio baseado em triagem/cidadania, conforme aplicável.
A utilização da Web Knowledge Source implica custos; Saiba mais sobre preços.
Saiba mais sobre como os administradores do Azure podem gerir o acesso ao uso do Web Knowledge Source.
Observação
Esta funcionalidade está atualmente em pré-visualização pública. Esta pré-visualização é fornecida sem um contrato de nível de serviço e não é recomendada para cargas de trabalho de produção. Algumas funcionalidades poderão não ser suportadas ou poderão ter capacidades limitadas. Para obter mais informações, veja Termos Suplementares de Utilização para Pré-visualizações do Microsoft Azure.
O Web Knowledge Source permite a recuperação de dados web em tempo real do Microsoft Bing num pipeline de recuperação baseado em agentes. As fontes de conhecimento são criadas de forma independente, referenciadas numa base de conhecimento e usadas como dados de base quando um agente ou chatbot chama uma ação de recuperação no momento da consulta.
O Bing Custom Search é sempre o fornecedor de pesquisa para a Web Knowledge Source. Embora não possa especificar fornecedores ou motores de busca alternativos, pode incluir ou excluir domínios específicos, como https://learn.microsoft.com. Quando não são especificados domínios, o Web Knowledge Source tem acesso irrestrito a toda a internet pública.
O Web Knowledge Source funciona melhor em conjunto com outras fontes de conhecimento. Use a Web Knowledge Source quando o seu conteúdo proprietário não fornecer respostas completas e atualizadas, ou quando quiser complementar os resultados com informação de um motor de pesquisa comercial.
Quando utiliza o Web Knowledge Source, tenha o seguinte em mente:
A resposta é sempre uma resposta única e formulada à pergunta, em vez de resultados brutos da pesquisa na web.
Como o Web Knowledge Source não suporta dados extrativos, a sua base de conhecimento deve usar síntese de respostas e um esforço de raciocínio baixo ou médio. Também não podes definir instruções de resposta.
Pré-requisitos
Uma subscrição Azure com acesso ao Web Knowledge Source. Por padrão, o acesso está ativado. Contacta o teu administrador se o acesso estiver desativado.
Um serviço Azure AI Search em qualquer região que forneça recuperação agential. Deve ter o ranker semântico ativado. O serviço deve também estar numa região pública Azure, pois o Web Knowledge Source não é suportado em clouds privadas ou soberanas.
A versão mais recente de pré-visualização da
azure-search-documentsbiblioteca cliente para Python.Permissão para criar e usar objetos no Azure AI Search. Recomendamos acesso baseado em funções, mas pode usar chaves API se a atribuição de funções não for viável. Para mais informações, consulte Ligar-se a um serviço de pesquisa.
Verifique se há fontes de conhecimento existentes
Uma fonte de conhecimento é um objeto reutilizável de nível superior. Conhecer as fontes de conhecimento existentes é útil para reutilizar ou nomear novos objetos.
Execute o seguinte código para listar as fontes de conhecimento por nome e tipo.
# List knowledge sources by name and type
import requests
import json
endpoint = "{search_url}/knowledgesources"
params = {"api-version": "2025-11-01-preview", "$select": "name, kind"}
headers = {"api-key": "{api_key}"}
response = requests.get(endpoint, params = params, headers = headers)
print(json.dumps(response.json(), indent = 2))
Você também pode retornar uma única fonte de conhecimento pelo nome para revisar sua definição JSON.
# Get a knowledge source definition
import requests
import json
endpoint = "{search_url}/knowledgesources/{knowledge_source_name}"
params = {"api-version": "2025-11-01-preview"}
headers = {"api-key": "{api_key}"}
response = requests.get(endpoint, params = params, headers = headers)
print(json.dumps(response.json(), indent = 2))
O JSON seguinte é uma resposta de exemplo para um recurso Web Knowledge Source.
{
"name": "my-web-ks",
"kind": "web",
"description": "A sample Web Knowledge Source.",
"encryptionKey": null,
"webParameters": {
"domains": null
}
}
Criar uma fonte de conhecimento
Execute o código seguinte para criar um recurso Web Knowledge Source.
# Create Web Knowledge Source
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient
from azure.search.documents.indexes.models import WebKnowledgeSource, WebKnowledgeSourceParameters, WebKnowledgeSourceDomains
index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
knowledge_source = WebKnowledgeSource(
name = "my-web-ks",
description = "A sample Web Knowledge Source.",
encryption_key = None,
web_parameters = WebKnowledgeSourceParameters(
domains = WebKnowledgeSourceDomains(
allowed_domains = [ { "address": "learn.microsoft.com", "include_subpages": True } ],
blocked_domains = [ { "address": "bing.com", "include_subpages": False } ]
)
)
)
index_client.create_or_update_knowledge_source(knowledge_source)
print(f"Knowledge source '{knowledge_source.name}' created or updated successfully.")
Propriedades específicas da fonte
Pode passar as seguintes propriedades para criar um recurso Web Knowledge Source.
| Nome | Description | Tipo | Editável | Obrigatório |
|---|---|---|---|---|
name |
O nome da fonte de conhecimento, que deve ser único dentro da coleção de fontes de conhecimento e seguir as diretrizes de nomenclatura para objetos no Azure AI Search. | Cordão | Yes | Yes |
description |
Uma descrição da fonte de conhecimento. Quando não especificado, o Azure AI Search aplica uma descrição padrão. | Cordão | Yes | Não |
encryption_key |
Uma chave gerida pelo cliente para encriptar informação sensível na fonte de conhecimento. | Objeto | Yes | Não |
web_parameters |
Parâmetros específicos da Web Knowledge Source. Atualmente, isto é apenas domains. |
Objeto | Yes | Não |
domains |
Domínios a permitir ou bloquear no espaço de pesquisa. Por padrão, a fonte de conhecimento usa Grounding with Bing Search para pesquisar toda a internet pública. Quando especificas domínios, a fonte de conhecimento usa Grounding com Bing Custom Search para restringir os resultados aos domínios especificados. Em ambos os casos, o Bing Custom Search é o fornecedor de pesquisa. | Objeto | Yes | Não |
allowed_domains |
Domínios a incluir no espaço de pesquisa. Para cada domínio, deve especificar o seu address no formato website.com. Também pode especificar se deve incluir as subpáginas do domínio definindo include_subpages como true ou false. |
Array | Yes | Não |
blocked_domains |
Domínios a excluir do espaço de pesquisa. Para cada domínio, deve especificar o seu address no formato website.com. Também pode especificar se deve incluir as subpáginas do domínio definindo include_subpages como true ou false. |
Array | Yes | Não |
Atribuir a uma base de conhecimento
Se estiver satisfeito com a fonte de conhecimento, continue para o passo seguinte: especifique a fonte de conhecimento numa base de conhecimento.
Depois de a base de conhecimento estar configurada, use a ação de recuperar para consultar a fonte de conhecimento.
Excluir uma fonte de conhecimento
Antes de poder eliminar uma fonte de conhecimento, deve eliminar qualquer base de conhecimento que a faça referência ou atualizar a definição da base de conhecimento para remover a referência. Para fontes de conhecimento que geram um pipeline de índice e indexador, todos os objetos gerados também são eliminados. No entanto, se usou um índice existente para criar uma fonte de conhecimento, o seu índice não é eliminado.
Se tentar eliminar uma fonte de conhecimento que está em uso, a ação falha e devolve uma lista das bases de conhecimento afetadas.
Para eliminar uma fonte de conhecimento:
Obtenha uma lista de todas as bases de conhecimento do seu serviço de pesquisa.
# Get knowledge bases import requests import json endpoint = "{search_url}/knowledgebases" params = {"api-version": "2025-11-01-preview", "$select": "name"} headers = {"api-key": "{api_key}"} response = requests.get(endpoint, params = params, headers = headers) print(json.dumps(response.json(), indent = 2))Um exemplo de resposta pode ter a seguinte aparência:
{ "@odata.context": "https://my-search-service.search.windows.net/$metadata#knowledgebases(name)", "value": [ { "name": "my-kb" }, { "name": "my-kb-2" } ] }Obtenha uma definição individual da base de conhecimento para verificar referências de fontes de conhecimento.
# Get a knowledge base definition import requests import json endpoint = "{search_url}/knowledgebases/{knowledge_base_name}" params = {"api-version": "2025-11-01-preview"} headers = {"api-key": "{api_key}"} response = requests.get(endpoint, params = params, headers = headers) print(json.dumps(response.json(), indent = 2))Um exemplo de resposta pode ter a seguinte aparência:
{ "name": "my-kb", "description": null, "retrievalInstructions": null, "answerInstructions": null, "outputMode": null, "knowledgeSources": [ { "name": "my-blob-ks", } ], "models": [], "encryptionKey": null, "retrievalReasoningEffort": { "kind": "low" } }Ou apaga a base de conhecimento ou atualiza a base de conhecimento para remover a fonte de conhecimento se tiveres várias fontes. Este exemplo mostra a exclusão.
# Delete a knowledge base from azure.core.credentials import AzureKeyCredential from azure.search.documents.indexes import SearchIndexClient index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key")) index_client.delete_knowledge_base("knowledge_base_name") print(f"Knowledge base deleted successfully.")Exclua a fonte de conhecimento.
# Delete a knowledge source from azure.core.credentials import AzureKeyCredential from azure.search.documents.indexes import SearchIndexClient index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key")) index_client.delete_knowledge_source("knowledge_source_name") print(f"Knowledge source deleted successfully.")
Importante
Web Knowledge Source, que utiliza Grounding com Bing Search e/ou Grounding com Bing Custom Search, é um Serviço de Consumo de Primeira Parte regido pelos termos de uso do Grounding with Bing e pela Declaração de Privacidade da Microsoft.
O Adendo de Proteção de Dados da Microsoft não se aplica a dados enviados para a Web Knowledge Source. Quando o Cliente utiliza o Web Knowledge Source, os Dados do Cliente fluem para além dos limites de conformidade Azure e Geo. Isto também significa que a utilização do Web Knowledge Source dispensa todos os compromissos elevados de segurança e conformidade da Comunidade Governamental na Cloud, incluindo soberania de dados e apoio baseado em triagem/cidadania, conforme aplicável.
A utilização da Web Knowledge Source implica custos; Saiba mais sobre preços.
Saiba mais sobre como os administradores do Azure podem gerir o acesso ao uso do Web Knowledge Source.
Observação
Esta funcionalidade está atualmente em pré-visualização pública. Esta pré-visualização é fornecida sem um contrato de nível de serviço e não é recomendada para cargas de trabalho de produção. Algumas funcionalidades poderão não ser suportadas ou poderão ter capacidades limitadas. Para obter mais informações, veja Termos Suplementares de Utilização para Pré-visualizações do Microsoft Azure.
O Web Knowledge Source permite a recuperação de dados web em tempo real do Microsoft Bing num pipeline de recuperação baseado em agentes. As fontes de conhecimento são criadas de forma independente, referenciadas numa base de conhecimento e usadas como dados de base quando um agente ou chatbot chama uma ação de recuperação no momento da consulta.
O Bing Custom Search é sempre o fornecedor de pesquisa para a Web Knowledge Source. Embora não possa especificar fornecedores ou motores de busca alternativos, pode incluir ou excluir domínios específicos, como https://learn.microsoft.com. Quando não são especificados domínios, o Web Knowledge Source tem acesso irrestrito a toda a internet pública.
O Web Knowledge Source funciona melhor em conjunto com outras fontes de conhecimento. Use a Web Knowledge Source quando o seu conteúdo proprietário não fornecer respostas completas e atualizadas, ou quando quiser complementar os resultados com informação de um motor de pesquisa comercial.
Quando utiliza o Web Knowledge Source, tenha o seguinte em mente:
A resposta é sempre uma resposta única e formulada à pergunta, em vez de resultados brutos da pesquisa na web.
Como o Web Knowledge Source não suporta dados extrativos, a sua base de conhecimento deve usar síntese de respostas e um esforço de raciocínio baixo ou médio. Também não podes definir instruções de resposta.
Pré-requisitos
Uma subscrição Azure com acesso ao Web Knowledge Source. Por padrão, o acesso está ativado. Contacta o teu administrador se o acesso estiver desativado.
Um serviço Azure AI Search em qualquer região que forneça recuperação agential. Deve ter o ranker semântico ativado. O serviço deve também estar numa região pública Azure, pois o Web Knowledge Source não é suportado em clouds privadas ou soberanas.
A versão de pré-visualização de 2025-11-01 - das APIs REST do Serviço de Pesquisa.
Permissão para criar e usar objetos no Azure AI Search. Recomendamos acesso baseado em funções, mas pode usar chaves API se a atribuição de funções não for viável. Para mais informações, consulte Ligar-se a um serviço de pesquisa.
Verifique se há fontes de conhecimento existentes
Uma fonte de conhecimento é um objeto reutilizável de nível superior. Conhecer as fontes de conhecimento existentes é útil para reutilizar ou nomear novos objetos.
Usar Fontes de Conhecimento - Obter (API REST) para listar fontes de conhecimento por nome e tipo.
### List knowledge sources by name and type
GET {{search-url}}/knowledgesources?api-version=2025-11-01-preview&$select=name,kind
api-key: {{api-key}}
Você também pode retornar uma única fonte de conhecimento pelo nome para revisar sua definição JSON.
### Get a knowledge source definition
GET {{search-url}}/knowledgesources/{{knowledge-source-name}}?api-version=2025-11-01-preview
api-key: {{api-key}}
O JSON seguinte é uma resposta de exemplo para um recurso Web Knowledge Source.
{
"name": "my-web-ks",
"kind": "web",
"description": "A sample Web Knowledge Source.",
"encryptionKey": null,
"webParameters": {
"domains": null
}
}
Criar uma fonte de conhecimento
Use Knowledge Sources - Create or Update (API REST) para criar um recurso Web Knowledge Source.
PUT {{search-url}}/knowledgesources/my-web-ks?api-version=2025-11-01-preview
Content-Type: application/json
api-key: {{api-key}}
{
"name": "my-web-ks",
"kind": "web",
"description": "This knowledge source pulls content from the web.",
"encryptionKey": null,
"webParameters": {
"domains": {
"allowedDomains": [ { "address": "learn.microsoft.com", "includeSubpages": true } ],
"blockedDomains": [ { "address": "bing.com", "includeSubpages": false } ]
}
}
}
Propriedades específicas da fonte
Pode passar as seguintes propriedades para criar um recurso Web Knowledge Source.
| Nome | Description | Tipo | Editável | Obrigatório |
|---|---|---|---|---|
name |
O nome da fonte de conhecimento, que deve ser único dentro da coleção de fontes de conhecimento e seguir as diretrizes de nomenclatura para objetos no Azure AI Search. | Cordão | Yes | Yes |
kind |
O tipo de fonte de conhecimento, que é web neste caso. |
Cordão | Não | Yes |
description |
Uma descrição da fonte de conhecimento. Quando não especificado, o Azure AI Search aplica uma descrição padrão. | Cordão | Yes | Não |
encryptionKey |
Uma chave gerida pelo cliente para encriptar informação sensível na fonte de conhecimento. | Objeto | Yes | Não |
webParameters |
Parâmetros específicos da Web Knowledge Source. Atualmente, isto é apenas domains. |
Objeto | Yes | Não |
domains |
Domínios a permitir ou bloquear no espaço de pesquisa. Por padrão, a fonte de conhecimento usa Grounding with Bing Search para pesquisar toda a internet pública. Quando especificas domínios, a fonte de conhecimento usa Grounding com Bing Custom Search para restringir os resultados aos domínios especificados. Em ambos os casos, o Bing Custom Search é o fornecedor de pesquisa. | Objeto | Yes | Não |
allowedDomains |
Domínios a incluir no espaço de pesquisa. Para cada domínio, deve especificar o seu address no formato website.com. Também pode especificar se deve incluir as subpáginas do domínio definindo includeSubpages como true ou false. |
Array | Yes | Não |
blockedDomains |
Domínios a excluir do espaço de pesquisa. Para cada domínio, deve especificar o seu address no formato website.com. Também pode especificar se deve incluir as subpáginas do domínio definindo includeSubpages como true ou false. |
Array | Yes | Não |
Atribuir a uma base de conhecimento
Se estiver satisfeito com a fonte de conhecimento, continue para o passo seguinte: especifique a fonte de conhecimento numa base de conhecimento.
Depois de a base de conhecimento estar configurada, use a ação de recuperar para consultar a fonte de conhecimento.
Excluir uma fonte de conhecimento
Antes de poder eliminar uma fonte de conhecimento, deve eliminar qualquer base de conhecimento que a faça referência ou atualizar a definição da base de conhecimento para remover a referência. Para fontes de conhecimento que geram um pipeline de índice e indexador, todos os objetos gerados também são eliminados. No entanto, se usou um índice existente para criar uma fonte de conhecimento, o seu índice não é eliminado.
Se tentar eliminar uma fonte de conhecimento que está em uso, a ação falha e devolve uma lista das bases de conhecimento afetadas.
Para eliminar uma fonte de conhecimento:
Obtenha uma lista de todas as bases de conhecimento do seu serviço de pesquisa.
### Get knowledge bases GET {{search-endpoint}}/knowledgebases?api-version=2025-11-01-preview&$select=name api-key: {{api-key}}Um exemplo de resposta pode ter a seguinte aparência:
{ "@odata.context": "https://my-search-service.search.windows.net/$metadata#knowledgebases(name)", "value": [ { "name": "my-kb" }, { "name": "my-kb-2" } ] }Obtenha uma definição individual da base de conhecimento para verificar referências de fontes de conhecimento.
### Get a knowledge base definition GET {{search-endpoint}}/knowledgebases/{{knowledge-base-name}}?api-version=2025-11-01-preview api-key: {{api-key}}Um exemplo de resposta pode ter a seguinte aparência:
{ "name": "my-kb", "description": null, "retrievalInstructions": null, "answerInstructions": null, "outputMode": null, "knowledgeSources": [ { "name": "my-blob-ks", } ], "models": [], "encryptionKey": null, "retrievalReasoningEffort": { "kind": "low" } }Ou apaga a base de conhecimento ou atualiza a base de conhecimento removendo a fonte de conhecimento se tiveres múltiplas fontes. Este exemplo mostra a exclusão.
### Delete a knowledge base DELETE {{search-endpoint}}/knowledgebases/{{knowledge-base-name}}?api-version=2025-11-01-preview api-key: {{api-key}}Exclua a fonte de conhecimento.
### Delete a knowledge source DELETE {{search-endpoint}}/knowledgesources/{{knowledge-source-name}}?api-version=2025-11-01-preview api-key: {{api-key}}