Składnia $select OData w usłudze Wyszukiwanie AI platformy Azure

Uwaga

Wyszukiwanie AI platformy Azure jest dostępna za pośrednictwem portalu Azure, interfejsów API REST i Azure SDKs. Jest także podstawą Foundry IQ — zarządzanej warstwy wiedzy, która przekształca treści przedsiębiorstwa w bazy wiedzy wielokrotnego użytku z uwzględnieniem uprawnień dla agentów w portalu Microsoft Foundry.

W usłudze Wyszukiwanie AI platformy Azure parametr $select określa pola do uwzględnienia w wynikach wyszukiwania. W tym artykule opisano składnię OData $select i przedstawiono przykłady.

Konstrukcja i stałe ścieżki pola są opisane w omówieniu języka OData w usłudze Wyszukiwanie AI platformy Azure. Aby uzyskać więcej informacji na temat kompozycji wyników wyszukiwania, zobacz Jak pracować z wynikami wyszukiwania w usłudze Wyszukiwanie AI platformy Azure.

Składnia

Parametr $select określa, które pola dla każdego dokumentu są zwracane w zestawie wyników zapytania. Następujący formularz EBNF (rozszerzony formularz Backus-Naur) definiuje gramatykę dla parametru $select :

select_expression ::= '*' | field_path(',' field_path)*

field_path ::= identifier('/'identifier)*

Dostępny jest również interakcyjny diagram składni:

Diagram składni OData dla usługi Wyszukiwanie AI platformy Azure

Uwaga

Zobacz dokumentację składni wyrażeń OData dla usługi Wyszukiwanie AI platformy Azure, aby zobaczyć pełen EBNF.

Parametr $select jest dostępny w dwóch formach:

  1. Pojedyncza gwiazdka (*), wskazująca, że wszystkie pola, które można pobrać, powinny zostać zwrócone lub
  2. Rozdzielona przecinkami lista ścieżek pól identyfikujących pola, które powinny być zwracane.

Korzystając z drugiego formularza, można określić w liście tylko pola, które można pobrać.

Jeśli wyświetlisz pole złożone bez jawnego określenia pól podrzędnych, wszystkie pola podrzędne, które można pobrać, zostaną uwzględnione w zestawie wyników zapytania. Załóżmy na przykład, że indeks zawiera pole Address z polami podrzędnymi Street, City i Country, które są możliwe do pobrania. Jeśli określisz Addressw $select, wyniki zapytania będą zawierać wszystkie trzy pola podrzędne.

Przykłady

Uwzględnij HotelId, HotelName i Rating pola najwyższego poziomu w wynikach i uwzględnij City pole podrzędne:Address

    $select=HotelId, HotelName, Rating, Address/City

Przykładowy wynik może wyglądać następująco:

{
  "HotelId": "1",
  "HotelName": "Stay-Kay City Hotel",
  "Rating": 4,
  "Address": {
    "City": "New York"
  }
}

Uwzględnij w wynikach pole HotelName najwyższego poziomu. Uwzględnij wszystkie pola podrzędne Address. Uwzględnij Type pola dodatkowe BaseRate każdego obiektu w kolekcji Rooms.

    $select=HotelName, Address, Rooms/Type, Rooms/BaseRate

Przykładowy wynik może wyglądać następująco:

{
  "HotelName": "Stay-Kay City Hotel",
  "Rating": 4,
  "Address": {
    "StreetAddress": "677 5th Ave",
    "City": "New York",
    "StateProvince": "NY",
    "Country": "USA",
    "PostalCode": "10022"
  },
  "Rooms": [
    {
      "Type": "Budget Room",
      "BaseRate": 9.69
    },
    {
      "Type": "Budget Room",
      "BaseRate": 8.09
    }
  ]
}

Następne kroki

  • Last updated on