Documents - Search Post

Поиск документов в индексе.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-04-01

Параметры URI

Имя В Обязательно Тип Описание
endpoint
path True

string (uri)

URL-адрес конечной точки службы поиска.

indexName
path True

string

Имя индекса.

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Заголовок запроса

Имя Обязательно Тип Описание
Accept

Accept

Заголовок Accept.

x-ms-client-request-id

string (uuid)

Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Текст запроса

Имя Тип Описание
answers

QueryAnswerType

Значение, указывающее, следует ли возвращать ответы как часть ответа поиска.

captions

QueryCaptionType

Значение, указывающее, должны ли возвращаться заголовки в ответе на поиск.

count

boolean

Значение, указывающее, следует ли получить общее количество результатов. По умолчанию — false. Если задать значение true, это значение может повлиять на производительность. Обратите внимание, что возвращаемое число является приблизительный.

debug

QueryDebugMode

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов с измененным рейтингом.

facets

string[]

Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспектов содержит имя поля, за которым следует список пар name:value, разделенный запятыми.

filter

string

Выражение OData $filter, применяемое к поисковому запросу.

highlight

string

Список имен полей, разделенных запятыми, используемых для выделения попаданий. Для выделения попаданий можно использовать только поля, доступные для поиска.

highlightPostTag

string

Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Значение по умолчанию — </em>.

highlightPreTag

string

Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. По умолчанию используется <em>.

minimumCoverage

number (double)

Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию равно 100.

orderby

string

Разделенный запятыми список OData $orderby выражения, по которым сортируются результаты. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.

queryType

QueryType

Значение, указывающее синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте значение full, если запрос использует синтаксис запроса Lucene.

scoringParameters

string[]

Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием значений имени формата. Например, если профиль оценки определяет функцию с параметром с именем mylocation, строка параметра будет "mylocation--122.2,44.8" (без кавычки).

scoringProfile

string

Имя профиля оценки для оценки показателей для сопоставления документов для сортировки результатов.

scoringStatistics

ScoringStatistics

Значение, указывающее, хотим ли мы вычислять статистику оценки (например, частоту выпуска документов) глобально для более стабильной оценки или локально для более низкой задержки. Значение по умолчанию — 'local'. Используйте 'global' для агрегирования статистики подсчета очков глобально перед подсчетом очков. Использование глобальной статистики скоринга может увеличить задержку поисковых запросов.

search

string

Выражение запроса полнотекстового поиска; Используйте "*" или опустите этот параметр, чтобы сопоставить все документы.

searchFields

string

Список имен полей, разделенных запятыми, в которых выполняется полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.

searchMode

SearchMode

Значение, указывающее, должны ли совпадать все или все условия поиска, чтобы подсчитать документ как совпадение.

select

string

Список полей, разделенных запятыми, для извлечения. Если не указано, все поля, помеченные как извлекаемые в схеме, включаются.

semanticConfiguration

string

Имя семантической конфигурации, которая будет использоваться при обработке документов для запросов семантики типа.

semanticErrorHandling

SemanticErrorMode

Позволяет пользователю выбрать, должен ли семантический вызов завершиться полным сбоем (поведение по умолчанию / текущее) или возвращать частичные результаты.

semanticMaxWaitInMilliseconds

integer (int32)

minimum: 700

Позволяет пользователю задать верхнюю границу на время, которое требуется для завершения обработки семантического обогащения до сбоя запроса.

semanticQuery

string

Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических подписей и семантических ответов. Полезно для сценариев, когда требуется использовать различные запросы между базовым этапом извлечения и ранжирования, а также семантической фазой L2.

sessionId

string

Значение, используемое для создания закрепленного сеанса, который может помочь получить более стабильные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".

skip

integer (int32)

Количество пропущенных результатов поиска. Это значение не может быть больше 100 000. Если вам нужно сканировать документы в последовательности, но не удается пропустить из-за этого ограничения, рекомендуется использовать orderby на полностью упорядоченном ключе и фильтровать с помощью запроса диапазона.

top

integer (int32)

Количество полученных результатов поиска. Это можно использовать в сочетании с $skip для реализации разбиения по страницам на стороне клиента результатов поиска. Если результаты усечены из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска на следующую страницу результатов.

