Pular para o conteúdo principal

Pesquisa de AI

info

Visualização

Esse recurso está em Pré-lançamento público.

O servidor MCP de Pesquisa de AI é um servidor MCP gerenciado do Databricks que permite que agentes realizem a execução de pesquisa semântica sobre seus índices de Pesquisa de AI para encontrar documentos relevantes, com resultados regidos pelas permissões do Unity Catalog. A consulta de um índice requer incorporações gerenciadas pelo Databricks.

Padrão de URL

Escopo OAuth

https://<workspace-hostname>/api/2.0/mcp/ai-search/{catalog}/{schema}/{index_name}

ai-search

Padrão de URL

Escopo OAuth

https://<workspace-hostname>/api/2.0/mcp/ai-search/{catalog}/{schema}/{index_name}

ai-search

nota

O AI Search era anteriormente o Vector Search. O prefixo de URL /api/2.0/mcp/vector-search/ anterior e o escopo vector-search ainda funcionam.

Parâmetros de pesquisa de AI _meta

O AI Search é compatível com os seguintes parâmetros _meta:

Nome do parâmetro

Tipo

Descrição

columns

str

Lista separada por vírgulas de nomes de colunas a serem retornados nos resultados da pesquisa.

Exemplo: "id,text,metadata"

Se não especificado, todas as colunas (exceto colunas internas que começam com "__") são retornadas.

columns_to_rerank

str

Lista separada por vírgulas de nomes de colunas cujo conteúdo o modelo de reclassificação usa para reclassificação. O reclassificador usa este conteúdo para reclassificar todos os resultados da pesquisa para melhorar a relevância.

Exemplo: "text,title,description"

Se não especificado, a reclassificação não é realizada.

filters

str

