Observação:a Vertex AI para Pesquisa está sendo renomeada como Pesquisa de agente. Estamos atualizando o conteúdo para refletir o novo branding.

Criar um app de pesquisa

Nesta página, descrevemos como criar um app de pesquisa.

Criar um app

Console

Para criar um app de pesquisa usando o Google Cloud console do Google Cloud, siga estas etapas:

No Google Cloud console do Google Cloud, acesse a página Aplicativos de IA.

Aplicativos de IA
Na página Apps, clique em Criar app.
Na página Criar app, em Pesquisa no site com o Modo IA, clique em Criar.
Decida se você quer recursos empresariais para esse app e clique no botão de ativação ou desativação. É necessário ativar os recursos da edição Enterprise para ter acesso a recursos como pesquisa em sites e escolha de uma região para o app. Os recursos da edição Enterprise geram custos adicionais. Para mais informações, consulte Recursos da edição Enterprise.
Decida se você quer respostas generativas com recursos avançados de LLM para esse app e clique no botão de ativação ou desativação. É necessário ativar a opção Respostas generativas para ter acesso a recursos como resumos de pesquisa ou pesquisa com acompanhamentos. Para mais informações, consulte Respostas generativas.
No campo Nome do app, insira um nome para seu app.
No campo Nome externo da sua empresa ou organização, insira o nome comum da sua empresa ou organização. Evite sufixos como Inc ou LLC. Esse campo ajuda o LLM a identificar a empresa que o app representa.
Selecione um local para seu app. Os recursos empresariais precisam estar ativados para escolher um local. O Google recomenda que você use o padrão, global (Global), a menos que tenha um motivo para restringir seus dados a uma região geográfica específica.
Clique em Continuar.
Para se conectar a um repositório de dados, na página Repositórios de dados, selecione um repositório que você criou anteriormente ou crie um novo.

Observação: se você planeja anexar mais de um repositório de dados ao app, revise os recursos e limitações em Sobre a pesquisa combinada. Se você anexar apenas um repositório de dados, não será possível anexar mais tarde.

Escolha uma das seguintes opções:
- Selecione um repositório de dados atual: se você anexar apenas um repositório de dados, não será possível removê-lo ou adicionar outros repositórios de dados ao app mais tarde. Ao anexar vários repositórios de dados, você pode atualizar os repositórios anexados mais tarde, mas o app sempre exige pelo menos dois repositórios de dados.
- Crie um novo repositório de dados e ingira dados nele:
  1. Clique em Criar repositório de dados e siga as etapas na página Criar um novo repositório de dados.
  2. Escolha seu novo repositório de dados e clique em Selecionar. Para mais informações, consulte Criar um repositório de dados de pesquisa.

REST

Antes de usar a linha de comando para criar um app, é necessário ter um repositório de dados. Se você não tiver um repositório de dados, crie um seguindo as etapas em Criar um repositório de dados e ingerir dados para a Pesquisa de agentes.

Para usar o método engines.create para criar um app de pesquisa na linha de comando, siga estas etapas:

Encontre o ID do repositório de dados. Se você já tiver o ID do repositório de dados, pule para a próxima etapa.
1. No Google Cloud console do Google Cloud, acesse a página Aplicativos de IA e no menu de navegação, clique em Repositórios de dados.
  
  Acessar a página Repositórios de dados
2. Clique no nome do seu repositório de dados.
3. Na página Dados do seu repositório de dados, encontre o ID do repositório.
Crie um app de pesquisa e conecte-o a um repositório de dados. Um repositório de dados só pode ser anexado a um app e não pode ser removido dele mais tarde.

