> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# インデックスの更新

> 既存のナレッジベースのインデックスを更新する

# インデックスを更新する

既存のナレッジ ベース インデックスを新しい設定、メタデータ、または構成で更新します。

## エンドポイント

```
PUT /indexes/{indexId}
```

## 説明

このエンドポイントにより、管理者は既存のナレッジ ベースのインデックスを更新できます。インデックス名を変更し、別のユーザーまたはグループに再割り当てすることができます。管理者のみがインデックスを更新できます。

## 認証

**必須**: 管理者権限を持つ API キー

```
Authorization: Bearer sk-your-api-key-here
```

## パスパラメータ

| パラメータ     | タイプ | 必須 | 説明                |
| --------- | --- | -- | ----------------- |
| `indexId` | 文字列 | はい | 更新するインデックスの一意の識別子 |

## リクエスト本文

| パラメータ           | タイプ | 必須  | 説明                                     |
| --------------- | --- | --- | -------------------------------------- |
| `name`          | 文字列 | いいえ | インデックスの新しい名前                           |
| `assignedUser`  | 文字列 | いいえ | インデックスを割り当てるユーザー ID (MongoDB ObjectId) |
| `assignedGroup` | 文字列 | いいえ | インデックスを割り当てるグループ ID (MongoDB ObjectId) |

## リクエストの例

```json theme={null}
{
  "name": "updated-knowledge-base",
  "assignedUser": "60a7c8f5e8b4f5001f7a8c24"
}
```

## 成功の応答

**ステータス コード**: `200 OK`

```json theme={null}
{
  "success": true,
  "message": "Index updated successfully",
  "index": {
    "id": "60a7c8f5e8b4f5001f7a8c23",
    "name": "updated-knowledge-base",
    "sharedIndexName": "updated-knowledge-base",
    "namespace": "user-60a7c8f5e8b4f5001f7a8c24-index-updated-knowledge-base",
    "type": "personal",
    "assignedUser": {
      "id": "60a7c8f5e8b4f5001f7a8c24",
      "name": "John Doe",
      "email": "john@example.com"
    },
    "assignedGroup": null,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  }
}
```

### 応答フィールド

| フィールド                   | タイプ    | 説明                        |
| ----------------------- | ------ | ------------------------- |
| `success`               | ブール値   | 操作が成功したかどうかを示します。         |
| `message`               | 文字列    | 成功メッセージ                   |
| `index`                 | オブジェクト | 更新されたインデックス オブジェクト        |
| `index.id`              | 文字列    | 一意のインデックス識別子              |
| `index.name`            | 文字列    | 更新されたインデックス名              |
| `index.sharedIndexName` | 文字列    | 共有インデックス名                 |
| `index.namespace`       | 文字列    | インデックス名前空間                |
| `index.type`            | 文字列    | インデックスの種類 (個人、一般、グループ、不明) |
| `index.assignedUser`    | オブジェクト | 割り当てられたユーザー情報 (個人の場合)     |
| `index.assignedGroup`   | オブジェクト | 割り当てられたグループ情報 (グループの場合)   |
| `index.createdAt`       | 文字列    | オリジナルの作成タイムスタンプ           |
| `index.updatedAt`       | 文字列    | 最終更新タイムスタンプ               |

## 使用例

### JavaScript

```javascript theme={null}
const updateIndex = async (indexId, updateData) => {
  const response = await fetch(`https://{customer.name}.hiperai.ai/api/external/indexes/${indexId}`, {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer sk-your-api-key-here',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(updateData)
  });
  
  return await response.json();
};

// Example usage
const updateData = {
  name: "updated-knowledge-base",
  assignedUser: "60a7c8f5e8b4f5001f7a8c24"
};

const result = await updateIndex('60a7c8f5e8b4f5001f7a8c23', updateData);
console.log('Updated index:', result.index);
```

### パイソン

```python theme={null}
import requests

def update_index(index_id, update_data):
    url = f"https://{customer.name}.hiperai.ai/api/external/indexes/{index_id}"
    headers = {
        "Authorization": "Bearer sk-your-api-key-here",
        "Content-Type": "application/json"
    }
    
    response = requests.put(url, headers=headers, json=update_data)
    return response.json()

# Example usage
update_data = {
    "name": "updated-knowledge-base",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24"
}

