Udostępnij za pośrednictwem

Wersje interfejsu API REST (Azure AI Search)

  • Artykuł

W tym artykule wymieniono bieżące i wcześniejsze wersje interfejsów API REST wyszukiwania dla usługi Azure AI Search.

Dokumentacja wersji interfejsu API

Dokumentacja interfejsu API REST jest teraz wersjonowana. Po otwarciu strony dokumentacji interfejsu API nad spisem treści pojawi się selektor wersji. Upewnij się, że dokumentacja interfejsu API pochodzi z folderu Reference>Data Plane.

Zrzut ekranu przedstawiający selektor wersji.

Stabilne wersje

Wersja interfejsu API Specyfikacja Aktualizacje interfejsu API
2024-07-01 (najnowsza wersja) specyfikacji struktury Swagger informacje o wersji
2023-11-01 specyfikacji struktury Swagger informacje o wersji
2020-06-30 specyfikacji struktury Swagger informacje o wersji
2019-05-06 specyfikacji struktury Swagger Dodaje typy złożone.

Wersje wersji zapoznawczej

Wersje zapoznawcza są wydawane w celu testowania nowych funkcji, zbierania opinii i odnajdywania i rozwiązywania problemów. Interfejsy API w wersji zapoznawczej są dostępne w uzupełniających warunków użytkowania dla wersji zapoznawczych platformy Microsoft Azure.

Wersja interfejsu API Specyfikacja Aktualizacje interfejsu API
2024-11-01-preview (najnowsza wersja) specyfikacji struktury Swagger informacje o wersji
2024-09-01-preview specyfikacji struktury Swagger informacje o wersji
2024-05-01-preview specyfikacji struktury Swagger informacje o wersji
2024-03-01-preview specyfikacji struktury Swagger informacje o wersji
2023-10-01-preview specyfikacji struktury Swagger informacje o wersji
2023-07-01-preview (przestarzałe) specyfikacji struktury Swagger informacje o wersji
2021-04-30-preview specyfikacji struktury Swagger informacje o wersji
2020-06-30-preview specyfikacji struktury Swagger informacje o wersji
2019-05-06-preview specyfikacji struktury Swagger informacje o wersji

Wersji

2024-11-01-preview

Ta wersja zapoznawcza jest oparta na 2024-09-01-preview i obejmuje wszystkie funkcje obecnie dostępne w wersji zapoznawczej. Możesz uaktualnić z 2024-09-01-preview do 2024-11-01-preview z minimalnymi zmianami kodu. Aby uzyskać więcej informacji, zobacz Uaktualnianie interfejsów API REST.

Aktualizacja Odpowiedni interfejs API REST
Ponowne zapisywanie zapytań w semantycznym rerankerze, używane do uściślenia zapytań wysyłanych do klasyfikatora L2. wyszukaj dokumenty, nowa właściwość QueryRewritesType w żądaniu.
umiejętności układu dokumentu używane do analizowania dokumentu pod kątem struktury. tworzenie lub aktualizowanie zestawu umiejętności, nowe umiejętności DocumentIntelligenceLayoutSkill.
Tożsamość zarządzana dołączania zasobu wielousługowego usługi Azure AI. utwórz lub zaktualizuj zestaw umiejętności, nowa właściwość AIServicesAccountIdentity.
tryb analizowania języka Markdown, używany do indeksowania plików Markdown w usłudze Azure Storage. utwórz lub zaktualizuj indeksator, nowy tryb analizowania markdown.
opcje rescoring dla skompresowanych wektorów, używane do ponownegokorowania z oryginalnymi wektorami zamiast skompresowanych wektorów. Dotyczy algorytmów wektorów HNSW i wyczerpujących wektorów KNN przy użyciu kompresji binarnej i skalarnej. utwórz lub zaktualizujindeksu, nowe właściwości rescoringOptions. Nowa właściwość enableRescoring mapuje rerankWithOriginalVectors wprowadzone w wersji 2024-03-01-preview.