**Termo-chave**: na Pesquisa de agentes, o termo app pode ser usado de forma intercambiável com o termo mecanismo no contexto das APIs.
```
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "displayName": "APP_DISPLAY_NAME",
  "dataStoreIds": ["DATA_STORE_ID"],
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "industryVertical": "GENERIC",
  "searchEngineConfig": {
     "searchTier": "SEARCH_TIER",
     "searchAddOns": ["SEARCH_ADD_ON"]
   }
}'
```
Substitua:
- PROJECT_ID: o ID do Google Cloud projeto.
- APP_ID: o ID do app da Pesquisa de agentes que você quer criar.
- APP_DISPLAY_NAME: o nome de exibição do app da Pesquisa de agentes que você quer criar.
- DATA_STORE_ID: o ID de um repositório de dados da Pesquisa de agentes que você quer adicionar ao app da Pesquisa de agentes.
- SEARCH_TIER: o nível de pesquisa pode ser SEARCH_TIER_STANDARD ou SEARCH_TIER_ENTERPRISE. SEARCH_TIER_ENTERPRISE é necessário para ter acesso a recursos como pesquisa em sites e escolha de uma região para o app. Os recursos da edição Enterprise geram custos adicionais. Para mais informações, consulte Recursos da edição Enterprise.
- SEARCH_ADD_ON: se você quiser respostas generativas com recursos avançados de LLM para esse app, especifique SEARCH_ADD_ON_LLM. As respostas generativas incluem resumos de pesquisa e pesquisa com acompanhamentos.
  
  Se você não quiser respostas generativas, especifique SEARCH_ADD_ON_UNSPECIFIED como o complemento de pesquisa ou remova o campo searchAddOns.
  
  Para mais informações, consulte Respostas generativas.
Observação: O segmento do setor GENERIC é usado para criar apps de pesquisa personalizados que contêm repositórios de dados estruturados, não estruturados, de sites ou vários repositórios de dados (pesquisa combinada).

Python

Para mais informações, consulte a documentação de referência da API da Pesquisa de agentes.Python

Para autenticar na Pesquisa de agentes, configure o Application Default Credentials. Se quiser mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.

from typing import List

from google.api_core.client_options import ClientOptions
from google.cloud import discoveryengine_v1 as discoveryengine

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"
# location = "YOUR_LOCATION" # Values: "global"
# engine_id = "YOUR_ENGINE_ID"
# data_store_ids = ["YOUR_DATA_STORE_ID"]


def create_engine_sample(
    project_id: str, location: str, engine_id: str, data_store_ids: List[str]
) -> str:
    #  For more information, refer to:
    # https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
    client_options = (
        ClientOptions(api_endpoint=f"{location}-discoveryengine.googleapis.com")
        if location != "global"
        else None
    )

    # Create a client
    client = discoveryengine.EngineServiceClient(client_options=client_options)

    # The full resource name of the collection
    # e.g. projects/{project}/locations/{location}/collections/default_collection
    parent = client.collection_path(
        project=project_id,
        location=location,
        collection="default_collection",
    )

    engine = discoveryengine.Engine(
        display_name="Test Engine",
        # Options: GENERIC, MEDIA, HEALTHCARE_FHIR
        industry_vertical=discoveryengine.IndustryVertical.GENERIC,
        # Options: SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT
        solution_type=discoveryengine.SolutionType.SOLUTION_TYPE_SEARCH,
        # For search apps only
        search_engine_config=discoveryengine.Engine.SearchEngineConfig(
            # Options: SEARCH_TIER_STANDARD, SEARCH_TIER_ENTERPRISE
            search_tier=discoveryengine.SearchTier.SEARCH_TIER_ENTERPRISE,
            # Options: SEARCH_ADD_ON_LLM, SEARCH_ADD_ON_UNSPECIFIED
            search_add_ons=[discoveryengine.SearchAddOn.SEARCH_ADD_ON_LLM],
        ),
        # For generic recommendation apps only
        # similar_documents_config=discoveryengine.Engine.SimilarDocumentsEngineConfig,
        data_store_ids=data_store_ids,
    )

    request = discoveryengine.CreateEngineRequest(
        parent=parent,
        engine=engine,
        engine_id=engine_id,
    )

    # Make the request
    operation = client.create_engine(request=request)

    print(f"Waiting for operation to complete: {operation.operation.name}")
    response = operation.result()

    # After the operation is complete,
    # get information from operation metadata
    metadata = discoveryengine.CreateEngineMetadata(operation.metadata)

    # Handle the response
    print(response)
    print(metadata)

    return operation.operation.name

Terraform

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform. Para mais informações, consulte a Terraform documentação de referência do provedor.

Para criar um app de pesquisa usando o Terraform, consulte discovery_engine_search_engine.

A seguir

Receber resultados da pesquisa.
Adicionar o widget de pesquisa a uma página da Web.
Decidir se você precisa configurar preços configuráveis para seu app.