Code Search Results - Fetch Code Search Results

참조

Service:: Search

API Version:: 7.1-preview.1

검색 텍스트에 대한 결과 집합을 제공합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path		string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.1'로 설정해야 합니다.

요청 본문

Name	형식	Description
$orderBy	SortOption[]	검색 결과를 정렬하는 옵션입니다. null로 설정하면 결과가 관련성별로 정렬된 상태로 반환됩니다. 둘 이상의 정렬 옵션이 제공되면 결과는 OrderBy에 지정된 순서대로 정렬됩니다.
$skip	integer	건너뛸 결과 수입니다.
$top	integer	반환할 결과 수입니다.
filters	object	적용할 필터입니다. 적용할 필터가 없는 경우 null로 설정합니다.
includeFacets	boolean	결과에서 패싯을 선택하는 플래그입니다. 기본 동작은 false입니다.
includeSnippet	boolean	일치하는 코드 조각을 결과에 포함하도록 선택하는 플래그입니다. 기본 동작은 false입니다.
searchText	string	검색 텍스트입니다.

응답

Name	형식	Description
200 OK	CodeSearchResponse	성공한 작업

보안

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

Name	Description
vso.code	커밋, 변경 집합, 분기 및 기타 버전 제어 아티팩트에 대한 소스 코드 및 메타데이터를 읽을 수 있는 기능을 부여합니다. 또한 서비스 후크를 통해 코드를 검색하고 버전 제어 이벤트에 대한 알림을 받을 수 있는 기능도 부여합니다.

예제

Sample Request

HTTP

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

{
  "searchText": "CodeSearchController",
  "$skip": 0,
  "$top": 1,
  "filters": {
    "Project": [
      "MyFirstProject"
    ],
    "Repository": [
      "MyFirstProject"
    ],
    "Path": [
      "/"
    ],
    "Branch": [
      "master"
    ],
    "CodeElement": [
      "def",
      "class"
    ]
  },
  "$orderBy": [
    {
      "field": "filename",
      "sortOrder": "ASC"
    }
  ],
  "includeFacets": true
}

Sample Response

Status code:: 200

