SearchClient 클래스

Azure Search 인덱스에서 검색 자동 완성 결과를 가져옵니다.

인덱스 정의의 일부인 컬렉션입니다. :키워드(keyword) 모드: 자동 완성 모드를 지정합니다. 기본값은 'oneTerm'입니다. 사용

대상 포진을 가져오는 'twoTerms'와 자동 완성 용어를 생성하는 동안 현재 컨텍스트를 사용하는 'oneTermWithContext'. 가능한 값으로는 'oneTerm', 'twoTerms', 'oneTermWithContext'가 있습니다.

autocomplete(search_text: str, suggester_name: str, *, mode: str | AutocompleteMode | None = None, use_fuzzy_matching: bool | None = None, highlight_post_tag: str | None = None, highlight_pre_tag: str | None = None, minimum_coverage: float | None = None, search_fields: List[str] | None = None, top: int | None = None, **kwargs) -> List[Dict]

매개 변수

반환 형식

예제

자동 완성을 가져옵니다.

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient

   search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

   results = search_client.autocomplete(search_text="bo", suggester_name="sg")

   print("Autocomplete suggestions for 'bo'")
   for result in results:
       print("    Completion: {}".format(result["text"]))

세션을 닫습니다 SearchClient .

close() -> None

Azure 검색 인덱스에서 문서 삭제

삭제는 인덱스에서 지정된 문서를 제거합니다. 키 필드 이외의 삭제 작업에서 지정한 모든 필드는 무시됩니다. 문서에서 개별 필드를 제거하려면 대신 merge_documents 사용하고 필드를 명시적으로 없음으로 설정합니다.

삭제 작업은 idempotent입니다. 즉, 문서 키가 인덱스에 없더라도 해당 키로 삭제 작업을 시도하면 200 상태 코드가 발생합니다.

delete_documents(documents: List[Dict], **kwargs: Any) -> List[IndexingResult]

매개 변수

반환

IndexingResult 목록

반환 형식

예제

인덱스로 기존 문서 삭제

   result = search_client.delete_documents(documents=[{"hotelId": "1000"}])

   print("Delete new document succeeded: {}".format(result[0].succeeded))

Azure 검색 인덱스에서 해당 키로 문서를 검색합니다.

get_document(key: str, selected_fields: List[str] | None = None, **kwargs: Any) -> Dict

매개 변수

반환

Azure 검색 인덱스로 저장된 문서

반환 형식

예제

검색 인덱스에서 특정 문서를 가져옵니다.

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient

   search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

   result = search_client.get_document(key="23")

   print("Details for hotel '23' are:")
   print("        Name: {}".format(result["hotelName"]))
   print("      Rating: {}".format(result["rating"]))
   print("    Category: {}".format(result["category"]))

Azure 검색 인덱스의 문서 수를 반환합니다.

get_document_count(**kwargs: Any) -> int

반환

인덱스의 문서 수

반환 형식

일괄 처리로 수행할 문서 작업을 지정합니다.

:발생 시킵니다 RequestEntityTooLargeError

index_documents(batch: IndexDocumentsBatch, **kwargs: Any) -> List[IndexingResult]

매개 변수

반환

IndexingResult 목록

반환 형식

의 문서를 Azure 검색 인덱스에서 기존 문서에 병합합니다.

병합에서는 기존 문서를 지정한 필드로 업데이트합니다. 문서가 없으면 병합하지 못합니다. 문서의 기존 필드는 병합에서 지정하는 필드로 바뀝니다. 이는 기본 형식 및 복합 형식의 컬렉션에도 적용됩니다.

merge_documents(documents: List[Dict], **kwargs: Any) -> List[IndexingResult]

매개 변수

반환

IndexingResult 목록

반환 형식

예제

필드를 기존 문서에 인덱스로 병합

   result = search_client.merge_documents(documents=[{"hotelId": "1000", "rating": 4.5}])

   print("Merge into new document succeeded: {}".format(result[0].succeeded))

의 문서를 Azure 검색 인덱스에서 기존 문서에 병합하거나 아직 없는 경우 업로드합니다.

이 작업은 지정된 키가 있는 문서가 인덱스에 이미 있는 경우 merge_documents 것처럼 동작합니다. 문서가 없으면 새 문서가 있는 upload_documents 것처럼 동작합니다.

merge_or_upload_documents(documents: List[Dict], **kwargs: Any) -> List[IndexingResult]

매개 변수

반환

IndexingResult 목록

반환 형식

Azure 검색 인덱스에서 문서를 검색합니다.

search(search_text: str | None = None, *, include_total_count: bool | None = None, facets: List[str] | None = None, filter: str | None = None, highlight_fields: str | None = None, highlight_post_tag: str | None = None, highlight_pre_tag: str | None = None, minimum_coverage: float | None = None, order_by: List[str] | None = None, query_type: str | QueryType | None = None, scoring_parameters: List[str] | None = None, scoring_profile: str | None = None, search_fields: List[str] | None = None, search_mode: str | SearchMode | None = None, query_answer: str | QueryAnswerType | None = None, query_answer_count: int | None = None, query_answer_threshold: float | None = None, query_caption: str | QueryCaptionType | None = None, query_caption_highlight_enabled: bool | None = None, semantic_configuration_name: str | None = None, select: List[str] | None = None, skip: int | None = None, top: int | None = None, scoring_statistics: str | ScoringStatistics | None = None, session_id: str | None = None, vector_queries: List[VectorQuery] | None = None, vector_filter_mode: str | VectorFilterMode | None = None, semantic_error_mode: str | SemanticErrorMode | None = None, semantic_max_wait_in_milliseconds: int | None = None, **kwargs: Any) -> SearchItemPaged[Dict]

매개 변수

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient

   search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

   results = search_client.search(search_text="WiFi", facets=["category,count:3", "parkingIncluded"])

   facets: Dict[str, List[str]] = cast(Dict[str, List[str]], results.get_facets())

   print("Catgory facet counts for hotels:")
   for facet in facets["category"]:
       print("    {}".format(facet))