vectorFilterMode

VectorFilterMode

Определяет, применяются ли фильтры до или после выполнения векторного поиска. По умолчанию для новых индексов используется 'preFilter'.

vectorQueries VectorQuery[]:

Параметры запроса для векторных и гибридных поисковых запросов.

Ответы

Имя Тип Описание
200 OK

SearchDocumentsResult

Запрос выполнен успешно.

Other Status Codes

SearchDocumentsResult

Успешно

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя Описание
https://search.azure.com/.default

Примеры

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Образец запроса

POST https://exampleservice.search.windows.net/indexes('test-index')/docs/search.post.search?api-version=2026-04-01


{
  "count": true,
  "facets": [
    "ownerId",
    "price,metric:sum,default:10"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "oversampling": 20,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Пример ответа

{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}
{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "This is a caption from the document.",
          "highlights": "This is a <em>caption</em> from the document."
        }
      ],
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Образец запроса

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Пример ответа

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01"
}
{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01"
}

Определения

Имя Описание
Accept

Заголовок Accept.

DocumentDebugInfo

Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

QueryAnswerResult

Ответ — это текст, извлеченный из содержимого наиболее релевантных документов, соответствующих запросу. Ответы извлекаются из лучших результатов поиска. Кандидаты на ответы оцениваются и выбираются лучшие ответы.

QueryAnswerType

Этот параметр действителен только в том случае, если тип запроса равен semantic. Если задано, запрос возвращает ответы, извлеченные из ключевых фрагментов в документах с наивысшим рейтингом. Количество возвращаемых ответов можно настроить, добавив символ | вертикальной черты count-<number of answers> , за которым следует опция после значения параметра answers, например extractive|count-3, . По умолчанию счетчик — 1. Порог достоверности можно настроить, добавив символ | вертикальной черты, за которым следует threshold-<confidence threshold> опция после значения параметра answers, например extractive|threshold-0.9, . Порог по умолчанию равен 0,7. Максимальную длину символов ответов можно настроить, добавив символ вертикальной черты '|', за которым следует 'count-number< of maximum character length>', например 'extractive|maxcharlength-600'.

QueryCaptionResult

Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Заголовки возвращаются только для запросов типа semantic.

QueryCaptionType

Этот параметр действителен только в том случае, если тип запроса равен semantic. Если задано, запрос возвращает заголовки, извлеченные из ключевых проходов в документах с наивысшим рейтингом. Если для параметра Captions задано значение extractive, выделение включено по умолчанию, и его можно настроить, добавив символ | вертикальной черты, за которым следует параметр, highlight-<true/false> например extractive|highlight-true. По умолчанию — None. Максимальную длину символов заголовков можно настроить, добавив символ вертикальной черты '|', за которым следует 'count-number< of maximum character length>', например 'extractive|maxcharlength-600'.

QueryDebugMode

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска. Вы можете включить несколько режимов отладки одновременно, разделив их с помощью | , например: semantic|queryRewrites.

QueryResultDocumentSubscores

Разбивка подкордер между компонентами текстовых и векторных запросов для этого документа. Каждый векторный запрос отображается как отдельный объект в том же порядке, что и они были получены.

QueryType

Указывает синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте 'full', если в вашем запросе используется синтаксис запроса Lucene, и 'semantic', если синтаксис запроса не нужен.

ScoringStatistics

Значение, указывающее, хотим ли мы вычислять статистику оценки (например, частоту выпуска документов) глобально для более стабильной оценки или локально для более низкой задержки. Значение по умолчанию — 'local'. Используйте 'global' для агрегирования статистики подсчета очков глобально перед подсчетом очков. Использование глобальной статистики скоринга может увеличить задержку поисковых запросов.

SearchDocumentsResult

Ответ, содержащий результаты поиска из индекса.

SearchMode

Указывает, должны ли быть сопоставлены некоторые или все условия поиска, чтобы документ считался совпадающим.

SearchRequest

Параметры фильтрации, сортировки, фасетирования, разбиения по страницам и других поведении поисковых запросов.

SearchResult

Содержит документ, найденный поисковым запросом, а также связанные метаданные.

SemanticErrorMode

Позволяет пользователю выбирать, должен ли семантический вызов полностью провалиться или вернуть частичные результаты.

