Wiki Search Results - Fetch Wiki Search Results

Referência

Service:: Search

API Version:: 7.1-preview.1

Fornece um conjunto de resultados para a solicitação de pesquisa.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/wikisearchresults?api-version=7.1-preview.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path		string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

Respostas

Nome	Tipo	Description
200 OK	WikiSearchResponse	operação bem-sucedida

Segurança

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nome	Description
vso.wiki	Concede a capacidade de ler wikis, páginas wiki e anexos wiki. Também concede a capacidade de pesquisar páginas wiki.

Exemplos

Sample Request

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/wikisearchresults?api-version=7.1-preview.1

{
  "searchText": "Hello",
  "$skip": 0,
  "$top": 2,
  "filters": {
    "Project": [
      "Search",
      "Release"
    ]
  },
  "$orderBy": null,
  "includeFacets": true
}

Sample Response

Status code:: 200

{
  "count": 1,
  "results": [
    {
      "fileName": "Hello-world.md",
      "path": "/Hello-world.md",
      "collection": {
        "name": "test"
      },
      "project": {
        "id": "9811862e-ec6f-4e94-93bd-91555b51eedd",
        "name": "Release",
        "visibility": null
      },
      "wiki": {
        "id": "9c2aeff2-bab0-43e9-9eaa-bf8283be064b",
        "mappedPath": "/",
        "name": "Release.wiki",
        "version": "wikiMaster"
      },
      "contentId": "70c379b63ffa0795fdbfbc128e5a2818397b7ef8",
      "hits": [
        {
          "fieldReferenceName": "fileNames",
          "highlights": [
            "<highlighthit>Hello</highlighthit>-world.md"
          ]
        },
        {
          "fieldReferenceName": "content",
          "highlights": [
            "<highlighthit>Hello</highlighthit> world"
          ]
        }
      ]
    }
  ],
  "infoCode": 0,
  "facets": {
    "Project": [
      {
        "name": "Search",
        "id": "Search",
        "resultCount": 0
      },
      {
        "name": "Release",
        "id": "Release",
        "resultCount": 1
      }
    ]
  }
}

Definições

Nome	Description
Collection	Define os detalhes da coleção.
ProjectReference	Define os detalhes do projeto.
SortOption	Define como classificar o resultado.
Wiki	Define os detalhes do wiki.
WikiHit	Define os termos correspondentes no campo do resultado wiki.
WikiResult	Define o resultado wiki que correspondeu a uma solicitação de pesquisa wiki.
WikiSearchRequest	Define uma solicitação de pesquisa wiki.
WikiSearchResponse	Define um item de resposta de pesquisa wiki.

Collection

Define os detalhes da coleção.

Nome	Tipo	Description
name	string	Nome da coleção.

ProjectReference

Define os detalhes do projeto.

Nome	Tipo	Description
id	string	ID do projeto.
name	string	Nome do projeto.
visibility	string	Visibilidade do projeto.

SortOption

Define como classificar o resultado.

Nome	Tipo	Description
field	string	Nome do campo no qual a classificação deve ser feita.
sortOrder	string	Ordem (ASC/DESC) na qual os resultados devem ser classificados.

Wiki

Define os detalhes do wiki.

Nome	Tipo	Description
id	string	Id do wiki.
mappedPath	string	Caminho mapeado para o wiki.
name	string	Nome do wiki.
version	string	Versão do wiki.

WikiHit

Define os termos correspondentes no campo do resultado wiki.

Nome	Tipo	Description
fieldReferenceName	string	Nome de referência do campo realçado.
highlights	string[]	Snippets correspondentes/realçados do campo.

WikiResult

Define o resultado wiki que correspondeu a uma solicitação de pesquisa wiki.

Nome	Tipo	Description
collection	Collection	Coleção do arquivo de resultado.
contentId	string	ContentId do arquivo de resultado.
fileName	string	Nome do arquivo de resultado.
hits	WikiHit[]	Snippets de código realçados de campos que correspondem à solicitação de pesquisa. A lista é classificada por relevância dos snippets.
path	string	Caminho no qual o arquivo de resultado está presente.
project	ProjectReference	Detalhes do projeto do documento wiki.
wiki	Wiki	Informações do wiki para o resultado.

WikiSearchRequest

Define uma solicitação de pesquisa wiki.

Nome	Tipo	Description
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

WikiSearchResponse

Define um item de resposta de pesquisa wiki.

Nome	Tipo	Description
count	integer	Número total de documentos wiki correspondentes.
facets	object	Um dicionário que armazena uma matriz de `Filter` objeto em cada faceta.
infoCode	integer	Código numérico que indica qualquer informação adicional: 0 – Ok, 1 – A conta está sendo reindexada, 2 – A indexação de conta não foi iniciada, 3 – Solicitação Inválida, 4 – Não há suporte para consulta curinga de prefixo, 5 – MultiWords com faceta de código sem suporte, 6 – a conta está sendo integrada, 7 – a conta está sendo integrada ou reindexada, 8 – Valor superior cortado para maxresult permitido 9 – Branches estão sendo indexados, 10 – Faceta não habilitada, 11 – Itens de trabalho não acessíveis, 19 – Consultas de frase com filtros de tipo de código sem suporte, 20 – Consultas curinga com filtros de tipo de código sem suporte. Qualquer outro código de informações é usado para fins internos.
results	WikiResult[]	Lista dos principais documentos wiki correspondentes.

Compartilhar via