{
  "count": 1,
  "results": [
    {
      "fileName": "CodeSearchController.cs",
      "path": "/CodeSearchController.cs",
      "matches": {
        "content": [
          {
            "charOffset": 1187,
            "length": 20
          },
          {
            "charOffset": 1395,
            "length": 20
          },
          {
            "charOffset": 1686,
            "length": 20
          }
        ],
        "fileName": [
          {
            "charOffset": 0,
            "length": -1
          }
        ]
      },
      "collection": {
        "name": "DefaultCollection"
      },
      "project": {
        "name": "MyFirstProject",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "repository": {
        "name": "MyFirstProject",
        "id": "c1548045-29f6-4354-8114-55ef058be1a3",
        "type": "git"
      },
      "versions": [
        {
          "branchName": "master",
          "changeId": "47e1cc8877baea4b7bb33af803d6cc697914f88b"
        }
      ],
      "contentId": "004898f1ad91c9c2a0f492f2d1174468bc3c84ef"
    }
  ],
  "infoCode": 0,
  "facets": {
    "Project": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "Repository": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "CodeElement": [
      {
        "name": "Class",
        "id": "class",
        "resultCount": 1
      },
      {
        "name": "Comment",
        "id": "comment",
        "resultCount": 1
      },
      {
        "name": "Definition",
        "id": "def",
        "resultCount": 1
      }
    ]
  }
}

정의

Name	Description
CodeResult	검색된 파일 및 해당 메타데이터의 정보를 포함하는 코드 결과를 정의합니다.
CodeSearchRequest	코드 검색 요청을 정의합니다.
CodeSearchResponse	코드 검색 응답 항목을 정의합니다.
Collection	컬렉션의 세부 정보를 정의합니다.
Project	프로젝트의 세부 정보를 정의합니다.
Repository	리포지토리의 세부 정보를 정의합니다.
SortOption	결과를 정렬하는 방법을 정의합니다.
Version	결과 파일의 버전과 관련된 세부 정보를 설명합니다.
VersionControlType	결과 파일의 버전 제어 형식입니다.

CodeResult

검색된 파일 및 해당 메타데이터의 정보를 포함하는 코드 결과를 정의합니다.

Name	형식	Description
collection	Collection	결과 파일의 컬렉션입니다.
contentId	string	결과 파일의 ContentId입니다.
fileName	string	결과 파일의 이름입니다.
matches	object	결과 파일에서 오프셋을 적중할 필드의 사전입니다. 키는 적중 항목이 발견된 영역을 식별합니다(예: 파일 콘텐츠/파일 이름 등).
path	string	결과 파일이 있는 경로입니다.
project	Project	결과 파일의 프로젝트입니다.
repository	Repository	결과 파일의 리포지토리입니다.
versions	Version[]	결과 파일의 버전입니다.

CodeSearchRequest

코드 검색 요청을 정의합니다.

Name	형식	Description
$orderBy	SortOption[]	검색 결과를 정렬하는 옵션입니다. null로 설정하면 결과가 관련성별로 정렬된 상태로 반환됩니다. 둘 이상의 정렬 옵션이 제공되면 결과는 OrderBy에 지정된 순서대로 정렬됩니다.
$skip	integer	건너뛸 결과 수입니다.
$top	integer	반환할 결과 수입니다.
filters	object	적용할 필터입니다. 적용할 필터가 없는 경우 null로 설정합니다.
includeFacets	boolean	결과에서 패싯을 선택하는 플래그입니다. 기본 동작은 false입니다.
includeSnippet	boolean	일치하는 코드 조각을 결과에 포함하도록 선택하는 플래그입니다. 기본 동작은 false입니다.
searchText	string	검색 텍스트입니다.

CodeSearchResponse

코드 검색 응답 항목을 정의합니다.

Name	형식	Description
count	integer	일치하는 총 파일 수입니다.
facets	object	각 패싯에 대해 개체 배열 `Filter` 을 저장하는 사전입니다.
infoCode	integer	추가 정보를 나타내는 숫자 코드: 0 - 확인, 1 - 계정이 다시 인덱싱되고 있습니다. 2 - 계정 인덱싱이 시작되지 않음, 3 - 잘못된 요청, 4 - 접두사 와일드카드 쿼리가 지원되지 않음, 5 - 코드 패싯이 지원되지 않는 MultiWords, 6 - 계정이 온보딩되고 있습니다, 7 - 계정이 온보딩되거나 다시 인덱싱되고, 8 - 최대 업데이트 허용 9로 트리밍된 최상위 값 - 분기가 인덱싱되고 있습니다. 10 - 패싯을 사용할 수 없음, 11 - 작업 항목에 액세스할 수 없음, 19 - 코드 형식 필터가 지원되지 않는 구 쿼리, 20 - 코드 형식 필터가 지원되지 않는 와일드카드 쿼리. 다른 정보 코드는 내부 용도로 사용됩니다.
results	CodeResult[]	일치하는 파일 목록입니다.

Collection

컬렉션의 세부 정보를 정의합니다.

Name	형식	Description
name	string	컬렉션의 이름입니다.

Project

프로젝트의 세부 정보를 정의합니다.

Name	형식	Description
id	string	프로젝트의 ID입니다.
name	string	프로젝트의 이름입니다.

Repository

리포지토리의 세부 정보를 정의합니다.

Name	형식	Description
id	string	리포지토리의 ID입니다.
name	string	리포지토리의 이름입니다.
type	VersionControlType	결과 파일의 버전 제어 형식입니다.

SortOption

결과를 정렬하는 방법을 정의합니다.

Name	형식	Description
field	string	정렬을 수행할 필드 이름입니다.
sortOrder	string	결과를 정렬해야 하는 순서(ASC/DESC)입니다.

Version

결과 파일의 버전과 관련된 세부 정보를 설명합니다.

Name	형식	Description
branchName	string	분기의 이름입니다.
changeId	string	이 일치 항목과 연결된 지정된 분기의 ChangeId입니다.

VersionControlType

결과 파일의 버전 제어 형식입니다.

Name	형식	Description
custom	string	내부적으로만 사용할 수 있습니다.
git	string
tfvc	string

다음을 통해 공유