2024-09-01-preview

Ta wersja zapoznawcza jest oparta na 2024-05-01-preview i obejmuje wszystkie funkcje obecnie dostępne w wersji zapoznawczej. Możesz uaktualnić z 2024-05-01-preview do 2024-09-01-preview bez konieczności wprowadzania zmian w kodzie. Aby uzyskać więcej informacji, zobacz Uaktualnianie interfejsów API REST.

Aktualizacja Odpowiedni interfejs API REST
obcinane wymiary na potrzeby kwantyzacji uczenia reprezentacji matryoshka (MRL) w celu osadzenia tekstu w małych i 3-dużych modelach. utwórz lub zaktualizujindeksu , nowy parametr obcięciedimensionu
Podscores lub szczegóły oceniania dla rozpakowywania wyników wyszukiwania hybrydowego ocenianych przez wzajemnego łączenia rangi (RRF). search documents, nowe debugowanie parametrów i definicji podscore zapytania w odpowiedzi.
Filtrowanie docelowe do części wektorowej zapytania hybrydowego wyszukiwania. dokumenty wyszukiwania — nowy parametr filterOverride w RawVectorQuery, VectorizableTextQuery, VectorizableImageUrlQuery, VectorizableImageBinaryQuery.
Fragmentowanie tokenu w umiejętności dzielenia tekstu , a nie tylko znaki. utwórz lub zaktualizuj zestaw umiejętności, nowa jednostka parametr i inne właściwości związane z tokenem.

2024-07-01

Ta wersja zapewnia ogólnie dostępne aktualizacje zintegrowanej wektoryzacji (umiejętności i wektoryzatorów), kwantyzacji skalarnych i kwantyzacji binarnej. Aby uzyskać szczegółowe informacje, zobacz Co nowego w usłudze Azure AI Search.

Aktualizacja Odpowiedni interfejs API REST
Ogólnie dostępne — typy danych wektorów tworzenie lub aktualizowanie indeksu
Ogólnie dostępne — właściwości kwantyzacji wektorów wbudowanej kwantyzacji skalarnej lub binarnej w indeksie wyszukiwania. tworzenie lub aktualizowanie indeksu
Ogólnie dostępne — przechowywane właściwości w polu wektora , które określa, czy jest przechowywana dodatkowa kopia pola. Dodatkowa kopia jest pobieraną zawartością tego pola. Jeśli go nie przechowujesz, pole jest nadal używane w zapytaniach, ale nie można go zwrócić w wynikach wyszukiwania. Tę właściwość można ustawić, aby zaoszczędzić miejsce w usłudze wyszukiwania lub limitu przydziału wektorów w indeksie wyszukiwania. tworzenie lub aktualizowanie indeksu
Ogólnie dostępne — VectorizableTextQuery parametrów dostrajania istotności. Parametry zapytania hybrydowego (MaxTextSizeRecall) są nadal dostępne w wersji zapoznawczej. przeszukiwania dokumentów
Ogólnie dostępne — umiejętność azureOpenAIEmbedding do obsługi większej liczby modeli niż tylko osadzanie tekstu-ada-002 na potrzeby zintegrowanej wektoryzacji podczas indeksowania. Ustaw właściwości nazwy i wymiarów modelu, aby kierować go do określonego modelu. tworzenie lub aktualizowanie zestawu umiejętności
Ogólnie dostępne — wektoryzator osadzania usługi Azure OpenAI na potrzeby zintegrowanej wektoryzacji podczas zapytań. Właściwości wektoryzatora obsługują więcej modeli. tworzenie lub aktualizowanie indeksu
Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu. Wszystkie wersje

2024-05-01-preview