SemanticErrorReason

Причина, по которой был возвращен частичный ответ на запрос семантического ранжирования.

SemanticSearchResultsType

Тип частичного ответа, который был возвращен для запроса семантического ранжирования.

SingleVectorFieldResult

Результат одного векторного поля. Both

TextResult

Оценка BM25 или Классическая оценка для текстовой части запроса.

VectorFilterMode

Определяет, применяются ли фильтры до или после выполнения векторного поиска.

VectorizableImageBinaryQuery

Параметры запроса, используемые для векторного поиска, когда предоставляется векторный двоичный файл в кодировке base 64 изображения, который необходимо векторизировать.

VectorizableImageUrlQuery

Параметры запроса, используемые для векторного поиска, если указан URL-адрес, представляющий значение изображения, которое должно быть векторизировано.

VectorizableTextQuery

Параметры запроса, используемые для векторного поиска, если задано текстовое значение, которое необходимо векторизировать.

VectorizedQuery

Параметры запроса, используемые для поиска векторов при предоставлении необработанного векторного значения.

VectorQueryKind

Тип выполняемого векторного запроса.

VectorsDebugInfo

«Содержит отладочную информацию, специфичную для векторного и гибридного поиска.»)

Accept

Заголовок Accept.

Значение Описание
application/json;odata.metadata=none

DocumentDebugInfo

Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.

Имя Тип Описание
vectors

VectorsDebugInfo

Содержит сведения об отладке, относящиеся к вектору и гибридному поиску.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

QueryAnswerResult

Ответ — это текст, извлеченный из содержимого наиболее релевантных документов, соответствующих запросу. Ответы извлекаются из лучших результатов поиска. Кандидаты на ответы оцениваются и выбираются лучшие ответы.

Имя Тип Описание
highlights

string

Тот же текст, что и в свойстве Text с выделенными текстовыми фразами, наиболее релевантными для запроса.

key

string

Ключ документа, из который был извлечен ответ.

score

number (double)

Значение оценки представляет, насколько релевантн ответ на запрос относительно других ответов, возвращаемых для запроса.

text

string

Текст, извлеченный из содержимого документа в качестве ответа.

QueryAnswerType

Этот параметр действителен только в том случае, если тип запроса равен semantic. Если задано, запрос возвращает ответы, извлеченные из ключевых фрагментов в документах с наивысшим рейтингом. Количество возвращаемых ответов можно настроить, добавив символ | вертикальной черты count-<number of answers> , за которым следует опция после значения параметра answers, например extractive|count-3, . По умолчанию счетчик — 1. Порог достоверности можно настроить, добавив символ | вертикальной черты, за которым следует threshold-<confidence threshold> опция после значения параметра answers, например extractive|threshold-0.9, . Порог по умолчанию равен 0,7. Максимальную длину символов ответов можно настроить, добавив символ вертикальной черты '|', за которым следует 'count-number< of maximum character length>', например 'extractive|maxcharlength-600'.

Значение Описание
none

Не возвращайте ответы на запрос.

extractive

Извлекает кандидатов ответов из содержимого документов, возвращаемых в ответ на запрос, выраженный как вопрос на естественном языке.

QueryCaptionResult

Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Заголовки возвращаются только для запросов типа semantic.

Имя Тип Описание
highlights

string

Тот же текст, что и в свойстве Text с выделенными фразами, наиболее релевантными для запроса.

text

string

Репрезентативный текст, извлеченный из документа, наиболее релевантного к поисковому запросу.

QueryCaptionType

Этот параметр действителен только в том случае, если тип запроса равен semantic. Если задано, запрос возвращает заголовки, извлеченные из ключевых проходов в документах с наивысшим рейтингом. Если для параметра Captions задано значение extractive, выделение включено по умолчанию, и его можно настроить, добавив символ | вертикальной черты, за которым следует параметр, highlight-<true/false> например extractive|highlight-true. По умолчанию — None. Максимальную длину символов заголовков можно настроить, добавив символ вертикальной черты '|', за которым следует 'count-number< of maximum character length>', например 'extractive|maxcharlength-600'.

Значение Описание
none

Не возвращайте заголовки для запроса.

extractive

