обновить-базу-знаний

Описание

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

Вы можете изменить следующие поля:

• name
• description
• roleArn

Вы не можете изменить поля knowledgeBaseConfiguration или storageConfiguration, поэтому вы должны указать те же конфигурации, что и при создании базы знаний. Вы можете отправить запрос GetKnowledgeBase и скопировать те же конфигурации.

См. также: Документация API AWS

Синтаксис

  update-knowledge-base
[--description <value>]
--knowledge-base-configuration <value>
--knowledge-base-id <value>
--name <value>
--role-arn <value>
[--storage-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--description (строка)

--knowledge-base-configuration (структура)

{
  "kendraKnowledgeBaseConfiguration": {
    "kendraIndexArn": "string"
  },
  "sqlKnowledgeBaseConfiguration": {
    "redshiftConfiguration": {
      "queryEngineConfiguration": {
        "provisionedConfiguration": {
          "authConfiguration": {
            "databaseUser": "string",
            "type": "IAM"|"USERNAME_PASSWORD"|"USERNAME",
            "usernamePasswordSecretArn": "string"
          },
          "clusterIdentifier": "string"
        },
        "serverlessConfiguration": {
          "authConfiguration": {
            "type": "IAM"|"USERNAME_PASSWORD",
            "usernamePasswordSecretArn": "string"
          },
          "workgroupArn": "string"
        },
        "type": "SERVERLESS"|"PROVISIONED"
      },
      "queryGenerationConfiguration": {
        "executionTimeoutSeconds": integer,
        "generationContext": {
          "curatedQueries": [
            {
              "naturalLanguage": "string",
              "sql": "string"
            }
            ...
          ],
          "tables": [
            {
              "columns": [
                {
                  "description": "string",
                  "inclusion": "INCLUDE"|"EXCLUDE",
                  "name": "string"
                }
                ...
              ],
              "description": "string",
              "inclusion": "INCLUDE"|"EXCLUDE",
              "name": "string"
            }
            ...
          ]
        }
      },
      "storageConfigurations": [
        {
          "awsDataCatalogConfiguration": {
            "tableNames": ["string", ...]
          },
          "redshiftConfiguration": {
            "databaseName": "string"
          },
          "type": "REDSHIFT"|"AWS_DATA_CATALOG"
        }
        ...
      ]
    },
    "type": "REDSHIFT"
  },
  "type": "VECTOR"|"KENDRA"|"SQL",
  "vectorKnowledgeBaseConfiguration": {
    "embeddingModelArn": "string",
    "embeddingModelConfiguration": {
      "bedrockEmbeddingModelConfiguration": {
        "dimensions": integer,
        "embeddingDataType": "FLOAT32"|"BINARY"
      }
    },
    "supplementalDataStorageConfiguration": {
      "storageLocations": [
        {
          "s3Location": {
            "uri": "string"
          },
          "type": "S3"
        }
        ...
      ]
    }
  }
}

Сокращенная синтаксическая запись:

mongoDbAtlasConfiguration={collectionName=string,credentialsSecretArn=string,databaseName=string,endpoint=string,endpointServiceName=string,fieldMapping={metadataField=string,textField=string,vectorField=string},textIndexName=string,vectorIndexName=string},neptuneAnalyticsConfiguration={fieldMapping={metadataField=string,textField=string},graphArn=string},opensearchManagedClusterConfiguration={domainArn=string,domainEndpoint=string,fieldMapping={metadataField=string,textField=string,vectorField=string},vectorIndexName=string},opensearchServerlessConfiguration={collectionArn=string,fieldMapping={metadataField=string,textField=string,vectorField=string},vectorIndexName=string},pineconeConfiguration={connectionString=string,credentialsSecretArn=string,fieldMapping={metadataField=string,textField=string},namespace=string},rdsConfiguration={credentialsSecretArn=string,databaseName=string,fieldMapping={customMetadataField=string,metadataField=string,primaryKeyField=string,textField=string,vectorField=string},resourceArn=string,tableName=string},redisEnterpriseCloudConfiguration={credentialsSecretArn=string,endpoint=string,fieldMapping={metadataField=string,textField=string,vectorField=string},vectorIndexName=string},type=string

Синтаксис JSON:

{
  "mongoDbAtlasConfiguration": {
    "collectionName": "string",
    "credentialsSecretArn": "string",
    "databaseName": "string",
    "endpoint": "string",
    "endpointServiceName": "string",
    "fieldMapping": {
      "metadataField": "string",
      "textField": "string",
      "vectorField": "string"
    },
    "textIndexName": "string",
    "vectorIndexName": "string"
  },
  "neptuneAnalyticsConfiguration": {
    "fieldMapping": {
      "metadataField": "string",
      "textField": "string"
    },
    "graphArn": "string"
  },
  "opensearchManagedClusterConfiguration": {
    "domainArn": "string",
    "domainEndpoint": "string",
    "fieldMapping": {
      "metadataField": "string",
      "textField": "string",
      "vectorField": "string"
    },
    "vectorIndexName": "string"
  },
  "opensearchServerlessConfiguration": {
    "collectionArn": "string",
    "fieldMapping": {
      "metadataField": "string",
      "textField": "string",
      "vectorField": "string"
    },
    "vectorIndexName": "string"
  },
  "pineconeConfiguration": {
    "connectionString": "string",
    "credentialsSecretArn": "string",
    "fieldMapping": {
      "metadataField": "string",
      "textField": "string"
    },
    "namespace": "string"
  },
  "rdsConfiguration": {
    "credentialsSecretArn": "string",
    "databaseName": "string",
    "fieldMapping": {
      "customMetadataField": "string",
      "metadataField": "string",
      "primaryKeyField": "string",
      "textField": "string",
      "vectorField": "string"
    },
    "resourceArn": "string",
    "tableName": "string"
  },
  "redisEnterpriseCloudConfiguration": {
    "credentialsSecretArn": "string",
    "endpoint": "string",
    "fieldMapping": {
      "metadataField": "string",
      "textField": "string",
      "vectorField": "string"
    },
    "vectorIndexName": "string"
  },
  "type": "OPENSEARCH_SERVERLESS"|"PINECONE"|"REDIS_ENTERPRISE_CLOUD"|"RDS"|"MONGO_DB_ATLAS"|"NEPTUNE_ANALYTICS"|"OPENSEARCH_MANAGED_CLUSTER"
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет принята буквально. Это может быть не указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

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

--output (string)

Стиль форматирования для вывода команд.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

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

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с корневым сертификатом для проверки SSL-сертификатов. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

knowledgeBase -> (структура)