문서 다시 설정(미리 보기 REST API)

  • 아티클

적용 대상: 2023-07-01-Preview, 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview

중요

2023-07-01-Preview(변경 내용 없음).

2021-04-30-Preview(변경 내용 없음).

2020-06-30-Preview(변경 내용 없음).

2019-05-06-Preview는 초기화 시나리오에 대한 지원을 추가합니다.

문서 재설정은 비동기 API입니다. 이를 통해 데이터 원본에서 문서를 선택적으로 다시 처리할 수 있습니다.

API는 두 가지 유형의 문서 식별자를 입력으로 허용합니다. 문서 키(검색 인덱스에서 문서를 고유하게 식별하는 키) 및 데이터 원본 문서 식별자(데이터 원본에서 문서를 고유하게 식별하는 키)입니다. API를 호출하면 인덱서 메타데이터로 다시 설정할 문서 키 또는 데이터 원본 문서 식별자가 추가됩니다. 인덱서의 다음 예약 또는 주문형 실행 시 인덱서는 다시 설정 문서만 처리합니다.

  • 기술 세트 및 증분 보강이 사용하도록 설정된 인덱서의 경우 API는 캐시를 지우고 지정된 문서에 대한 전체 기술 세트를 다시 실행합니다.
  • 기술 세트가 없는 인덱서의 경우 API는 데이터 원본에서 원본 문서를 읽고 인덱스에 콘텐츠를 업데이트/삽입합니다.

문서 키를 사용하여 문서를 재설정하고 문서 키가 인덱서 필드 매핑에서 참조되는 경우 인덱서는 필드 매핑을 사용하여 기본 데이터 원본에서 적절한 필드를 찾습니다.

API는 기술 세트가 있거나 없는 모든 인덱서에 대해 작동합니다. HTTP POST 요청을 사용하여 호출할 수 있습니다. 호출이 성공하면 204 NoContent 응답이 표시됩니다. 요청 URI에서 업데이트할 인덱서의 이름을 지정합니다.

POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

URI 매개 변수

매개 변수 Description
서비스 이름 필수 사항입니다. 검색 서비스의 고유한 사용자 정의 이름으로 설정합니다.
인덱서 이름 필수 사항입니다. 요청 URI는 업데이트할 인덱서의 이름을 지정합니다.
api-version 필수 사항입니다. 현재 미리 보기 버전은 입니다 2023-07-01-Preview. 더 많은 버전은 API 버전을 참조하세요.
overwrite 선택 사항입니다. 이 매개 변수는 연속 문서 다시 설정 작업이 결합되거나 덮어쓰여지는지를 결정합니다. 기본값은 false입니다. false이면 문서 키 또는 데이터 원본 문서 식별자의 호출 페이로드가 재처리를 위해 이미 큐에 대기 중인 키 목록에 추가됩니다. true이면 키를 null로 설정하는 경우 다시 설정 문서 목록을 지우는 등 문서 키 또는 데이터 원본 문서 식별자의 호출 페이로드가 기존 목록을 덮어씁 수 있습니다.

요청 헤더

다음 표에서는 필수 요청 헤더와 선택적 요청 헤더에 대해 설명합니다.

필드 Description
콘텐츠 형식 필수 사항입니다. application/json
api-key Azure 역할을 사용하고 요청에 전달자 토큰이 제공된 경우 선택 사항이며, 그렇지 않으면 키가 필요합니다. api-key는 검색 서비스에 대한 요청을 인증하는 고유한 시스템 생성 문자열입니다. 다시 설정 요청에는 쿼리 키와 api-key 달리 관리자 키로 설정된 헤더가 포함되어야 합니다. 자세한 내용은 키 인증을 사용하여 Azure AI Search에 연결을 참조하세요.

요청 본문

본문에는 인덱서가 데이터 원본에서 찾는 문서 키 목록 또는 데이터 원본 문서 식별자 목록이 포함되어야 합니다.

다음 JSON은 정의의 기본 부분에 대한 개략적인 표현입니다.

{
    "documentKeys" : [
        "key1",
        "key2",
        "key3"
    ],
    "datasourceDocumentIds" : [
        "key1",
        "key2",
        "key3"
    ],
}

요청에는 다음 속성이 포함되며 "documentKeys" 및 "datasourceDocumentIds" 중 하나만 제공되어야 합니다.

속성 Description
documentKeys 인덱서가 데이터 원본에서 선택적으로 다시 처리하는 문서 키 집합입니다. 기본적으로 이 작업을 여러 번 호출하면 문서 키 집합이 함께 추가됩니다. 이 동작은 덮어쓰기 URI 매개 변수를 통해 추가하지 않고 덮어쓰도록 변경할 수 있습니다(위 참조). 인덱서가 다시 설정 문서 처리를 중지하려면 "documentKeys"를 빈 목록 "[]"으로 설정할 수 있습니다. 이로 인해 인덱서가 높은 워터마크에 따라 일반 인덱싱을 재개합니다. 존재하지 않는 잘못된 문서 키 또는 문서 키는 무시됩니다.
datasourceDocumentIds 인덱서가 데이터 원본에서 선택적으로 다시 처리하는 데이터 원본 문서 식별자 집합입니다. 기본적으로 이 작업을 여러 번 호출하면 데이터 원본 문서 식별자가 함께 설정됩니다. 이 동작은 덮어쓰기 URI 매개 변수를 통해 추가하지 않고 덮어쓰도록 변경할 수 있습니다(위 참조). 인덱서가 다시 설정 문서 처리를 중지하려면 "datasourceDocumentIds"를 빈 목록 "[]"으로 설정할 수 있습니다. 이로 인해 인덱서가 높은 워터마크에 따라 일반 인덱싱을 재개합니다. 존재하지 않는 잘못된 데이터 원본 문서 식별자 또는 데이터 원본 문서 식별자는 무시됩니다.

응답

204 성공적인 요청에 대한 콘텐츠가 없습니다.

참고 항목