class Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryDTO

POST body schema to query the knowledgebase.

Attributes

context[RW]

@return [QueryDTOContext] Context object with previous QnA's information.

is_test[RW]

@return [Boolean] Query against the test index.

qna_id[RW]

@return [String] Exact qnaId to fetch from the knowledgebase, this field takes priority over question.

question[RW]

@return [String] User question to query against the knowledge base.

ranker_type[RW]

@return [String] Optional field. Set to 'QuestionOnly' for using a question only Ranker.

score_threshold[RW]

@return [Float] Threshold for answers returned based on score.

strict_filters[RW]

@return [Array<MetadataDTO>] Find only answers that contain these metadata.

top[RW]

@return [Integer] Max number of answers to be returned for the question.

user_id[RW]

@return [String] Unique identifier for the user.

Private Class Methods

mapper() click to toggle source

Mapper for QueryDTO class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb, line 52
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'QueryDTO',
    type: {
      name: 'Composite',
      class_name: 'QueryDTO',
      model_properties: {
        qna_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'qnaId',
          type: {
            name: 'String'
          }
        },
        question: {
          client_side_validation: true,
          required: false,
          serialized_name: 'question',
          type: {
            name: 'String'
          }
        },
        top: {
          client_side_validation: true,
          required: false,
          serialized_name: 'top',
          type: {
            name: 'Number'
          }
        },
        user_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'userId',
          type: {
            name: 'String'
          }
        },
        is_test: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isTest',
          type: {
            name: 'Boolean'
          }
        },
        score_threshold: {
          client_side_validation: true,
          required: false,
          serialized_name: 'scoreThreshold',
          type: {
            name: 'Double'
          }
        },
        context: {
          client_side_validation: true,
          required: false,
          serialized_name: 'context',
          type: {
            name: 'Composite',
            class_name: 'QueryDTOContext'
          }
        },
        ranker_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'rankerType',
          type: {
            name: 'String'
          }
        },
        strict_filters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'strictFilters',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'MetadataDTOElementType',
                type: {
                  name: 'Composite',
                  class_name: 'MetadataDTO'
                }
            }
          }
        }
      }
    }
  }
end