Извлекает заголовки из соответствующих документов, содержащих фрагменты, относящиеся к поисковому запросу.

QueryDebugMode

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов поиска. Вы можете включить несколько режимов отладки одновременно, разделив их с помощью | , например: semantic|queryRewrites.

Значение Описание
disabled

Сведения об отладке запросов не будут возвращены.

semantic

Позволяет пользователю более подробно изучить результаты повторного выполнения.

vector

Позволяет пользователю более подробно изучить результаты гибридных и векторных запросов.

queryRewrites

Позволяет пользователю просматривать список перезаписей запросов, созданных для запроса поиска.

innerHits

Позволяет пользователю получать информацию об оценке векторов, сопоставленных в коллекции сложных типов.

all

Включите все параметры отладки.

QueryResultDocumentSubscores

Разбивка подкордер между компонентами текстовых и векторных запросов для этого документа. Каждый векторный запрос отображается как отдельный объект в том же порядке, что и они были получены.

Имя Тип Описание
documentBoost

number (double)

Оценка BM25 или Классическая оценка для текстовой части запроса.

text

TextResult

Оценка BM25 или Классическая оценка для текстовой части запроса.

vectors

<string,  SingleVectorFieldResult>

Векторное сходство и

QueryType

Указывает синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте 'full', если в вашем запросе используется синтаксис запроса Lucene, и 'semantic', если синтаксис запроса не нужен.

Значение Описание
simple

Использует простой синтаксис запросов для поиска. Текст поиска интерпретируется с помощью простого языка запросов, который позволяет использовать такие символы, как +, * и "". По умолчанию запросы оцениваются по всем полям, доступным для поиска, если не указан параметр searchFields.

full

Использует полный синтаксис запросов Lucene для поиска. Текст поиска интерпретируется с помощью языка запросов Lucene, который позволяет выполнять поиск по конкретным полям и взвешенный поиск, а также использовать другие расширенные функции.

semantic

Лучше всего подходит для запросов, выраженных на естественном языке, а не ключевых слов. Повышает точность результатов поиска за счет повторного ранжирования верхних результатов поиска с помощью модели ранжирования, обученной на веб-корпусе.

ScoringStatistics

Значение, указывающее, хотим ли мы вычислять статистику оценки (например, частоту выпуска документов) глобально для более стабильной оценки или локально для более низкой задержки. Значение по умолчанию — 'local'. Используйте 'global' для агрегирования статистики подсчета очков глобально перед подсчетом очков. Использование глобальной статистики скоринга может увеличить задержку поисковых запросов.

Значение Описание
local

Статистика оценки будет рассчитываться локально для снижения задержки.

global

Статистика подсчета очков будет рассчитываться глобально для более последовательного подсчета очков.

SearchDocumentsResult

Ответ, содержащий результаты поиска из индекса.

Имя Тип Описание
@odata.count

integer (int64)

Общее количество результатов, найденных операцией поиска, или значение NULL, если число не было запрошено. При наличии число результатов в этом ответе может быть больше числа результатов. Это может произойти, если вы используете параметры $top или $skip, или если запрос не может вернуть все запрошенные документы в одном ответе.

@odata.nextLink

string

URL-адрес продолжения возвращается, когда запрос не может вернуть все запрошенные результаты в одном ответе. Вы можете использовать этот URL для формулирования другого поискового запроса GET или POST, чтобы получить следующую часть ответа на поиск. Убедитесь, что используется тот же глагол (GET или POST), что и в запросе, который вызвал этот ответ.

@search.answers

QueryAnswerResult[]

Результаты запроса ответов для операции поиска; Значение NULL, если параметр запроса ответов не указан или задан значение none.

@search.coverage

number (double)

Значение, указывающее процент индекса, который был включен в запрос, или значение NULL, если минимальное значениеCoverage не указано в запросе.

@search.facets

object

Результаты запроса аспектов для операции поиска, упорядоченные как коллекция контейнеров для каждого фасетного поля; Значение NULL, если запрос не включал никаких выражений аспектов.

@search.nextPageParameters

SearchRequest

Полезные данные продолжения JSON возвращаются, когда запрос не может вернуть все запрошенные результаты в одном ответе. Вы можете использовать этот JSON вместе с

@search.semanticPartialResponseReason

