agentRegistration を作成する

重要

/beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。

新しい agentRegistration オブジェクトを作成します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) AgentRegistration.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AgentRegistration.ReadWrite.All 注意事項なし。

HTTP 要求

POST https://graph.microsoft.com/beta/copilot/agentRegistrations

要求ヘッダー

名前 説明
Authorization Bearer {token}. 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 agentRegistration オブジェクトの JSON 表現を指定します。

次の表に、agentRegistration を作成するときに必要なプロパティを示します。

プロパティ 型 説明
displayName 文字列 エージェント インスタンスの表示名。 必須です。
createdBy 文字列 エージェント登録を作成したユーザーまたはアプリの一意識別子。 必須です。
sourceCreatedDateTime DateTimeOffset エージェント インスタンスがソースから作成された日時。 必須です。
sourceLastModifiedDateTime DateTimeOffset エージェント インスタンスがソースから最後に変更された日時。 必須です。

応答

成功した場合、このメソッドは 201 Created 応答コードと、応答本文の agentRegistration オブジェクトを返します。

例

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/beta/copilot/agentRegistrations
Content-Type: application/json

{
  "displayName": "Contoso Travel Booking Agent",
  "description": "Helps users search and book flights and hotels",
  "ownerIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "8b7e9c42-1234-5678-90ab-def123456789"
  ],
  "sourceAgentId": "contoso-sales-assistant-v1",
  "originatingStore": "ContosoAgentStore",
  "managedByAppId": "7c3f8d45-e29b-41d4-a716-556677889900",
  "agentIdentityId": "identity-550e8400-e29b-41d4-a716-446655440000",
  "agentIdentityBlueprintId": "blueprint-550e8400-e29b-41d4-a716-446655440000",
  "agentCard": {
    "name": "Contoso Travel Booking Agent",
    "version": "1.0.0",
    "description": "Helps users search and book flights and hotels",
    "provider": "Contoso",
    "capabilities": {
      "streaming": false,
      "pushNotifications": false
    },
    "defaultInputModes": ["text"],
    "defaultOutputModes": ["text"],
    "skills": [
      {
        "id": "book-flight",
        "name": "Book Flight",
        "description": "Search and book flights based on user preferences"
      },
      {
        "id": "book-hotel",
        "name": "Book Hotel",
        "description": "Search and book hotels at the destination"
      }
    ]
  }
}

応答

次の例は応答を示しています。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#copilot/agentRegistrations/$entity",
  "id": "550e8400-e29b-41d4-a716-446655440000"
}