result = update_index("60a7c8f5e8b4f5001f7a8c23", update_data)
print("Updated index:", result["index"])
```

### cURL

```bash theme={null}
curl -X PUT "https://{customer.name}.hiperai.ai/api/external/indexes/60a7c8f5e8b4f5001f7a8c23" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "updated-knowledge-base",
    "assignedUser": "60a7c8f5e8b4f5001f7a8c24"
  }'
```

## エラー応答

### 400 不正なリクエスト

```json theme={null}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Index name already exists or invalid assigned IDs",
    "details": {
      "field": "name | assignedUser | assignedGroup"
    }
  }
}
```

## 検証とビジネス ルール

* **ユーザーへの割り当て (`assignedUser`)**:
  * 個人に変換するとき、または担当者を変更するときに、`checkUserIndexQuota` を介してユーザー インデックス クォータを強制します。クォータを超過すると 403 が返されます。
* **グループへの割り当て (`assignedGroup`)**:
  * グループは存在し、アクティブである必要があります (`status != 'Archived'`)。無効または非アクティブなグループは 400 を返します。

## 正規化と保存

* 名前を変更すると、`name` は引き続き正規化されて保存されます。 `sharedIndexName` は、明示的に設定されていない場合、デフォルトで正規化された名前になります。

## 典型的なエラーの形状

### 403 インデックス クォータを超過しました

```json theme={null}
{
  "success": false,
  "error": "Index quota exceeded",
  "message": "User has reached the maximum number of indexes for Ultra license (current/limit)."
}
```

### 400 グループが無効/非アクティブ

```json theme={null}
{
  "success": false,
  "error": "Invalid or inactive group",
  "message": "The specified group does not exist or is not active"
}
```

### 401 不正

```json theme={null}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}
```

### 403 禁止

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Cannot update this index"
  }
}
```

### 404 見つかりません

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INDEX_NOT_FOUND",
    "message": "Index not found"
  }
}
```

### 409 紛争

```json theme={null}
{
  "success": false,
  "error": {
    "code": "INDEX_NAME_EXISTS",
    "message": "Index name already exists"
  }
}
```

### 429 リクエストが多すぎます

```json theme={null}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "retryAfter": 60
  }
}
```

## 更新可能なフィールド

| フィールド           | 説明        | メモ                     |
| --------------- | --------- | ---------------------- |
| `name`          | インデックス名   | システム全体で一意である必要があります    |
| `assignedUser`  | ユーザーの割り当て | 特定のユーザーにインデックスを割り当てます。 |
| `assignedGroup` | グループ割り当て  | インデックスを特定のグループに割り当てます。 |

## 使用例

* **名前の変更**: 整理しやすくするためにインデックスの名前を変更します。
* **ユーザー割り当て**: インデックスを別のユーザーに再割り当てします。
* **グループ割り当て**: インデックスを別のグループに再割り当てします。
* **所有権の譲渡**: ユーザー間でインデックスの所有権を変更します。

## レート制限

* **デフォルト**: 1 分あたり 50 リクエスト
* **毎日**: 1 日あたり 5,000 リクエスト
* **毎月**: 毎月 150,000 件のリクエスト

## 注意事項

* このエンドポイントには管理者のみがアクセスできます
* 制限されたフィールド: name、assignedUser、assignedGroup のみを更新できます
* 割り当てロジック: ユーザーに割り当てるとグループ割り当てがクリアされ、その逆も同様です。
* 検証: ユーザー ID とグループ ID は割り当て前に検証されます。
* 設定なし: 設定、メタデータ、またはその他の構成を更新できません
* `updatedAt` タイムスタンプは自動的に更新されます
* インデックス名はシステム全体で一意である必要があります


## OpenAPI

````yaml PUT /indexes/{indexId}
openapi: 3.0.3
info:
  title: SecureAI External API
  description: >
    SecureAI External API provides AI chat completion and image generation
    capabilities with knowledge base retrieval, 

    security policies, and comprehensive usage tracking. This API is designed
    for external developers 

    and integrations using API key authentication.


    ## Key Features

    - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge
    bases for relevant context

    - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI
    models

    - **Model Redundancy & Failover**: Caller-defined failover chains (primary +
    fallbacks) with per-attempt timeouts

    - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1`
    — no code changes

    - **Image Generation**: Generate and edit images using Google Gemini 2.5
    Flash Image

    - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI
    Realtime API with WebRTC

    - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield,
    and signed compliance receipts

    - **Usage Tracking**: Comprehensive usage monitoring, self-service quota,
    and rate limiting

    - **Knowledge Base Integration**: Access to personal and shared knowledge
    bases

    - **User Management**: Complete user, group, and role management
    capabilities

    - **Audit Logging**: Comprehensive activity and security audit logs


    ## Authentication

    All endpoints (except health check) require API key authentication using
    Bearer token:

    ```

    Authorization: Bearer sk-your-api-key-here

    ```


    ## Billing and Usage

    By default, API requests are billed to the user account that owns the API
    key. You can specify 

    a different user to bill by including the `user_id` parameter in your
    request. This allows for:

    - Multi-tenant applications with per-user billing

    - Flexible completion limit management

    - Per-user "Usage by Model" settings


    ## Rate Limits

    - Default: 60 requests per minute, 1000 requests per hour

    - Daily limits: 100 requests (configurable)

    - Monthly limits: 10,000 requests (configurable)


    ## Base URL

    ```

    https://secureai.hiperai.ai/api/external

    ```
  version: 1.1.0
  contact:
    name: SecureAI Support
    email: support@secureai.hiperai.ai
  license:
    name: Proprietary
    url: https://secureai.hiperai.ai/terms