SemanticErrorReason

Причина, по которой был возвращен частичный ответ на запрос семантического ранжирования.

@search.semanticPartialResponseType

SemanticSearchResultsType

Тип частичного ответа, который был возвращен для запроса семантического ранжирования.

value

SearchResult[]

Последовательность результатов, возвращаемая запросом.

SearchMode

Указывает, должны ли быть сопоставлены некоторые или все условия поиска, чтобы документ считался совпадающим.

Значение Описание
any

Любой из поисковых запросов должен быть совпадающим, чтобы документ был засчитан как совпадающий.

all

Все условия поиска должны быть совпадающими, чтобы документ был засчитан как совпадающий.

SearchRequest

Параметры фильтрации, сортировки, фасетирования, разбиения по страницам и других поведении поисковых запросов.

Имя Тип Описание
answers

QueryAnswerType

Значение, указывающее, следует ли возвращать ответы как часть ответа поиска.

captions

QueryCaptionType

Значение, указывающее, должны ли возвращаться заголовки в ответе на поиск.

count

boolean

Значение, указывающее, следует ли получить общее количество результатов. По умолчанию — false. Если задать значение true, это значение может повлиять на производительность. Обратите внимание, что возвращаемое число является приблизительный.

debug

QueryDebugMode

Включает средство отладки, которое можно использовать для дальнейшего изучения результатов с измененным рейтингом.

facets

string[]

Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспектов содержит имя поля, за которым следует список пар name:value, разделенный запятыми.

filter

string

Выражение OData $filter, применяемое к поисковому запросу.

highlight

string

Список имен полей, разделенных запятыми, используемых для выделения попаданий. Для выделения попаданий можно использовать только поля, доступные для поиска.

highlightPostTag

string

Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Значение по умолчанию — </em>.

highlightPreTag

string

Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. По умолчанию используется <em>.

minimumCoverage

number (double)

Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию равно 100.

orderby

string

Разделенный запятыми список OData $orderby выражения, по которым сортируются результаты. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.

queryType

QueryType

Значение, указывающее синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте значение full, если запрос использует синтаксис запроса Lucene.

scoringParameters

string[]

Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием значений имени формата. Например, если профиль оценки определяет функцию с параметром с именем mylocation, строка параметра будет "mylocation--122.2,44.8" (без кавычки).

scoringProfile

string

Имя профиля оценки для оценки показателей для сопоставления документов для сортировки результатов.

scoringStatistics

ScoringStatistics

Значение, указывающее, хотим ли мы вычислять статистику оценки (например, частоту выпуска документов) глобально для более стабильной оценки или локально для более низкой задержки. Значение по умолчанию — 'local'. Используйте 'global' для агрегирования статистики подсчета очков глобально перед подсчетом очков. Использование глобальной статистики скоринга может увеличить задержку поисковых запросов.

search

string

Выражение запроса полнотекстового поиска; Используйте "*" или опустите этот параметр, чтобы сопоставить все документы.

searchFields

string

Список имен полей, разделенных запятыми, в которых выполняется полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.

searchMode

SearchMode

Значение, указывающее, должны ли совпадать все или все условия поиска, чтобы подсчитать документ как совпадение.

select

string

Список полей, разделенных запятыми, для извлечения. Если не указано, все поля, помеченные как извлекаемые в схеме, включаются.

semanticConfiguration

string

Имя семантической конфигурации, которая будет использоваться при обработке документов для запросов семантики типа.

semanticErrorHandling

SemanticErrorMode

Позволяет пользователю выбрать, должен ли семантический вызов завершиться полным сбоем (поведение по умолчанию / текущее) или возвращать частичные результаты.

semanticMaxWaitInMilliseconds

integer (int32)

minimum: 700

Позволяет пользователю задать верхнюю границу на время, которое требуется для завершения обработки семантического обогащения до сбоя запроса.

semanticQuery

string

Позволяет задать отдельный поисковый запрос, который будет использоваться исключительно для семантического повторения, семантических подписей и семантических ответов. Полезно для сценариев, когда требуется использовать различные запросы между базовым этапом извлечения и ранжирования, а также семантической фазой L2.

sessionId

string

Значение, используемое для создания закрепленного сеанса, который может помочь получить более стабильные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".

