Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Esta página
se aplica à Apigee e à Apigee híbrida.
Este tópico descreve como usar a Pesquisa semântica com a tecnologia Vertex AI e opções de pesquisa baseadas em filtros para pesquisar recursos específicos no hub da API.
Figura 1. O hub de APIs oferece recursos poderosos de pesquisa e filtro de linguagem natural.
Pesquisar o hub de APIs usando a pesquisa semântica
É fácil encontrar e acessar os recursos da API registrados no hub de APIs usando a pesquisa semântica. A pesquisa semântica permite
que você pesquise todos os recursos de API disponíveis na sua instância usando uma consulta de pesquisa de texto livre. É possível pesquisar em todos os tipos de entidade (APIs, operações de API, especificações etc.)
ou especifique o tipo de entidade que você quer consultar.
Com o mecanismo de pesquisa da Vertex AI, a Pesquisa semântica pode ir além do termo "correspondência". A pesquisa semântica retorna resultados
contendo termos encontrados em qualquer lugar nas entradas detalhadas do recurso da API que são semanticamente semelhantes às consultas de pesquisa de texto livre inseridas.
A pesquisa de texto livre retorna as seguintes categorias de resultados:
APIs: uma lista de APIs que correspondem à pesquisa. Para cada API, são fornecidos os seguintes detalhes:
O nome da API com um link para a página de detalhes dela.
Uma breve descrição do recurso.
O nome e o endereço de e-mail do proprietário do recurso.
Versões: uma lista de versões da API que correspondem à pesquisa. Para cada versão, são fornecidos os seguintes detalhes:
Os nomes das APIs associadas à versão, com um link que leva à página de detalhes da API.
O nome da versão da API, com um link que leva à página de detalhes da versão.
A descrição da versão e os metadados relacionados.
Especificações: uma lista de especificações da API que correspondem à pesquisa. Para cada especificação, são fornecidos os seguintes detalhes:
Os nomes da API associada à especificação, com um link que leva à página de detalhes da API.
O nome da especificação da API, com um link que leva à página de detalhes da versão associada
à especificação.
A descrição da especificação.
Um link para o documento de especificação.
O tipo de especificação, como a especificação OpenAPI.
Operações: uma lista de operações de API que correspondem à pesquisa. Para cada operação, os seguintes detalhes são
fornecidos:
Os nomes da API associada à operação, com um link que leva à página de detalhes da API.
O nome da operação, com um link que leva à página de detalhes da versão associada à operação.
A descrição da especificação.
Um link para o documento de especificação que define a operação.
Um link para a versão que inclui a operação.
Deployments: uma lista de implantações que correspondem à pesquisa. Para cada implantação, os seguintes detalhes são
fornecidos:
O nome da implantação.
A descrição da implantação.
O tipo de implantação. Por exemplo, a Apigee híbrida.
Um link para a versão que inclui a implantação.
Para pesquisar APIs que contêm um termo específico:
No console do Google Cloud, acesse a página Pesquisa semântica do hub de APIs.
Digite uma consulta de pesquisa na caixa de pesquisa.
Por exemplo, você pode inserir "APIs de gerenciamento de pedidos" ou "Arquivo de especificações para as configurações da operadora sem fio".
Você pode refinar sua pesquisa usando atributos do sistema no prompt da consulta de pesquisa. Se você criou
atributos de usuário ao registrar suas APIs no hub de API, também será possível incorporar esses atributos nos prompts de consulta de pesquisa.
Os resultados da pesquisa são categorizados nas seguintes guias: APIs, Versões, Especificações, Operações e Implantações. Clique em uma das guias para conferir os resultados de uma categoria. Os resultados mostram recursos de API que contêm termos semanticamente semelhantes
à consulta de pesquisa inserida.
Clique no nome do recurso de API para acessar a página de detalhes dele.
Para limpar a consulta atual, clique em Limpar resultados.
Hub da API de Pesquisa usando a API
Também é possível pesquisar os recursos do hub da API usando a API Hub. O método searchResources
permite consultar os recursos do hub da API usando consultas e filtros de texto livre.
É possível usar a seguinte chamada de API para pesquisar nos recursos do hub de API:
PROJECT_ID é o ID do projeto host da instância do hub da API.
LOCATION é o local onde a instância do hub da API está hospedada.
QUERY é a consulta de texto livre a ser usada na pesquisa. A consulta pode conter palavras-chave
relacionadas a qualquer detalhe do recurso do hub da API, incluindo nomes de exibição, descrições ou outros metadados.
RESOURCE_TYPE é o filtro opcional especificado para sua pesquisa. É possível especificar um dos
seguintes tipos de recurso do hub de API como filtro:
Api
ApiOperation
Deployment
Definition
Spec
Version
Por exemplo:
curl-XPOSThttps://apihub.googleapis.com/v1/projects/{project-id}/locations/{location}:searchResources \-H"Authorization: Bearer $(gcloud auth print-access-token)"-H"Content-Type: application/json"\
-d'{"query":"dog status in the store","filter":"resource_type = SPEC"}'
Essa chamada retorna uma lista paginada de recursos do hub da API com metadados específicos do recurso.
Para mais informações sobre a pesquisa de texto livre com a API Hub da API, consulte a documentação de referência da API para Method:project.locations.searchResources.
Opções de pesquisa baseadas em filtros
Você pode refinar a lista de APIs exibida na página APIs usando atributos do sistema como parâmetros de pesquisa.
Personalize
a lista de recursos da API exibida usando uma das seguintes opções:
Usando a pesquisa de lista baseada em filtros, é possível otimizar a lista de APIs com base em vários parâmetros predefinidos e
atributos do sistema associados ao recurso. Você pode usar as opções Match ALL ou Match ANY
para personalizar a visualização com filtro.
Para especificar as opções de filtro, faça o seguinte:
No console do Google Cloud, acesse a página de APIs do hub das APIs.
Clique no campo Filtrar tabela para filtrar a tabela. O painel Filtro será aberto.
Especifique ou selecione as opções de filtro. Quando você digita no painel "Filtro", um menu com opções de filtro aparece e inclui uma
lista de atributos do sistema relevantes para o contexto atual. Por
exemplo, estes são os atributos do sistema que podem aparecer ao filtrar as APIs na página APIs:
Nome da API: o nome de exibição da API
Unidade de negócios:a unidade de negócios responsável por uma API
Equipe: a equipe de produção responsável por uma API
Documentação: um link curto para a documentação da API.
Os atributos do sistema aparecem na lista de filtros nas tabelas APIs, Versões e Especificações.
Após selecionar uma opção de filtro, selecione um valor na lista Valores. Como alternativa,
você pode inserir um valor para o atributo de filtro selecionado.
Para adicionar mais um filtro, clique no campo Filtrar tabela para selecionar um dos Operadores disponíveis e selecione outro
atributo e valor de filtro.
As propriedades de filtro selecionadas exibem a lógica condicional que a consulta de filtro está usando. Você pode selecionar OR como operador. Se nenhum operador for selecionado, o padrão será AND.
Para limpar um filtro individual, clique no X no filtro.
Para limpar todos os filtros, clique em Limpar tudo no painel Filtro.
Paginação
Quando há vários recursos de API, eles podem aparecer em diversas páginas.
Para personalizar a exibição da lista e navegar entre as páginas:
No console do Google Cloud, acesse a página de APIs do hub das APIs.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-28 UTC."],[[["\u003cp\u003eThis page outlines how to use Semantic Search, powered by Vertex AI, and filter-based options to efficiently search for resources within Apigee and Apigee hybrid's API hub.\u003c/p\u003e\n"],["\u003cp\u003eSemantic Search enables free-text queries to find APIs, versions, specifications, operations, and deployments based on semantically similar terms found in the API resource entries.\u003c/p\u003e\n"],["\u003cp\u003eUsers can search using system or user attributes and refine search results by filtering and clicking on categories in the results, such as APIs, Versions, Specifications, Operations, and Deployments.\u003c/p\u003e\n"],["\u003cp\u003eYou can also use an API call to search resources, where you can specify a query and filter the results by resource type.\u003c/p\u003e\n"],["\u003cp\u003eFilter options allow you to narrow the displayed APIs based on attributes like API name, business unit, team, and documentation, with the ability to use \u003ccode\u003eMatch ALL\u003c/code\u003e or \u003ccode\u003eMatch ANY\u003c/code\u003e criteria.\u003c/p\u003e\n"]]],[],null,["# Search for and filter APIs\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\nThis topic describes how to use Semantic Search powered by [Vertex AI](/vertex-ai/docs) and filter-based search options to search\nfor specific resources in API hub.\n**Figure 1.** API hub provides powerful natural language search and filter features.\n\nSearch API hub using Semantic Search\n------------------------------------\n\nYou can easily find and view API resources registered in your API hub using Semantic Search. Semantic Search allows\nyou to search all available API resources in your instance using a *free-text search query*. You can search across all entity types (APIs, API operations, specifications, and more.),\nor specify the entity type that you want to query.\n\nWith its Vertex AI search engine, Semantic Search can go beyond term \"matching.\" Semantic Search returns results\ncontaining terms found anywhere in the detailed API resource entries that are semantically similar to the free text search queries entered.\n\nFree-text search returns the following categories of results:\n\n- **APIs** : A list of APIs that match the search. For each API, the following details are provided:\n - The name of the API with a link to the API details page.\n - A brief description of the resource.\n - The name and email address of the resource owner.\n- **Versions** : A list of API versions that match the search. For each version, the following details are provided:\n - The names of the APIs associated with the version, with a link that takes you to the API details page.\n - The name of the API version, with a link that takes you to the version details page.\n - The description of the version and related metadata.\n- **Specifications** : A list of API specifications that match the search. For each specification, the following details are provided:\n - The names of the API associated with the specification, with a link that takes you to the API details page.\n - The name of the API specification, with a link that takes you to the version details page associated with the specification.\n - The description of the specification.\n - A link to the specification document.\n - The type of specification, such as OpenAPI spec.\n- **Operations** : A list of API operations that match the search. For each operation, the following details are provided:\n - The names of the API associated with the operation, with a link that takes you to the API details page.\n - The name of the operation, with a link that takes you to the version details page associated with the operation.\n - The description of the specification.\n - A link to the specification document that defines the operation.\n - A link to the version that includes the operation.\n- **Deployments** : A list of deployments that match the search. For each deployment, the following details are provided:\n - The name of the deployment.\n - The description of the deployment.\n - The deployment type. For example, Apigee hybrid.\n - A link to the version that includes the deployment.\n\n\u003cbr /\u003e\n\nTo search for APIs containing a specific term:\n\n1. In the Google Cloud console, go to the API hub **Semantic search** page.\n\n [Go to API hub](https://console.cloud.google.com//apigee/api-hub/search)\n2. Type a search query in the search box.\n\n For example, you could enter \"Order management APIs\" or \"Spec file for wireless carrier settings\".\n\n You can refine your search by using [system attributes](/apigee/docs/apihub/manage-attributes#system-attributes) within your search query prompt. If you created\n [user attributes](/apigee/docs/apihub/manage-attributes#user-attributes) when registering your APIs in API hub, you can also incorporate these attributes in your search query prompts.\n3. The **Search results** are categorized under the following tabs: APIs, Versions, Specifications, Operations, and Deployments. Click one of the tabs to see results for a category. The results display API resources that contain terms semantically similar to the search query you entered.\n4. Click the API resource name to view the detail page for the resource.\n5. To clear the current query, click **Clear results**.\n\nSearch API hub using the API\n----------------------------\n\nYou can also search your API hub resources using the API hub API. The `searchResources` method\nallows you to query your API hub resources using free text queries and filters.\n\nYou can use the following API call to search across your API hub resources: \n\n```carbon\ncurl -X POST https://apihub.googleapis.com/v1/projects/\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e/locations/\u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e:searchResources \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" -H \"Content-Type: application/json\" \\\n -d '{\n \"query\":\"\u003cvar translate=\"no\"\u003eQUERY\u003c/var\u003e\",\n \"filter\":\"resource_type = \u003cvar translate=\"no\"\u003eRESOURCE_TYPE\u003c/var\u003e\"\n }'\n```\n\nWhere:\n\n- **PROJECT_ID** is the ID of the host project for your API hub instance.\n- **LOCATION** is the location where your API hub instance is hosted.\n- **QUERY** is the free text query to be used in the search. The query can contain keywords related to any detail of the API hub resource, including display names, descriptions, or other metadata..\n- **RESOURCE_TYPE** is the optional filter specified for your search. You can specify one of the following API hub resource types as a filter:\n - `Api`\n - `ApiOperation`\n - `Deployment`\n - `Definition`\n - `Spec`\n - `Version`\n\n\u003cbr /\u003e\n\nFor example: \n\n```carbon\ncurl -X POST https://apihub.googleapis.com/v1/projects/{project-id}/locations/{location}:searchResources \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" -H \"Content-Type: application/json\" \\\n -d '{\n \"query\":\"dog status in the store\",\n \"filter\":\"resource_type = SPEC\"\n }'\n```\n\nThis call returns a paginated list of API hub resources, with resource-specific metadata.\n\nFor more information on free-text search with the API hub API, see the API reference documentation for\n[`Method:project.locations.searchResources`](/apigee/docs/reference/apis/apihub/rest/v1/projects.locations/searchResources).\n\nFilter-based search options\n---------------------------\n\n\u003cbr /\u003e\n\nYou can refine the list of APIs displayed on the **APIs** page by using system attributes as search parameters.\nCustomize\nthe list of API resources displayed using one of the following:\n\n- [Filter](#filter)\n- [Pagination](#pagination)\n\n### Filter\n\nUsing the filter-based list search, you can streamline your APIs list based on a number of predefined parameters and\nsystem attributes associated with the resource. You can use the `Match ALL` or `Match ANY` options\nto customize your filtered view.\n| **Note:** The filter options available are configured by a user with [administrator permissions](/apigee/docs/apihub/iam-roles). For more information, see [Manage API hub settings](/apigee/docs/apihub/settings-overview) and [Manage attributes](/apigee/docs/apihub/manage-attributes).\n\n\nTo specify filter options:\n\n1. In the Google Cloud console, go to the API hub **APIs** page.\n\n [Go to API hub APIs](https://console.cloud.google.com//apigee/api-hub/apis)\n2. Click in the **Filter table** field to filter the table. The **Filter** pane opens. **Tip:**You can show or hide columns in the APIs table. Use the action menu in the Filter row to select and unselect row names.\n3. Specify or select filter options. When you type in the Filter pane, a menu with filter options pops up that includes a list of [system attributes](/apigee/docs/apihub/manage-attributes#system-attributes) that are relevant to the current context. For example, these are system attributes that you may see when filtering the APIs in the **APIs** page:\n - **API name**: The display name of the API\n - **Business unit:** The business unit responsible for an API\n - **Team:** The producing team responsible for an API\n - **Documentation**: A short link to the API documentation.\n | **Note:** There may be additional attributes listed as filter options. For more information, see [Manage API attributes](/apigee/docs/apihub/manage-attributes).\n - You'll see system attributes in the filter list in the **APIs** , **Versions** , and **Specifications** tables.\n4. After selecting a filter option, select a filter value from the **Values** list. Alternatively, you can enter a value for the filter attribute you select.\n5. To add an additional filter, click in the **Filter table** field to select from the available **Operators** and then select another filter attribute and value.\n6. The selected filter properties display the conditional\n logic that the filter query is using. You can select `OR` as an operator. If no\n operator is selected, the default is `AND`.\n\n7. To clear an individual filter, click the **X** on the filter. To clear all filters, click **Clear all** in the **Filter** pane.\n\n### Pagination\n\nWhen there are multiple API resources, they may be displayed across multiple pages.\n\nTo customize the list display and navigate between pages:\n\n1. In the Google Cloud console, go to the API hub **APIs** page.\n\n [Go to API hub APIs](https://console.cloud.google.com//apigee/api-hub/apis)\n\n The **APIs** list page is displayed by default.\n2. From the **APIs** list, locate the pagination tools\n as shown in Figure 2:\n\n **Figure 2.** Move back and forth through paginated results.\n3. Select the number of APIs to display per page.\n4. Click **\\\u003e Forward**to go to the next page.\n5. Click**\\\u003c Back**to go to the previous page.\n\nWhat's next?\n------------\n\n- Learn how to [Manage deployments](/apigee/docs/apihub/manage-api-deployments)."]]