strings JSON contendo filtros a serem aplicados à pesquisa. [[ ## completed ##]] Deve ser um JSON válido.

Exemplo: '{"updated_after": "2024-01-01"}'

Se não especificado, nenhum filtro é aplicado.

include_score

bool

Se deve incluir a pontuação de similaridade nos resultados retornados.

Valores suportados: "true" ou "false"

default: "false"

num_results

int

Número de resultados a retornar.

Exemplo: "5"

query_type

str

Algoritmo de pesquisa a ser usado para recuperar resultados.

Valores compatíveis: "ANN" (vizinho mais próximo aproximado, default) ou "HYBRID" (combina pesquisa vetorial e por palavra-chave)

default: "ANN"

score_threshold

float

Limite mínimo de pontuação de similaridade para filtrar resultados. Resultados com pontuações abaixo deste limite são excluídos.

Exemplo: "0.7"

Se não especificado, nenhum filtro de pontuação é aplicado.

Nome do parâmetro

Tipo

Descrição

columns

str

Lista separada por vírgulas de nomes de colunas a serem retornados nos resultados da pesquisa.

Exemplo: "id,text,metadata"

Se não especificado, todas as colunas (exceto colunas internas que começam com "__") são retornadas.

columns_to_rerank

str

Lista separada por vírgulas de nomes de colunas cujo conteúdo o modelo de reclassificação usa para reclassificação. O reclassificador usa este conteúdo para reclassificar todos os resultados da pesquisa para melhorar a relevância.

Exemplo: "text,title,description"

Se não especificado, a reclassificação não é realizada.

filters

str

strings JSON contendo filtros a serem aplicados à pesquisa. [[ ## completed ##]] Deve ser um JSON válido.

Exemplo: '{"updated_after": "2024-01-01"}'

Se não especificado, nenhum filtro é aplicado.

include_score

bool

Se deve incluir a pontuação de similaridade nos resultados retornados.

Valores suportados: "true" ou "false"

default: "false"

num_results

int

Número de resultados a retornar.

Exemplo: "5"

query_type

str

Algoritmo de pesquisa a ser usado para recuperar resultados.

Valores compatíveis: "ANN" (vizinho mais próximo aproximado, default) ou "HYBRID" (combina pesquisa vetorial e por palavra-chave)

default: "ANN"

score_threshold

float

Limite mínimo de pontuação de similaridade para filtrar resultados. Resultados com pontuações abaixo deste limite são excluídos.

Exemplo: "0.7"

Se não especificado, nenhum filtro de pontuação é aplicado.

Para obter informações detalhadas sobre esses parâmetros, consulte a documentação do SDK do Python para AI Search.

Exemplo: configurar resultados máximos e filtros para a recuperação de Pesquisa de AI

[[ ## completed ##]]

Este exemplo mostra como usar parâmetros _meta para configurar o comportamento da Pesquisa de IA enquanto permite queries dinâmicas do seu agente usando o SDK MCP Python oficial.

Nesse cenário, você deseja:

  • Limite sempre os resultados da pesquisa a exatamente 3 itens para tempos de resposta consistentes
  • Pesquise apenas documentação recente (atualizada após 01/01/2024) para verificar a relevância
  • Use a pesquisa híbrida para obter maior precisão do que a pesquisa vetorial pura
  • Retornar apenas colunas específicas (id, text e metadata)
  • Incluir pontuações de similaridade nos resultados
  • Excluir resultados com pontuações de similaridade abaixo de 0,5
  • Use a reclassificação em colunas de texto e título para melhorar a relevância

Para execução deste exemplo, configure seu ambiente Python para desenvolvimento de MCP gerenciado:

Python
# Import required libraries for MCP client and Databricks authentication
import asyncio
from databricks.sdk import WorkspaceClient
from databricks_mcp.oauth_provider import DatabricksOAuthClientProvider
from mcp.client.streamable_http import streamablehttp_client
from mcp.client.session import ClientSession
from mcp.types import CallToolRequest, CallToolResult

async def run_vector_search_tool_call_with_meta():
# Initialize Databricks workspace client for authentication
workspace_client = WorkspaceClient()

# Construct the MCP server URL for your specific catalog and schema
# Replace <workspace-hostname>, YOUR_CATALOG, and YOUR_SCHEMA with your values
mcp_server_url = "https://<workspace-hostname>/api/2.0/mcp/ai-search/YOUR_CATALOG/YOUR_SCHEMA"

# Establish connection to the MCP server with OAuth authentication
async with streamablehttp_client(
url=mcp_server_url,
auth=DatabricksOAuthClientProvider(workspace_client),
) as (read_stream, write_stream, _):

# Create an MCP session for making tool calls
async with ClientSession(read_stream, write_stream) as session:
# Initialize the session before making requests
await session.initialize()

# Create the tool call request with both dynamic and preset parameters
request = CallToolRequest(
method="tools/call",
params={
# Tool name follows the pattern: CATALOG__SCHEMA__INDEX_NAME
&quot;name&quot;: &quot;YOUR_CATALOG__YOUR_SCHEMA__YOUR_INDEX_NAME&quot;,

# Dynamic arguments - typically provided by your AI agent or user input
&quot;arguments&quot;: {
&quot;query&quot;: &quot;How do I reset my password?&quot; # This comes from your agent
},

# Meta parameters - preset configuration to control search behavior
&quot;_meta&quot;: {
&quot;num_results&quot;: &quot;3&quot;, # Limit to 3 results for consistent performance
&quot;filters&quot;: '{&quot;updated_after&quot;: &quot;2024-01-01&quot;}', # JSON string for date filtering
&quot;query_type&quot;: &quot;HYBRID&quot;, # Use hybrid search for better relevance
&quot;columns&quot;: &quot;id,text,metadata&quot;, # Return only specific columns
&quot;score_threshold&quot;: &quot;0.5&quot;, # Filter out results with similarity score &lt; 0.5
&quot;include_score&quot;: &quot;true&quot;, # Include similarity scores in results
&quot;columns_to_rerank&quot;: &quot;text,title&quot; # Use reranker on these columns for better quality
}
}
)

# Send the request and get the response
response = await session.send_request(request, CallToolResult)
return response

# Execute the async function and get results
response = asyncio.run(run_vector_search_tool_call_with_meta())