skip

integer (int32)

Количество пропущенных результатов поиска. Это значение не может быть больше 100 000. Если вам нужно сканировать документы в последовательности, но не удается пропустить из-за этого ограничения, рекомендуется использовать orderby на полностью упорядоченном ключе и фильтровать с помощью запроса диапазона.

top

integer (int32)

Количество полученных результатов поиска. Это можно использовать в сочетании с $skip для реализации разбиения по страницам на стороне клиента результатов поиска. Если результаты усечены из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска на следующую страницу результатов.

vectorFilterMode

VectorFilterMode

Определяет, применяются ли фильтры до или после выполнения векторного поиска. По умолчанию для новых индексов используется 'preFilter'.

vectorQueries VectorQuery[]:

Параметры запроса для векторных и гибридных поисковых запросов.

SearchResult

Содержит документ, найденный поисковым запросом, а также связанные метаданные.

Имя Тип Описание
@search.captions

QueryCaptionResult[]

Заголовки являются наиболее репрезентативными фрагментами документа относительно поискового запроса. Они часто используются в качестве сводки документов. Подписи возвращаются только для запросов типа 'semantic'.

@search.documentDebugInfo

DocumentDebugInfo

Содержит сведения об отладке, которые можно использовать для дальнейшего изучения результатов поиска.

@search.highlights

object

Текстовые фрагменты из документа, указывающие на соответствующие условия поиска, организованные по каждому применимому полю; null, если для запроса не было включено выделение хитов.

@search.rerankerBoostedScore

number (double)

Оценка релевантности, рассчитанная путем повышения Reranker Score. Результаты поиска сортируются по RerankerScore/RerankerBoostedScore на основе useScoringProfileBoostedRanking в Семантической конфигурации. RerankerBoostedScore возвращается только для запросов типа «семантическая».

@search.rerankerScore

number (double)

Оценка релевантности, рассчитанная семантическим ранжированием для первых результатов поиска. Результаты поиска сначала сортируются по RerankerScore, а затем по Score. RerankerScore возвращается только для запросов типа 'semantic'.

@search.score

number (double)

Оценка релевантности документа по сравнению с другими документами, возвращенными запросом.

SemanticErrorMode

Позволяет пользователю выбирать, должен ли семантический вызов полностью провалиться или вернуть частичные результаты.

Значение Описание
partial

Если семантическая обработка завершается ошибкой, частичные результаты по-прежнему возвращаются. Определение частичных результатов зависит от того, какой семантический шаг завершился сбоем и что было причиной сбоя.

fail

Если во время семантического этапа обработки существует исключение, запрос завершится ошибкой и возвращает соответствующий HTTP-код в зависимости от ошибки.

SemanticErrorReason

Причина, по которой был возвращен частичный ответ на запрос семантического ранжирования.

Значение Описание
maxWaitExceeded

Если semanticMaxWaitInMilliseconds задано, а длительность семантической обработки превысила это значение. Возвращены только базовые результаты.

capacityOverloaded

Запрос был регулированием. Возвращены только базовые результаты.

transient

Не удалось выполнить хотя бы один шаг семантического процесса.

SemanticSearchResultsType

Тип частичного ответа, который был возвращен для запроса семантического ранжирования.

Значение Описание
baseResults

Результаты без семантического обогащения или повторного использования.

rerankedResults

Результаты были восстановлены с помощью модели повторного рангера и будут включать семантические субтитры. Они не будут включать какие-либо ответы, выделения ответов или заголовки.

SingleVectorFieldResult

Результат одного векторного поля. Both

Имя Тип Описание
searchScore

number (double)

Тем

vectorSimilarity

number (double)

Оценка векторного сходства для этого документа. Обратите внимание, что это каноническое определение метрик сходства, а не "расстояние" версии. Например, косинусное сходство вместо косинусного расстояния.

TextResult

Оценка BM25 или Классическая оценка для текстовой части запроса.

Имя Тип Описание
searchScore

number (double)

Оценка BM25 или Классическая оценка для текстовой части запроса.

VectorFilterMode

Определяет, применяются ли фильтры до или после выполнения векторного поиска.

Значение Описание
postFilter

