Векторизатор пользовательского веб-API

Векторизатор пользовательского веб-API позволяет настроить поисковые запросы для вызова конечной точки веб-API, которая создает векторные представления во время выполнения запроса. Требуемая структура полезных данных JSON для конечной точки описана далее в этой статье. Данные обрабатываются в географии, где развернута модель.

Хотя векторизаторы используются во время запроса, вы указываете их в определениях индекса и ссылаетесь на них на поля векторов через профиль вектора. Дополнительные сведения см. в разделе "Настройка векторизатора" в индексе поиска.

Настраиваемый векторизатор веб-API называется WebApiVectorizer в REST API. Используйте последнюю стабильную версию Indexes — создание (REST API) или пакет пакета SDK Azure, который предоставляет эту функцию.

Параметры векторизатора

Параметры чувствительны к регистру.

Поддерживаемые типы векторных запросов

Векторизатор пользовательского веб-API поддерживает textи imageUrlimageBinaryвекторные запросы.

Пример определения

"vectorizers": [
    {
        "name": "my-custom-web-api-vectorizer",
        "kind": "customWebApi",
        "customWebApiParameters": {
            "uri": "https://contoso.embeddings.com",
            "httpMethod": "POST",
            "httpHeaders": {
                "api-key": "<your-header-value>"
            },
            "timeout": "PT60S",
            "authResourceId": null,
            "authIdentity": null
        }
    }
]

Обновление значений заголовков после GET

При получении определения индекса служба возвращает sentinel <redacted> для каждого httpHeaders значения в векторизаторе пользовательского веб-API. Рассмотрим пример.

{
    "name": "my-custom-web-api-vectorizer",
    "kind": "customWebApi",
    "customWebApiParameters": {
        "uri": "https://contoso.embeddings.com",
        "httpMethod": "POST",
        "httpHeaders": {
            "api-key": "<redacted>"
        },
        "timeout": "PT60S",
        "authResourceId": null,
        "authIdentity": null
    }
}

Чтобы повторно использовать сохраненное api-key значение, обновите тот же существующий векторизатор с тем же name и kindоставьте его uri неизменным и повторно отправьте sentinel для имени соответствующего заголовка:

{
    "name": "my-custom-web-api-vectorizer",
    "kind": "customWebApi",
    "customWebApiParameters": {
        "uri": "https://contoso.embeddings.com",
        "httpMethod": "POST",
        "httpHeaders": {
            "api-key": "<redacted>"
        },
        "timeout": "PT60S",
        "authResourceId": null,
        "authIdentity": null
    }
}

Без изменений uriможно смешивать <redacted> сохраненные значения заголовков с фактическими значениями замены для других существующих заголовков. Укажите фактическое значение для каждого добавленного или переименованного заголовка, так как sentinel применяется только к существующему заголовку с тем же именем в том же векторизаторе.

Если изменить uriзначение, укажите фактические значения для каждой httpHeaders записи в одном обновлении. Служба не использует хранимые значения для другого uri:

{
    "name": "my-custom-web-api-vectorizer",
    "kind": "customWebApi",
    "customWebApiParameters": {
        "uri": "https://new.contoso.embeddings.com",
        "httpMethod": "POST",
        "httpHeaders": {
            "api-key": "<new-header-value>"
        },
        "timeout": "PT60S",
        "authResourceId": null,
        "authIdentity": null
    }
}

Если учетные данные недоступны и необходимо изменить uriего, измените или повторно создайте их на внешней конечной точке. Затем отправьте новые uri и заголовки вместе.

Значением <redacted> является служба sentinel, а не учетные данные. Он не может создать векторизатор или получить или повторно использовать значение заголовка, хранящееся для другого векторизатора.

Структура полезных данных JSON

Требуемая структура полезных данных JSON для конечной точки, используемой с векторизатором пользовательского веб-API, совпадает со структурой, используемой навыком пользовательского веб-API. Дополнительные сведения см. в документации по навыку.

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

• Векторизатор отправляет только одну запись в values массиве при выполнении запроса к конечной точке.

• Векторизатор помещает данные, которые необходимо векторизовать, в определенный ключ объекта JSON в data полезной нагрузке запроса. Этот ключ имеет textзначение , imageUrlили imageBinaryв зависимости от типа запроса вектора.

• Векторизатор ожидает, что результирующее встраивание будет находиться под ключом vector в объекте JSON data в теле ответа.

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

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

  {
      "values": [
          {
              "recordId": "0",
              "data":
              {
                  "imageBinary": {
                      "data": "<base 64 encoded image binary data>"
                  }
              }
          }
      ]
  }
  

См. также

• Встроенная векторизация
• Настройка векторизатора в индексе поиска
• Функция пользовательского веб-API