v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1380629577.7 KB
projects

Create a QaQuestion.

post/v1/{+parent}/qaQuestions

Path parameters

parentstring required

Required. The parent resource of the QaQuestion.

Query parameters

qaQuestionIdstring

Optional. A unique ID for the new question. This ID will become the final component of the question's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are a-z-.

Request body

abbreviationstring

Short, descriptive string, used in the UI where it's not practical to display the full question body. E.g., "Greeting".

answerInstructionsstring

Instructions describing how to determine the answer.

questionType'QA_QUESTION_TYPE_UNSPECIFIED' | 'CUSTOMIZABLE' | 'PREDEFINED'

The type of question.

questionBodystring

Question text. E.g., "Did the agent greet the customer?"

createTimestring google-datetime

Output only. The time at which this question was created.

updateTimestring google-datetime

Output only. The most recent time at which the question was updated.

namestring

Identifier. The resource name of the question. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}

tagsstring[]

Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question.

orderinteger

Defines the order of the question within its parent scorecard revision.

Response

Successful response