servers:
  - url: https://secureai.hiperai.ai/api/external
    description: Production server
  - url: http://localhost:3010/api/external
    description: Development server
security:
  - ApiKeyAuth: []
tags:
  - name: System
    description: System health and status endpoints
  - name: Discovery
    description: Endpoints to discover available models, indexes, and policies
  - name: Chat
    description: AI chat completion endpoints
  - name: User Management
    description: Endpoints for managing user accounts and roles
  - name: Index Management
    description: Endpoints for managing knowledge base indexes
  - name: Group Management
    description: Endpoints for managing user groups
  - name: SMLTP Security
    description: Endpoints for managing SMLTP security policies and audit logs
  - name: Role Management
    description: Endpoints for managing user roles
  - name: Activity Logs
    description: Endpoints for retrieving activity logs
externalDocs:
  description: SecureAI Documentation
  url: https://secureai.hiperai.ai/docs
paths:
  /indexes/{indexId}:
    put:
      tags:
        - Index Management
      summary: Update Index
      description: >
        Update an existing index (assign to user or group). Only accessible by
        administrators.
      parameters:
        - name: indexId
          in: path
          required: true
          description: Index ID to update
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Index name
                  example: updated-knowledge-base
                assignedUser:
                  type: string
                  description: User ID to assign the index to (MongoDB ObjectId)
                  example: 60a7c8f5e8b4f5001f7a8c24
                assignedGroup:
                  type: string
                  description: Group ID to assign the index to (MongoDB ObjectId)
                  example: 60a7c8f5e8b4f5001f7a8c25
            example:
              name: updated-knowledge-base
              assignedUser: 60a7c8f5e8b4f5001f7a8c24
      responses:
        '200':
          description: Index updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Index updated successfully
                  index:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 60a7c8f5e8b4f5001f7a8c23
                      name:
                        type: string
                        example: updated-knowledge-base
                      sharedIndexName:
                        type: string
                        example: updated-knowledge-base
                      namespace:
                        type: string
                        example: >-
                          user-60a7c8f5e8b4f5001f7a8c24-index-updated-knowledge-base
                      type:
                        type: string
                        enum:
                          - personal
                          - general
                          - group
                          - unknown
                        example: personal
                      assignedUser:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            example: 60a7c8f5e8b4f5001f7a8c24
                          name:
                            type: string
                            example: John Doe
                          email:
                            type: string
                            example: john@example.com
                      assignedGroup:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                            example: 60a7c8f5e8b4f5001f7a8c25
                          name:
                            type: string
                            example: Engineering Team
                      createdAt:
                        type: string
                        format: date-time
                        example: '2024-01-01T00:00:00.000Z'
                      updatedAt:
                        type: string
                        format: date-time
                        example: '2024-01-15T10:30:00.000Z'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied - admin only
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Index not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Invalid API key
        message:
          type: string
          example: The provided API key is invalid or has been revoked
        request_id:
          type: string
          example: req-abc123
          description: Request ID for tracking (if available)
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key authentication using Bearer token format.
        Example: `Authorization: Bearer sk-your-api-key-here`

````