Ta wersja zapoznawcza dodaje obsługę indeksowania usługi OneLake, dostrajania istotności i dokładniejszej integracji z bardziej osadzanymi modelami podczas indeksowania i zapytań. Jest ona oparta na 2024-03-01-preview i obejmuje wszystkie funkcje obecnie w wersji zapoznawczej.

Aby przeprowadzić uaktualnienie z 2024-03-01-preview lub 2023-10-01-preview, zaktualizuj umiejętności azureOpenAIEmbedding lub wektoryzatora, aby uwzględnić nazwę i wymiary modelu. Aby uaktualnić z 2023-07-01-preview (przestarzałe) lub instrukcje krok po kroku, zobacz Uaktualnianie interfejsów API REST.

Poniżej przedstawiono aktualizacje w tej wersji zapoznawczej. Zalecamy również Co nowego w usłudze Azure AI Search.

Aktualizacja Odpowiedni interfejs API REST
Źródło danych indeksatora dla plików OneLake i skrótów. tworzenie lub aktualizowanie źródła danych
Collection(Edm.Byte)typ danych binarnych do osadzania modeli, które je obsługują. Definicje pól wektorowych obsługują ten typ danych. tworzenie lub aktualizowanie indeksu
Wiele wektorów i parametrów zapytania hybrydowego na potrzeby dostrajania istotności. Ustaw progi, aby wykluczyć niskie wyniki oceniania. Zapytania wektorów wagowych. W przypadku zapytań hybrydowych ustaw maksymalną liczbę dokumentów do pobrania w części tekstowej zapytania hybrydowego. przeszukiwania dokumentów
Nowa umiejętność przetwarzania obrazów sztucznej inteligencji na potrzeby wielomodalnej wektoryzacji zintegrowanej podczas indeksowania. Ta umiejętność wywołuje wielomodalny interfejs API usługi Azure AI Vision. tworzenie lub aktualizowanie zestawu umiejętności
Nowy wektoryzator usługi Azure AI Vision dla zapytań wielomodalnych. Wektoryzator jest określony w definicjach indeksu, ale używany podczas wykonywania zapytania. tworzenie lub aktualizowanie indeksu
Zaktualizowano umiejętności azureOpenAIEmbedding, aby obsługiwać więcej modeli niż tylko osadzanie tekstu-ada-002 w celu zintegrowanego wektoryzacji podczas indeksowania. Ustaw właściwości nazwy i wymiarów modelu, aby kierować go do określonego modelu. tworzenie lub aktualizowanie zestawu umiejętności
Zaktualizowano wektoryzator osadzania usługi Azure OpenAI pod kątem zintegrowanej wektoryzacji podczas wykonywania zapytań. Właściwości wektoryzatora obsługują więcej modeli. tworzenie lub aktualizowanie indeksu
Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu. Wszystkie wersje

2024-03-01-preview

Ta wersja zapoznawcza jest oparta na 2023-10-01-preview przez dodanie interfejsów API w wersji zapoznawczej zwiększających magazyn wektorów. Aby uzyskać szczegółowe informacje, zobacz Co nowego w usłudze Azure AI Search.

Aktualizacja Odpowiedni interfejs API REST
Nowe wąskie typy danych dla pól wektorów, jeśli masz osadzone modele obsługujące je lub logikę kwantyzacji, która generuje mniejsze wektory. tworzenie lub aktualizowanie indeksu
Nowe właściwości kwantyzacji wektorów dla wbudowanej kompresji wektorów w indeksie wyszukiwania. tworzenie lub aktualizowanie indeksu
Nowa wartość logiczna przechowywana właściwość w polu wektora , który określa, czy jest przechowywana dodatkowa kopia pola. Dodatkowa kopia jest pobieraną zawartością tego pola. Jeśli go nie przechowujesz, pole jest nadal używane w zapytaniach, ale nie można go zwrócić w wynikach wyszukiwania. Tę właściwość można ustawić, aby zaoszczędzić miejsce w usłudze wyszukiwania lub limitu przydziału wektorów w indeksie wyszukiwania. tworzenie lub aktualizowanie indeksu
Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu. Wszystkie wersje

