# -*- coding: utf-8 -*- #
# Copyright 2024 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# NOTE: This file is autogenerated and should not be edited by hand.
# AUTOGEN_CLI_VERSION: HEAD
- release_tracks:
  - ALPHA
  auto_generated: true
  hidden: true
  help_text:
    brief: Runs a query against a single Workbench instance
    description: |
      Runs a query against a single Workbench instance.

      If run asynchronously with --async, exits after printing an operation that can
      be used to poll the status of the creation operation.

      query <WORKBENCH_ID> --location=<LOCATION> --query=<QUERY> [--async] [--labels]
    examples: |-
      To query workbench `my-workbench` run:

      $ {command} my-workbench --location=us-central1 --query="What is lateral movement?"
  arguments:
    params:
    - help_text: |-
        Name of the resource.
      is_positional: true
      resource_spec: !REF googlecloudsdk.command_lib.seclm.v1_resources:project_location_workbench
      required: true
    - arg_name: contents
      api_field: workbenchQueryRequest.contents
      required: false
      repeated: true
      help_text: |-
        The content of the current conversation with the model.

        For single-turn queries, this is a single instance. For multi-turn queries,
        this is a repeated field that contains conversation history + latest
        request.
      spec:
      - api_field: role
        help_text: |-
          The producer of the content. Must be either 'user' or 'model'.

          Useful to set for multi-turn conversations, otherwise can be left blank
          or unset.
      - api_field: parts
        help_text: |-
          Ordered `Parts` that constitute a single message. Parts may have different
          IANA MIME types.
        spec:
        - api_field: text
          one_of_index: 0
          help_text: |-
            Text part (can be code).
    - arg_name: safety-settings
      api_field: workbenchQueryRequest.safetySettings
      required: false
      repeated: true
      help_text: |-
        Per request settings for blocking unsafe content.
        Enforced on GenerateContentResponse.candidates.
      spec:
      - api_field: category
        help_text: |-
          The category for this setting.
      - api_field: threshold
        help_text: |-
          Controls the probability threshold at which harm is blocked.
  request:
    api_version: v1
    collection:
    - seclm.projects.locations.workbenches
    method: query