Skip to main content
Skip to content

Сведения о клиенте

Сведения о клиенте идентифицируют приложение с помощью пакета SDK Copilot и при необходимости конкретной интеграции в ней. Интеграция — это определяемая под часть приложения, с помощью которой используется пакет SDK, например расширение или подключаемый модуль. Задайте необязательный clientInfo параметр клиента для телеметрии среды выполнения для этого подключения к приложению вместо собственной сборки среды выполнения.

Когда следует задать сведения о клиенте

Задайте сведения о клиенте, когда приложение SDK представляет отдельный продукт, службу или интеграцию, активность среды выполнения которой должна быть согласована.

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

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

ПолеExampleЗначение
applicationName"vscode"Имя приложения с помощью пакета SDK
applicationVersion"1.124.2"Версия приложения с помощью пакета SDK
integrationName"copilot-chat"Имя расширения, подключаемого модуля или другой части приложения с помощью пакета SDK
integrationVersion"0.54.0"Версия этого расширения, подключаемого модуля или подчасти приложения

Для автономного приложения без отдельной интеграции задайте только поля приложения. Например, на портале разработчика может быть задано applicationName``"acme-developer-portal" значение и applicationVersion значение "2.4.0", при этом оба поля интеграции не заданы.

Пакет SDK отправляет сведения о клиенте один раз при установке подключения. Удостоверение применяется к времени существования этого подключения.

Настройка сведений о клиенте

Передайте сведения о клиенте при создании клиента:

Языки кода navigation

TypeScript
import { CopilotClient } from "@github/copilot-sdk";

const client = new CopilotClient({
  clientInfo: {
    applicationName: "vscode",
    applicationVersion: "1.124.2",
    integrationName: "copilot-chat",
    integrationVersion: "0.54.0",
  },
});

await client.start();

Notes

  • Сведения о клиенте — это рекомендации. Среда выполнения может игнорировать значения, которые не соответствуют ожидаемому формату, например недопустимой строке версии.
  • Настройка сведений о клиенте изменяет способ атрибутов среды выполнения его телеметрии. Он не изменяет записи среды выполнения.
  • Если каждое поле не задано или пусто, пакет SDK опустит сведения о клиенте из подтверждения, а среда выполнения сохраняет свое присвоение по умолчанию.