2023-11-01

Ta wersja udostępnia ogólnie dostępne funkcje. Aby uzyskać szczegółowe informacje, zobacz Co nowego w usłudze Azure AI Search.

Aktualizacja Odpowiedni interfejs API REST
Semantyczna klasyfikacja w żądaniach post wyszukiwania. przeszukiwania dokumentów
Konfiguracja wyszukiwania wektorowego dla pól wektorów indeksowania tworzenie lub aktualizowanie indeksu
Zapytania wektorowe w żądaniach post wyszukiwania. przeszukiwania dokumentów
Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu. Wszystkie wersje

2023-10-01-preview

Ta wersja zawiera wszystkie funkcje wprowadzone w poprzednich wersjach zapoznawczych oraz dodatki i modyfikacje interfejsów API wyszukiwania wektorowego. Aktualizacje interfejsów API wyszukiwania wektorowego to zmiana powodująca niezgodność z wersji 2023-07-01-Preview. Aby uzyskać pomoc dotyczącą migracji, zobacz Dodawanie pól wektorów i Tworzenie zapytania wektorowego.

Jeśli planujesz używać nowej funkcji filtrowania wstępnego, musisz użyć indeksu utworzonego po 2023-10-01.

tworzenie lub aktualizowanieindeksu:

  • vectorSearch zawiera definicje algorithms, profilesi vectorizers:

    • algorithms nadal obsługuje hnsw, a teraz obsługuje również eknn, w odniesieniu do hierarchicznego nawigowalnego małego świata (HNSW) i wyczerpujących najbliższych sąsiadów (eKNN). W sekcji algorytmu można zdefiniować wiele nazwanych kombinacji parametrów HNSW i eKNN. Spowoduje to zastąpienie algorithmConfigurations we właściwości vectorSearch w wersji 2023-07-01-Preview.

    • profiles to nowa definicja określająca konfigurację algorytmu. Załóżmy na przykład, że masz konfiguracje algorytmów o nazwie HNSW-1, HSNW-2, eKNN-1. Profil może określać HNSW-1.

    • vectorizers jest definiowana w indeksie, ale używana w czasie zapytania do osadzania ciągu zapytania tekstowego. Wektoryzator odwołuje się do modelu osadzania. Usługa wyszukiwania wywołuje model osadzania w celu wektoryzacji ciągu zapytania tekstowego, a następnie przekazuje wynik do aparatu wyszukiwania dla zapytania wektorowego.

  • W polach wektorowych vectorSearchProfile zastępuje vectorSearchConfiguration. Właściwość vectorSearchProfile określa, który profil wyszukiwania wektorów ma być używany w polu.

  • W indeksach utworzonych przed tą wersją interfejsu API po wywołaniu interfejsu API 2023-10-01-Preview w żądaniu należy zmienić pole, aby określić vectorSearchProfile, o ile profil określa dokładnie ten sam algorytm określony wcześniej w vectorSearchConfiguration. Jeśli na przykład istniejąca definicja pola określa "vectorSearchConfiguration": "myHnsw", należy zastąpić ją "vectorSearchProfile": "your profile name", a profil musi być zdefiniowany w celu odwołania się do tego samego "algorithm": "myHnsw".

przeszukiwanie dokumentów:

  • vectorQueries zastępuje vectors w wersji 2023-07-01-Preview
  • vectorQueries.vectors zastępuje vectors.values w wersji 2023-07-01-Preview.
  • Zapytanie wektorowe jest teraz strukturą polimorficzną. kind należy określić, aby określić typ żądanego zapytania wektorowego. "kind": "vector" oznacza, że zapytanie jest wektorem, więc obiekt wywołujący powinien już wektoryzować ciąg zapytania wyszukiwania do wektorowego osadzania.
  • "exhaustive": "true" jest nową właściwością określa, czy wykonać wyczerpujące (siłowe) k najbliższego sąsiada wyszukiwania we wszystkich wektorach w indeksie wektorów.
  • vectorFilterMode to nowy parametr służący do określania wstępnego filtrowania (domyślnego dla indeksów utworzonych po 2023-10-01) lub pofiltrowaniu (domyślnie w poprzednich indeksach) w zapytaniu.

Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu.

