Class: Azure::CognitiveServices::QnamakerRuntime::V4_0::Models::QueryDTO

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb

Overview

POST body schema to query the knowledgebase.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#context ⇒ QueryDTOContext

information.

Returns:



37
38
39
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 37

def context
  @context
end

#is_test ⇒ Boolean

Returns Query against the test index.

Returns:

  • (Boolean) —

    Query against the test index.



30
31
32
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 30

def is_test
  @is_test
end

#qna_id ⇒ String

field takes priority over question.

Returns:

  • (String) —

    Exact qnaId to fetch from the knowledgebase, this



17
18
19
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 17

def qna_id
  @qna_id
end

#question ⇒ String

Returns User question to query against the knowledge base.

Returns:

  • (String) —

    User question to query against the knowledge base.



20
21
22
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 20

def question
  @question
end

#ranker_type ⇒ String

question only Ranker.

Returns:

  • (String) —

    Optional field. Set to ‘QuestionOnly’ for using a



41
42
43
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 41

def ranker_type
  @ranker_type
end

#score_threshold ⇒ Float

Returns Threshold for answers returned based on score.

Returns:

  • (Float) —

    Threshold for answers returned based on score.



33
34
35
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 33

def score_threshold
  @score_threshold
end

#strict_filters ⇒ Array<MetadataDTO>

metadata.

Returns:

  • (Array<MetadataDTO>) —

    Find only answers that contain these



45
46
47
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 45

def strict_filters
  @strict_filters
end

#top ⇒ Integer

question.

Returns:

  • (Integer) —

    Max number of answers to be returned for the



24
25
26
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 24

def top
  @top
end

#user_id ⇒ String

Returns Unique identifier for the user.

Returns:

  • (String) —

    Unique identifier for the user.



27
28
29
 
# File 'lib/4.0/generated/azure_cognitiveservices_qnamakerruntime/models/query_dto.rb', line 27

def user_id
  @user_id
end

Class Method Details

.mapper ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# 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