Updates the specified answer record.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/dialogflow

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: dialogflow2 --scope <scope> projects answer-records-patch ...

Required Scalar Argument

• <name> (string)
  • The unique identifier of this answer record. Format: projects//locations//answerRecords/.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudDialogflowV2AnswerRecord:
  agent-assistant-record:
    article-suggestion-answer:
      answer-record: string
      confidence: number
      metadata: { string: string }
      snippets: [string]
      title: string
      uri: string
    faq-answer:
      answer: string
      answer-record: string
      confidence: number
      metadata: { string: string }
      question: string
      source: string
  answer-feedback:
    agent-assistant-detail-feedback:
      answer-relevance: string
      document-correctness: string
      document-efficiency: string
    click-time: string
    clicked: boolean
    correctness-level: string
    display-time: string
    displayed: boolean
  name: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r .agent-assistant-record.article-suggestion-answer answer-record=aliquyam
  • The name of answer record, in the format of "projects//locations//answerRecords/"
• confidence=0.5058218521649169
  • 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).
• metadata=key=vero
  • A map that contains metadata about the answer and the document from which it originates.
  • the value will be associated with the given key
• snippets=rebum.
  • Article snippets.
  • Each invocation of this argument appends the given value to the array.
• title=dolores
  • The article title.

• uri=consetetur

  • The article URI.

• ..faq-answer answer=dolores

  • The piece of text from the source knowledge base document.
• answer-record=sed
  • The name of answer record, in the format of "projects//locations//answerRecords/"
• confidence=0.4962661437411874
  • 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).
• metadata=key=dolor
  • A map that contains metadata about the answer and the document from which it originates.
  • the value will be associated with the given key
• question=aliquyam
  • The corresponding FAQ question.

• source=magna

  • Indicates which Knowledge Document this answer was extracted from. Format: projects//locations//agent/knowledgeBases//documents/.

• ...answer-feedback.agent-assistant-detail-feedback answer-relevance=diam

  • 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
• document-correctness=nonumy
  • 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

• document-efficiency=et

  • 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.

• .. click-time=sanctus

  • Time when the answer/item was clicked.
• clicked=true
  • Indicates whether the answer/item was clicked by the human agent or not. Default to false.
• correctness-level=sed
  • The correctness level of the specific answer.
• display-time=est
  • Time when the answer/item was displayed.

• displayed=false

  • Indicates whether the answer/item was displayed to the human agent in the agent desktop UI. Default to false.

• .. name=diam

  • The unique identifier of this answer record. Format: projects//locations//answerRecords/.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p update-mask=string
  • Required. The mask to control which fields get updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").