2023-07-01-preview

Ważny

Nie używaj tej wersji interfejsu API. Wycofanie tej wersji zapoznawczej zostało ogłoszone 15 kwietnia 2024 r. i nie jest już obsługiwane po 8 lipca 2024 r. Aby uzyskać pomoc dotyczącą migracji, zobacz Uaktualnianie interfejsów API REST w usłudze Azure AI Search.

Ta wersja wprowadziła obsługę wektorów i używa konfiguracji wektorów, która jest niezgodna z nowszymi wersjami interfejsu API.

2021-04-30-preview

Ta wersja zapoznawcza zawiera wszystkie funkcje wprowadzone w wersji zapoznawczej 2020-06-30-Preview oraz dodatki do następujących interfejsów API:

2020-06-30

Ta wersja udostępnia ogólnie dostępne funkcje, w tym:

  • Kontrola dostępu oparta na rolach platformy Azure na potrzeby operacji płaszczyzny danych
  • Ocenianie istotności (BM25)
  • Magazyny wiedzy
  • Źródło danych indeksatora dla usługi Azure Data Lake Storage (ADLS) Gen2
  • Umiejętność wyszukiwania jednostek niestandardowych
  • Indeksatory działające w ramach tożsamości systemowej lub zarządzanej przez użytkownika za pośrednictwem identyfikatora Entra firmy Microsoft
  • Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu.

2020-06-30-preview

Ta wersja zapoznawcza zawiera wszystkie funkcje wprowadzone w wersji zapoznawczej 2019-05-06-Preview oraz następujące dodatki:

  • Wyszukiwanie semantyczne, funkcja premium uruchamiana w usługach warstwy Standardowa i wywołująca klasyfikację semantyczną.
  • Źródło danych indeksatora dla łączników dodatku Power Query
  • Źródło danych indeksatora dla programu MySQL
  • Źródło danych indeksatora dla interfejsu API języka Gremlin usługi Cosmos DB
  • Źródło danych indeksatora dla usługi SharePoint Online
  • Właściwość Normalizer dla normalizacji tekstu w przypadku filtrowania bez uwzględniania wielkości liter, tworzenia aspektów i sortowania
  • Resetowanie dokumentów do indeksowania opartego na indeksatorze w celu specjalnie odświeżenia określonych dokumentów według identyfikatora
  • Umiejętność poznawcza łączenia jednostek (wersja 3)
  • Umiejętność poznawcza rozpoznawania jednostek (wersja 3)
  • Umiejętność poznawcza analizy tonacji (wersja 3)
  • Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu.

2019-05-06-preview

  • Obsługa źródła danych indeksatora dla interfejsu API bazy danych MongoDB usługi Cosmos DB
  • Źródło danych indeksatora do usuwania nietrwałego w usłudze Blob Storage
  • featuresMode parametr, który zwraca szczegółowe informacje o wyniku istotności
  • Umiejętności poznawcze usługi Azure Machine Learning (AML)
  • Umiejętność poznawcza wykrywania identyfikacji osobistej
  • Buforowanie wzbogaconych dokumentów w celu zachowania i ponownego użycia przetwarzania obrazów (oraz innych wzbogacenia sztucznej inteligencji)
  • Od 29 marca 2024 r. odpowiedzi GET nie zwracają już parametrów połączenia ani kluczy. Aby uzyskać szczegółowe informacje, zobacz Zmiana powodująca niezgodność kodu klienta, który odczytuje informacje o połączeniu.

Zobacz też