FHIR questionnaire on a gRPC Struct format

The project identifier for this survey. Equal to the parent of the corresponding Agent. Format: `projects//agent`.

all requested answers

The project identifier for this survey. Equal to the parent of the corresponding Agent. Format: `projects//agent`.

The parent of an agent. Equal to the survey ID. Format: `projects//agent`.

the number of the question to which this answer belongs

the ID of the session on which the answer was collected

Required; the full answer text

fixme: better names and doc-strings below Optional; contains the normalized value of the selected option (parameter) extracted

Optional; contains the original text of the selected option (parameter) extracted

First name of the User to be surveyed

Last name of the User to be surveyed

Phone number of the User to be surveyed

the ID of the session on which the answer was collected

Unique identifier of the User to be surveyed

The synonyms which are recognized as equivalent for identifying one option

Optional; Nested question if this specific choice gets chosen. Note: the follow-up question is only available for the SingleChoiceQuestion

The "canonical value" (i.e. the entity value)

The project identifier for this survey. Equal to the parent of the corresponding Agent. Format: `projects//agent`.

The project identifier for this survey. Equal to the parent of the corresponding Agent. Format: `projects//agent`.

ID of one specific session on which survey answers were collected (contains survey_id)

User Identifier. Note, if the survey is anonymous there will no identifier to filter on

User phone number. Note, if the survey is anonymous there will no identifier to filter on

The project identifier for this survey. Equal to the parent of the corresponding Agent. Format: `projects//agent`.

Optional. The next_page_token value returned from a previous list request. Example: "current_index-10--page_size-20" Start page -> 10 Page size -> 20

The list of surveys. There will be a maximum number of items returned based on the page_token field in the request.

Token to retrieve the next page of results, or empty if there are no more results in the list.

The text which introduces the question (should be pronounceable)

List of choices which are accepted for this question Each Choice is represented by lists of synonyms. Note: needs to contain at least 2 choices

The text which introduces the question (should be pronounceable)

The display name of the entity (type) which is accepted as an answer to this question Note: the corresponding entity_type must exist (system entity type) and is not automatically created

The text which introduces the question (should be pronounceable)

convenience wrapper around a SingleChoiceQuestion

The text which introduces the question (should be pronounceable)

The text which introduces the question (should be pronounceable)

List of choices which are accepted for this question Each Choice is represented by lists of synonyms. Note: needs to contain at least 2 choices

The text which introduces the question (should be pronounceable)

The display name of the entity (type) which is accepted as an answer to this question Note: the corresponding entity_type must exist (system entity type) and is not automatically created

The project identifier for this survey. Equal to the parent of the corresponding Agent. Format: `projects//agent`. Read-only in the Survey message (assigned by the back-end)

Required. The (human readable) name of this survey

Required. The language of the agent created for the survey. This is also the only supported language of the agent. ISO 639-1 language code

Required. List of questions to be asked during the survey.

Required. Information about the entity behind the survey, the purpose of the survey, legal stuff, etc.

Optional. List of subflows excluded for this survey.

Current status of the NLU Agent respecting to the Survey

The project identifier for this survey. Equal to the parent of the corresponding Agent. Format: `projects//agent`.

all requested answers

Required unless SubFlow.LEGAL_ENTITY is deselected. The legal entity (company, research institute, etc.) on whose behalf the survey is performed

Required unless SubFlow.POSTAL_ADDRESS is deselected. The postal address to which callees can direct any requests.

Required unless SubFlow.EMAIL_ADDRESS is deselected. The email address to which callees can direct any requests.

Required unless SubFlow.PHONE_NUMBER is deselected. The phone number to which callees can direct any requests.

Required unless SubFlow.PHONE_HOURS is deselected. The phone hours during which callees can call (in pronounceable form).

Required unless SubFlow.EXPECTED_DURATION is deselected. The expected duration of the survey (in pronounceable form)

Required unless SubFlow.PURPOSE is deselected. An explanation regarding the purpose of the survey (in pronounceable form)

Required. A one-word explanation of the survey topic (in pronounceable form)

Required. A pronounceable explanation of the legal implications of participating in the survey. For example: "Your answers during this survey will be stored anonymously for the next two years and then deleted." Should be formulated such that the agent can afterwards ask for the consent of the user. Example for how the agent could continue: "Are you willing to participate in this survey?"

Optional. Defaults to False. Allows the definition of a survey as anonymous or not. If the survey is not anonymous, the name of the people as well as their number will be recorded

Updated survey. Note: the ID must refer to an existing survey which will be updated

Optional. Field mask that defines which fields get updated. Default: all fields are updated. Example: - update_mask = FieldMask( [ 'survey.display_name', 'survey.questions' ] )