Blame - docs/dyn/dialogflow_v2.projects.answerRecords.html - platform/external/python/google-api-python-client

<h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.answerRecords.html">answerRecords</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Returns the list of all answer records in the specified project in reverse chronological order.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

87

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Updates the specified answer record.</p>

89

<h3>Method Details</h3>

90

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

97

<pre>Returns the list of all answer records in the specified project in reverse chronological order.

98

99

Args:

100

parent: string, Required. The project to list all answer records for in reverse chronological order. Format: `projects//locations/`. (required)

101

filter: string, Required. Filters to restrict results to specific answer records. Filter on answer record type. Currently predicates on `type` is supported, valid values are `ARTICLE_ANSWER`, `FAQ_ANSWER`. For more information about filtering, see [API Filtering](https://aip.dev/160).

102

pageSize: integer, Optional. The maximum number of records to return in a single page. The server may return fewer records than this. If unspecified, we use 10. The maximum is 100.

103

pageToken: string, Optional. The ListAnswerRecordsResponse.next_page_token value returned from a previous list request used to continue listing on the next page.

104

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

111

112

{ # Response message for AnswerRecords.ListAnswerRecords.

113

"answerRecords": [ # The list of answer records.

114

{ # Answer records are records to manage answer history and feedbacks for Dialogflow. Currently, answer record includes: - human agent assistant article suggestion - human agent assistant faq article It doesn't include: - `DetectIntent` intent matching - `DetectIntent` knowledge Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated. A typical workflow for customers provide feedback to an answer is: 1. For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers. 2. The customer uses the AnswerRecord.name to call the UpdateAnswerRecord method to send feedback about a specific answer that they believe is wrong.

115

"agentAssistantRecord": { # Represents a record of a human agent assist answer. # Output only. The record for human agent assistant.

116

"articleSuggestionAnswer": { # Represents article answer. # Output only. The article suggestion answer.

117

"answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/"

118

"confidence": 3.14, # Article match confidence. The system's confidence score that this article is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain).

119

"metadata": { # A map that contains metadata about the answer and the document from which it originates.

120

"a_key": "A String",

121

},

122

"snippets": [ # Article snippets.

123

"A String",

124

],

125

"title": "A String", # The article title.

126

"uri": "A String", # The article URI.

127

},

128

"faqAnswer": { # Represents answer from "frequently asked questions". # Output only. The FAQ answer.

129

"answer": "A String", # The piece of text from the `source` knowledge base document.

130

"answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/"

131

"confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

132

"metadata": { # A map that contains metadata about the answer and the document from which it originates.

133

"a_key": "A String",

134

},

135

"question": "A String", # The corresponding FAQ question.

136

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`.

137

},

138

},

139

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer.

140

"agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions.

141

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT

142

"documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT

143

"documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.

144

},

145

"clickTime": "A String", # Time when the answer/item was clicked.

146

"clicked": True or False, # Indicates whether the answer/item was clicked by the human agent or not. Default to false.

147

"correctnessLevel": "A String", # The correctness level of the specific answer.

148

"displayTime": "A String", # Time when the answer/item was displayed.

149

"displayed": True or False, # Indicates whether the answer/item was displayed to the human agent in the agent desktop UI. Default to false.

150

},

151

"name": "A String", # The unique identifier of this answer record. Format: `projects//locations//answerRecords/`.

152

},

153

],

154

"nextPageToken": "A String", # A token to retrieve next page of results. Or empty if there are no more results. Pass this value in the ListAnswerRecordsRequest.page_token field in the subsequent call to `ListAnswerRecords` method to retrieve the next page of results.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

160

<pre>Retrieves the next page of results.

161

162

Args:

163

previous_request: The request for the previous page. (required)

164

previous_response: The response from the request for the previous page. (required)

165

166

Returns:

167

A request object that you can call 'execute()' on to request the next

168

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

174

<pre>Updates the specified answer record.

175

176

Args:

177

name: string, The unique identifier of this answer record. Format: `projects//locations//answerRecords/`. (required)

178

body: object, The request body.

179

The object takes the form of:

180

181

{ # Answer records are records to manage answer history and feedbacks for Dialogflow. Currently, answer record includes: - human agent assistant article suggestion - human agent assistant faq article It doesn't include: - `DetectIntent` intent matching - `DetectIntent` knowledge Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated. A typical workflow for customers provide feedback to an answer is: 1. For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers. 2. The customer uses the AnswerRecord.name to call the UpdateAnswerRecord method to send feedback about a specific answer that they believe is wrong.

182

"agentAssistantRecord": { # Represents a record of a human agent assist answer. # Output only. The record for human agent assistant.

183

"articleSuggestionAnswer": { # Represents article answer. # Output only. The article suggestion answer.

184

"answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/"

185

"confidence": 3.14, # Article match confidence. The system's confidence score that this article is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain).

186

"metadata": { # A map that contains metadata about the answer and the document from which it originates.

187

"a_key": "A String",

188

},

189

"snippets": [ # Article snippets.

190

"A String",

191

],

192

"title": "A String", # The article title.

193

"uri": "A String", # The article URI.

194

},

195

"faqAnswer": { # Represents answer from "frequently asked questions". # Output only. The FAQ answer.

196

"answer": "A String", # The piece of text from the `source` knowledge base document.

197

"answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/"

198

"confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

199

"metadata": { # A map that contains metadata about the answer and the document from which it originates.

200

"a_key": "A String",

201

},

202

"question": "A String", # The corresponding FAQ question.

203

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`.

204

},

205

},

206

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer.

207

"agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions.

208

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT

209

"documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT

210

"documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.

211

},

212

"clickTime": "A String", # Time when the answer/item was clicked.

213

"clicked": True or False, # Indicates whether the answer/item was clicked by the human agent or not. Default to false.

214

"correctnessLevel": "A String", # The correctness level of the specific answer.

215

"displayTime": "A String", # Time when the answer/item was displayed.

216

"displayed": True or False, # Indicates whether the answer/item was displayed to the human agent in the agent desktop UI. Default to false.

217

},

218

"name": "A String", # The unique identifier of this answer record. Format: `projects//locations//answerRecords/`.

219

}

220

221

updateMask: string, Required. The mask to control which fields get updated.

222

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

229

230

{ # Answer records are records to manage answer history and feedbacks for Dialogflow. Currently, answer record includes: - human agent assistant article suggestion - human agent assistant faq article It doesn't include: - `DetectIntent` intent matching - `DetectIntent` knowledge Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated. A typical workflow for customers provide feedback to an answer is: 1. For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers. 2. The customer uses the AnswerRecord.name to call the UpdateAnswerRecord method to send feedback about a specific answer that they believe is wrong.

231

"agentAssistantRecord": { # Represents a record of a human agent assist answer. # Output only. The record for human agent assistant.

232

"articleSuggestionAnswer": { # Represents article answer. # Output only. The article suggestion answer.

233

"answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/"

234

"confidence": 3.14, # Article match confidence. The system's confidence score that this article is a good match for this conversation, as a value from 0.0 (completely uncertain) to 1.0 (completely certain).

235

"metadata": { # A map that contains metadata about the answer and the document from which it originates.

236

"a_key": "A String",

237

},

238

"snippets": [ # Article snippets.

239

"A String",

240

],

241

"title": "A String", # The article title.

242

"uri": "A String", # The article URI.

243

},

244

"faqAnswer": { # Represents answer from "frequently asked questions". # Output only. The FAQ answer.

245

"answer": "A String", # The piece of text from the `source` knowledge base document.

246

"answerRecord": "A String", # The name of answer record, in the format of "projects//locations//answerRecords/"

247

"confidence": 3.14, # The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

248

"metadata": { # A map that contains metadata about the answer and the document from which it originates.

249

"a_key": "A String",

250

},

251

"question": "A String", # The corresponding FAQ question.

252

"source": "A String", # Indicates which Knowledge Document this answer was extracted from. Format: `projects//locations//agent/knowledgeBases//documents/`.

253

},

254

},

255

"answerFeedback": { # Represents feedback the customer has about the quality & correctness of a certain answer in a conversation. # Required. The AnswerFeedback for this record. You can set this with AnswerRecords.UpdateAnswerRecord in order to give us feedback about this answer.

256

"agentAssistantDetailFeedback": { # Detail feedback of Agent Assist result. # Detail feedback of agent assist suggestions.

257

"answerRelevance": "A String", # Optional. Whether or not the suggested answer is relevant. For example: * Query: "Can I change my mailing address?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * answer_relevance: AnswerRelevance.IRRELEVANT

258

"documentCorrectness": "A String", # Optional. Whether or not the information in the document is correct. For example: * Query: "Can I return the package in 2 days once received?" * Suggested document says: "Items must be returned/exchanged within 60 days of the purchase date." * Ground truth: "No return or exchange is allowed." * [document_correctness]: INCORRECT

259

"documentEfficiency": "A String", # Optional. Whether or not the suggested document is efficient. For example, if the document is poorly written, hard to understand, hard to use or too long to find useful information, document_efficiency is DocumentEfficiency.INEFFICIENT.

260

},

261

"clickTime": "A String", # Time when the answer/item was clicked.

262

"clicked": True or False, # Indicates whether the answer/item was clicked by the human agent or not. Default to false.

263

"correctnessLevel": "A String", # The correctness level of the specific answer.

264

"displayTime": "A String", # Time when the answer/item was displayed.

265

"displayed": True or False, # Indicates whether the answer/item was displayed to the human agent in the agent desktop UI. Default to false.