Фильтр будет применен после возврата набора кандидатов результатов вектора. В зависимости от избирательности фильтра это может привести к меньшему значению результатов, чем запрашивается параметром k.

preFilter

Фильтр будет применен перед поисковым запросом.

strictPostFilter

Фильтр будет применен после того, как будет возвращен глобальный набор векторных результатов top-k candidates. Это приведет к меньшему количеству результатов, чем запрашивает параметр 'k'.

VectorizableImageBinaryQuery

Параметры запроса, используемые для векторного поиска, когда предоставляется векторный двоичный файл в кодировке base 64 изображения, который необходимо векторизировать.

Имя Тип Описание
base64Image

string

Двоичный файл с основанием 64 изображения, который должен быть векторизован для выполнения векторного поискового запроса.

exhaustive

boolean

Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.

fields

string

Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.

k

integer (int32)

Число ближайших соседей, возвращаемых в качестве лучших хитов.

kind string:

imageBinary

Тип запроса.

oversampling

number (double)

Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.

weight

number (float)

Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorizableImageUrlQuery

Параметры запроса, используемые для векторного поиска, если указан URL-адрес, представляющий значение изображения, которое должно быть векторизировано.

Имя Тип Описание
exhaustive

boolean

Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.

fields

string

Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.

k

integer (int32)

Число ближайших соседей, возвращаемых в качестве лучших хитов.

kind string:

imageUrl

Тип запроса.

oversampling

number (double)

Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.

url

string

URL-адрес изображения, которое должно быть векторизовано для выполнения векторного поискового запроса.

weight

number (float)

Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorizableTextQuery

Параметры запроса, используемые для векторного поиска, если задано текстовое значение, которое необходимо векторизировать.

Имя Тип Описание
exhaustive

boolean

Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.

fields

string

Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.

k

integer (int32)

Число ближайших соседей, возвращаемых в качестве лучших хитов.

kind string:

text

Тип запроса.

oversampling

number (double)

Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.

text

string

Векторный текст для выполнения запроса векторного поиска.

weight

number (float)

Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorizedQuery

Параметры запроса, используемые для поиска векторов при предоставлении необработанного векторного значения.

Имя Тип Описание
exhaustive

boolean

Если значение true, активирует исчерпывающий поиск ближайших к соседей по всем векторам в индексе векторов. Полезно для сценариев, когда точные совпадения являются критически важными, например определение значений истины на земле.

fields

string

Векторные поля коллекции типов (Edm.Single), которые должны быть включены в векторный поиск.

k

integer (int32)

Число ближайших соседей, возвращаемых в качестве лучших хитов.

kind string:

vector

Тип запроса.

oversampling

number (double)

Превышение коэффициента. Минимальное значение — 1. Он переопределяет параметр defaultOversampling, настроенный в определении индекса. Его можно задать только в том случае, если параметр rerankWithOriginalVectors имеет значение true. Этот параметр допускается только в том случае, если метод сжатия используется в базовом поле вектора.

vector

number[] (float)

Векторное представление поискового запроса.

weight

number (float)

Относительный вес векторного запроса при сравнении с другими векторными запросами и/или текстовым запросом в том же запросе поиска. Это значение используется при объединении результатов нескольких списков ранжирования, созданных различными векторными запросами и (или) результатов, полученных с помощью текстового запроса. Чем выше вес, тем выше документы, соответствующие запросу, будут находиться в окончательном рейтинге. Значение по умолчанию равно 1.0, а значение должно быть положительным числом, превышающим нулю.

VectorQueryKind

Тип выполняемого векторного запроса.

Значение Описание
vector

Векторный запрос, в котором предоставляется необработанное векторное значение.

text

Векторный запрос, в котором предоставляется текстовое значение, необходимое для векторизации.

imageUrl

Векторный запрос, в котором предоставляется URL-адрес, представляющий значение изображения, которое необходимо векторизовать.

imageBinary

Векторный запрос, в котором предоставляется двоичный файл в кодировке по основанию 64 изображения, которое необходимо векторизовать.

VectorsDebugInfo

«Содержит отладочную информацию, специфичную для векторного и гибридного поиска.»)

Имя Тип Описание
subscores

QueryResultDocumentSubscores

Разбивка промежуточных оценок документа перед выбранным методом слияния/комбинирования наборов результатов, таким как RRF.