GoogleCloudContactcenterinsightsV1FaqAnswerData.php 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. <?php
  2. /*
  3. * Copyright 2014 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  6. * use this file except in compliance with the License. You may obtain a copy of
  7. * the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14. * License for the specific language governing permissions and limitations under
  15. * the License.
  16. */
  17. namespace Google\Service\Contactcenterinsights;
  18. class GoogleCloudContactcenterinsightsV1FaqAnswerData extends \Google\Model
  19. {
  20. /**
  21. * The piece of text from the `source` knowledge base document.
  22. *
  23. * @var string
  24. */
  25. public $answer;
  26. /**
  27. * The system's confidence score that this answer is a good match for this
  28. * conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
  29. * certain).
  30. *
  31. * @var float
  32. */
  33. public $confidenceScore;
  34. /**
  35. * Map that contains metadata about the FAQ answer and the document that it
  36. * originates from.
  37. *
  38. * @var string[]
  39. */
  40. public $metadata;
  41. /**
  42. * The name of the answer record. Format:
  43. * projects/{project}/locations/{location}/answerRecords/{answer_record}
  44. *
  45. * @var string
  46. */
  47. public $queryRecord;
  48. /**
  49. * The corresponding FAQ question.
  50. *
  51. * @var string
  52. */
  53. public $question;
  54. /**
  55. * The knowledge document that this answer was extracted from. Format:
  56. * projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
  57. *
  58. * @var string
  59. */
  60. public $source;
  61. /**
  62. * The piece of text from the `source` knowledge base document.
  63. *
  64. * @param string $answer
  65. */
  66. public function setAnswer($answer)
  67. {
  68. $this->answer = $answer;
  69. }
  70. /**
  71. * @return string
  72. */
  73. public function getAnswer()
  74. {
  75. return $this->answer;
  76. }
  77. /**
  78. * The system's confidence score that this answer is a good match for this
  79. * conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely
  80. * certain).
  81. *
  82. * @param float $confidenceScore
  83. */
  84. public function setConfidenceScore($confidenceScore)
  85. {
  86. $this->confidenceScore = $confidenceScore;
  87. }
  88. /**
  89. * @return float
  90. */
  91. public function getConfidenceScore()
  92. {
  93. return $this->confidenceScore;
  94. }
  95. /**
  96. * Map that contains metadata about the FAQ answer and the document that it
  97. * originates from.
  98. *
  99. * @param string[] $metadata
  100. */
  101. public function setMetadata($metadata)
  102. {
  103. $this->metadata = $metadata;
  104. }
  105. /**
  106. * @return string[]
  107. */
  108. public function getMetadata()
  109. {
  110. return $this->metadata;
  111. }
  112. /**
  113. * The name of the answer record. Format:
  114. * projects/{project}/locations/{location}/answerRecords/{answer_record}
  115. *
  116. * @param string $queryRecord
  117. */
  118. public function setQueryRecord($queryRecord)
  119. {
  120. $this->queryRecord = $queryRecord;
  121. }
  122. /**
  123. * @return string
  124. */
  125. public function getQueryRecord()
  126. {
  127. return $this->queryRecord;
  128. }
  129. /**
  130. * The corresponding FAQ question.
  131. *
  132. * @param string $question
  133. */
  134. public function setQuestion($question)
  135. {
  136. $this->question = $question;
  137. }
  138. /**
  139. * @return string
  140. */
  141. public function getQuestion()
  142. {
  143. return $this->question;
  144. }
  145. /**
  146. * The knowledge document that this answer was extracted from. Format:
  147. * projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
  148. *
  149. * @param string $source
  150. */
  151. public function setSource($source)
  152. {
  153. $this->source = $source;
  154. }
  155. /**
  156. * @return string
  157. */
  158. public function getSource()
  159. {
  160. return $this->source;
  161. }
  162. }
  163. // Adding a class alias for backwards compatibility with the previous class name.
  164. class_alias(GoogleCloudContactcenterinsightsV1FaqAnswerData::class, 'Google_Service_Contactcenterinsights_GoogleCloudContactcenterinsightsV1FaqAnswerData');