Required. The project that the agent to train is associated with. Format:

projects/<project_uuid>

id of the user

ID of the project role of the user

Required. The project of this agent. Format:

projects/<project_uuid>/agent

Required. The name of this agent.

Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Update method.

Optional. The list of all languages supported by this agent (except for the default_language_code).

Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

Required. Specifies the format of the agent data.

Optional. Agent configuration as OndewoConfig converted to Struct format.

Optional. User id of the project owner. If empty, in CreateAgent call it is set to user id in the call metadata. Read-only in the Agent message

Optional. Status of the agent Read-only in the Agent message

Optional. Description of the agent.

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. Agent message and User message of its owner.

Required. The role of the user in the project in SHALLOW view (only ID and name fields are populated)

sorting field for agent sorting

Sorting mode

The agent

User who created the agent

Required. The project that the agent to build cache is associated with. Format:

projects/<project_uuid>

Name of the branch of the agent for versioning. The default branch name is develop.

The agent

Optional. Specify the view of the returned agent (sparse view by default)

Required. ID of the Platform. Custom Intent.Message.Platform placeholder. Note: it will not work with non-placeholders values

Required. Name to be displayed.

Optional. Sorting position of the GetPlatformMappingRequest.

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Required. Name of the resource to delete.

Required. Type of the resource (e.g., "audio", "image", "file").

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

Required. The project that the agent to export is associated with. Format:

projects/<project_uuid>

Optional. The Google Cloud Storage URI to export the agent to. Note: The URI must start with "gs://". If left unspecified, the serialized agent is returned inline.

Optional. The compression level of the zip file created. Valid range 1-9; the grpc-default value 0 will be mapped to 1, other values cause an error in the request validation handler.

The URI to a file containing the exported agent. This field is populated only if agent_uri is specified in ExportAgentRequest.

The exported agent. Example for how to export an agent to a zip file via a command line:

curl \
  'https://dialogflow.googleapis.com/v2/projects//agent:export'\
  -X POST \
  -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --compressed \
  --data-binary '{}' \
| grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".*/\1/' \
| base64 --decode > 

Agent related info Required. The project that the agent to export is associated with. Format:

projects/<project_uuid>

Optional. The compression level of the zip file created. Valid range 1-9; the grpc-default value 0 will be mapped to 1, other values cause an error in the request validation handler.

Train-test split related parameters, for further info, check https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.train_test_split.html default values come from API definition above Optional: bigger than zero

Optional: bigger than zero

Optional: random seed

Agent responses as zip file

Key is the language code, value is the corresponding ListTrainingPhrasesResponse

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Required. Name of the resource to export.

Required. Type of the resource (e.g., "audio", "image", "file").

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Required. Name of the exported resource.

Required. Type of the resource (e.g., "audio", "image", "file").

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

Required. The exported resource file content as bytes.

Required. The project that the agent is associated with. Format:

projects/<project_uuid>/agent

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

What to search for in the elastic server

Composite string: current_index-0--page_size-10 The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings:

• "" (empty string) - Retrieves the first page.
• "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
• "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.

• ""
• "current_index-0--page_size-20"
• "current_index-1--page_size-20"
• "current_index-10--page_size-20"

• "1"
• "current_index-0--page_size-20"
• "current_index--1--page_size-20"
• "current_index1--page_size-20"
• "current_index-1--page_size--20"

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of entity search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the entity

Display name of the entity

Name of the entity type this entity belongs to

Display name of the entity type

Language code of the entity

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of entity synonym search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the entity synonym

Display name of the entity synonym

Name of the entity type

Display name of the entity type

Name of the entity this synonym belongs to

Display name of the entity

Language code of the entity synonym

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of entity type search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the entity type

Display name of the entity type

Language code of the entity type

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of intent search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the intent

Display name of the intent

Domain name of the intent

Tags associated with the intent

Language code of the intent

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of intent input context search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the input context

Name of the intent this context belongs to

Display name of the intent

Tags associated with the intent

Language code of the context

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of intent output context search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the output context

Name of the intent this context belongs to

Display name of the intent

Tags associated with the intent

Language code of the context

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of intent parameter search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the parameter

Display name of the parameter

Name of the intent this parameter belongs to

Display name of the intent

Tags associated with the intent

Language code of the parameter

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of intent response search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings:

• "" (empty string) - Retrieves the first page.
• "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
• "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.

• ""
• "current_index-0--page_size-20"
• "current_index-1--page_size-20"
• "current_index-10--page_size-20"

• "1"
• "current_index-0--page_size-20"
• "current_index--1--page_size-20"
• "current_index1--page_size-20"
• "current_index-1--page_size--20"

Text content of the response

Platform for which this response is intended

Type of the response

Name of the intent this response belongs to

Display name of the intent

Tags associated with the intent

Language code of the response

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of intent tag search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the tag

Text content of the tag

Name of the intent this tag belongs to

Display name of the intent

Tags associated with the intent

Language code of the tag

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

List of intent training phrase search results

Search term used in the query

Elasticsearch query that was executed

Time taken to execute the query in seconds

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Name of the training phrase

Text of the training phrase

Text with entity types annotated

Text with entity values annotated

Type of the training phrase part

Name of the intent this training phrase belongs to

Display name of the intent

Tags associated with the intent

Language code of the training phrase

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Optional. Specify the view of the returned agent (full view by default)

Optional. A mask to control which fields are returned in the response.

Required. The project to get statistics from. Format:

projects/<project_uuid>

File formats for reports

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc. the language to calculate statistics about

Type of reports about the domain of the agent

Statistic info.

File formats for reports

Type of reports about the domain of the agent

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agent

Optional. Cache version to filter model statuses. If not specified, returns statuses for all cache versions.

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

Optional. Model name to filter model statuses. If not specified, returns statuses for all models.

List of model statuses matching the request filters.

version of the server build

git commit hash of the server build

Required. The project that the agent is associated with. Format:

projects/<project_uuid>/agent

Required. The project to get statistics from. Format:

projects/<project_uuid>

File formats for reports

Type of reports about the domain of the agent

Optional. A filter to narrow reports based on sessions

Optional. A filter to narrow reports based on contextual information (Coming soon! Not yet implemented)

Optional. limit the returned number of results

Optional. Grouping based on named properties

Optional. Order based on named properties

Optional. The mask to control which data fields will be added to the returned data.
Example: paths=["duration_in_s_min", "id", "session_id", "project_id"]

SQL Query - only usable with specific SessionsReportType such as SessionsReportType.SESSION_SQL_QUERY

Statistic info.

File formats for reports

Type of reports about the domain of the agent

Required. The project that the agent to import is associated with. Format:

projects/<project_uuid>

The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".

The agent to import.
Example for how to import an agent via the command line:

curl \
  'https://dialogflow.googleapis.com/v2/projects//agent:import\
   -X POST \
   -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
   -H 'Accept: application/json' \
   -H 'Content-Type: application/json' \
   --compressed \
   --data-binary "{
      'agentContent': '$(cat  | base64 -w 0)'
   }"

The list of agents with their owners of the given user. There will be a maximum number of items returned based on the page_token field in the request.

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Optional. Specify the view of the returned agent (full view by default)

Optional. The next_page_token value returned from a previous list request.

Optional. Defines the sorting of the list. Default, no sorting.

Optional. The mask to control which fields gets returned.

The list of agent and their owners. There will be a maximum number of items returned based on the page_token field in the request.

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings:

• "" (empty string) - Retrieves the first page.
• "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
• "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.

• ""
• "current_index-0--page_size-20"
• "current_index-1--page_size-20"
• "current_index-10--page_size-20"

• "1"
• "current_index-0--page_size-20"
• "current_index--1--page_size-20"
• "current_index1--page_size-20"
• "current_index-1--page_size--20"

Optional. The mask to control which fields gets returned.

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

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Required. The project that the agent to train is associated with. Format:

projects/<project_uuid>

Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings:

• "" (empty string) - Retrieves the first page.
• "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
• "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.

• ""
• "current_index-0--page_size-20"
• "current_index-1--page_size-20"
• "current_index-10--page_size-20"

• "1"
• "current_index-0--page_size-20"
• "current_index--1--page_size-20"
• "current_index1--page_size-20"
• "current_index-1--page_size--20"

Optional. The mask to control which fields gets returned.

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

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

The agent to migrate as zip file

Cache version that contains the correspondent model

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

The model name

Timestamp when the status was set. Read-only field.

Configuration of the model as a string.

Current status of the model.

Required. The project that the agent to train is associated with. Format:

projects/<project_uuid>

languages that should be optimized

optimization config will contain all possible optimizations, with which we will come up in the future

if in_place is true then the config of the agent on the server will be updated, if False then config with optimized thresholds will be returned but not updated on the server

info about optimization

the optimized configuration of the ondewo agent e.g., optimized parameters

Required. The project that the agent is associated with. Format:

projects/<project_uuid>/agent

Required. If not set, it will set it empty.

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

number of splits for optimization

random seed number for defining the split of train and test of training phrases for optimization

initial thresholds are optional, if not given will be taken from the current config
example {'OndewoIntentSimilarityMatch': 0.59, 'OndewoIntentNamedSimilarityMatch': 0.39}

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Optional, useful for versioning reasons of the agent data

Optional, useful for reindexing specific indices in the future

Required. The project that the agent to train is associated with. Format:

projects/<project_uuid>

id of the user

Required. The project that the agent to restore is associated with. Format:

projects/<project_uuid>

The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://".

The agent to restore.
Example for how to restore an agent via the command line:

curl \
  'https://dialogflow.googleapis.com/v2/projects//agent:restore\
   -X POST \
   -H 'Authorization: Bearer '$(gcloud auth print-access-token) \
   -H 'Accept: application/json' \
   -H 'Content-Type: application/json' \
   --compressed \
   --data-binary "{
       'agentContent': '$(cat  | base64 -w 0)'
   }" \

Required. The project of which to set the status. Format:

projects/<project_uuid>/agent

Required. Status of the agent

Optional. View of the returned agent

Required. The project that the agent to fetch is associated with. Format:

projects/<project_uuid>/agents

Required. Name of the resource.

Required. Type of the resource (e.g., "audio", "image", "file").

Required. The resource file content as bytes.

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

Required. The project that the agent to train is associated with. Format:

projects/<project_uuid>

Name of the branch of the agent for versioning. The default branch name is develop.

Defines when to initiate newly created agent when training started

The agent

Optional. Specify the view of the returned agent (sparse view by default)

Optional. The mask to control which fields get updated.

Required. The project that the agent to train is associated with. Format:

projects/<project_uuid>

User object

ID of the project role of the user

Alternative sentence

Score associated to the alternative sentence resulted

Alternative training phrase

Score associated to training_phrase

Activation flag

Factor of enrichment

Order of augmenter execution

Required. The project of this agent. Format:

projects/<project_uuid>/agent

the input text

the input language

Optional: if restrict classification result with input contexts listed in the field context_names

Optional: names of the input contexts to restrict the classification result with. Intents can only be classified if the intent's input context set is the subset of the given context set.

Optional: Which mode to use:

• EXCLUSIVE - skip algorithms listed in algorithms field,
• INCLUSIVE - run ONLY algorithms listed in algorithms field,
• UNSPECIFIED - default mode, described in agent config

Optional: Algorithm list

Optional. The mask to control which fields gets returned.

A list of intents detected

The text containing from which the intents were detected

Flag that enables the context through the conversation

The context tags associated to the intents

Entity augmenter configuration

Thesaurus augmenter configuration

Word2Vec augmenter configuration

WordNet augmenter configuration

GPT2 augmenter configuration

GloVe augmenter configuration

BERT augmenter configuration

XLNet augmenter configuration

Large language model (LLM) augmenter configuration

The entity name that is detected

The extractor name, e.g. SpacyNer

The confidence score of the detected entity

Activation flag

Factor of enrichment

Order of augmenter execution

The Entity Type

Optional. Overrides the minimal score in ExtractEntitiesFuzzyRequest.

Optional. If defined, only entity value from this list are considered.

Optional. Specify the Fuzzy Ner algorithm

Should not use allow_overlaps here, since its default value is False

the parent of the request Format:

projects/<project_uuid>

The text to be analyzed

Potential entities to be extracted from the text with entity-specific configs

Minimal similarity score to consider entity as "matched"

Optional. Whether or not entities are allowed to overlap.

Optional. The mask to control which fields gets returned.

the parent of the request Format:

projects/<project_uuid>

the input text

the input language

Optional. The name of the relevant intent. Used to establish preference hierarchy for entities that correspond to intent parameters Format:

projects/<project_uuid>/agent/intents/<intent_uuid>

Optional. The mask to control which fields gets returned.

A list of entities detected

The text containing the entities detected

Activation flag

Factor of enrichment

Order of augmenter execution

language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

the parent of the request Format:

projects/<project_uuid>

The number of synonyms desired

Git branch

Optional. Whether to drop unknown parameters from the generated responses

Optional. The mask to control which fields gets returned.

A list of responses

language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

the parent of the request Format:

projects/<project_uuid>

The number of synonyms desired

Git branch

Optional. The mask to control which fields gets returned.

A list of sampled sentences

Configuration type of the enricher

The sentence from which it is desired to get alternative sentences

Language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

the parent of the request Format:

projects/<project_uuid>

Protected words in the augmentation process

Words to be changed in the augmentation process

Optional. The mask to control which fields gets returned.

A list of alternative sentences

Configuration of the enricher

Training phrase from which an alternative one is got

The intent tag attached to the training phrase

language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

the parent of the request Format:

projects/<project_uuid>

Flag to determine whether entities must or not be detected

similarity threshold defines how similar sentences should be to drop generated training phrase as duplicate. Meaningful values of similarity_threshold are between 0.95 and 1.0

Protected words in the augmentation process

Words to be changed in the augmentation process

Git branch

Optional. The mask to control which fields gets returned.

A list of alternative training phrases

Configuration of the enricher

Word from which a synonym is got

language code specifies the language of the request in IETF BCP 47 language tag format, e.g. de-DE, en-US, etc.

the parent of the request Format:

projects/<project_uuid>

Optional. The mask to control which fields gets returned.

A list of synonyms

Activation flag

Factor of enrichment

Order of augmenter execution

The unique identifier of this intent. Format:

projects/<project_uuid>/agent/intents/<intent_uuid>

The name of the intent.

The name of the classifier that detected the intent

Score associated to the detection of the intent by the classifier

The CCAI service for which to list models. Format:

projects/<project_uuid>/ccai/services/<service_uuid>

Optional. The mask to control which fields gets returned.

A list of LLM models associated with the specified CCAI service.
Each model in this list represents an individual language model that can
be used within the service, including details such as name, provider, and description.

Activation flag

Factor of enrichment

Order of augmenter execution

The CCAI service to be used to enrich This specifies which large language model provider and model settings will handle the request. Format:

projects/<project_uuid>/ccai/services/<service_uuid>

The request payload for the LLM, structured according to the specific requirements of the large language model provider.
The payload must fit the format expected by the specified LLM provider, as defined by

CcaiServiceProvider

The CCAI service to be used for processing the request. This specifies which large language model provider and model settings will handle the request. Format:

projects/<project_uuid>/ccai/services/<service_uuid>

Files as input for the generation request

Optional. The mask to control which fields gets returned.

The response data from the LLM, returned as a structured payload.
This can contain the text generation, embeddings, or other outputs based on the specific request made to the LLM provider.

Files as input for the generation request, e.g., generated pictures, audio or video

The resource name of the model. Format:

projects/<project_uuid>/ccai/services/<service_uuid>/model/<model_uuid>

The display name of the model. This is a human-readable name used for identifying the model in other requests, such as

LlmGenerateRequest

StreamingLlmGenerateRequest

The description of the model. Provides additional details about the model, such as its purpose, architecture, or any other relevant information.

The resource name of the CCAI service to which the model belongs. This field links the model to its service context, helping clients understand which service hosts the model.

The provider of the CCAI service that offers this model. Specifies the LLM provider (e.g., Ollama, OpenAI, Google, etc.), indicating the origin or vendor of the model.

The response data from the LLM in a streaming format, returned as a structured payload.
This response is part of a continuous stream of data from the LLM, allowing incremental results to be sent as they are generated.

Synonym word

Score associated to the synonym resulted

Activation flag

Factor of enrichment

Order of augmenter execution

Activation flag

Factor of enrichment

Order of augmenter execution

Activation flag

Factor of enrichment

Order of augmenter execution

Activation flag

Factor of enrichment

Order of augmenter execution

Resource name of the CCAI service project

Required. The display name of this ccai project.

Optional. Resource name of the user who is the owner of the project.

Map of two letter language codes to lists of CcaiServiceList Two-letter language codes following ISO 639-1 (see https://en.wikipedia.org/wiki/ISO_639-1)

The status of the ccai project.

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in the form of a valid UUID.

User id in the form of a valid UUID.

Required. Associated NLU agent Format:

projects/<project_uuid>/agent

sorting field for ccai projects sorting

Sorting mode

Resource name of the service. Must be unique.

Display name for better identification.

Language code representing the service language Format (e.g., "en" for English, "de" for German).

gRPC host for communication with the specified port.

Port for gRPC communication.

Web gRPC host for web-based communication with the specified port.

Port for web gRPC communication.

Path to the gRPC certificate for secure communication.

Additional host for communication, if needed.

Port for additional communication.

Another additional port for communication if required.

Http basic auth token

Account name for authentication.

Password for the specified account for authentication.

API key for accessing the service, if applicable.

Type of CCAI service service (e.g., TEXT_TO_SPEECH, SPEECH_TO_TEXT).

Resource name of the ccai_project the ccai_service belongs to

Detailed configuration of the CcaiService

Creation date and time of the service. Read-only field.

Modification date and time of the service. Read-only field.

User ID of the creator in the form of a valid UUID. Read-only field.

User ID of the last modifier in the form of a valid UUID. Read-only field.

Optional. The headers of the request message

Provider of the ccai service

Index indicating the hierarchical position of a service within the service hierarchy. The index follows a tree-like structure, where each level of depth is separated by a "_". For example:

• "1" represents a top-level service
• "1_1" represents a sub-service under "1"
• "1_1_1" represents a sub-service under "1.1"

• "1" Service A
• "1_1" Service B
• "1_1" Service C

Language codes of the projects for which services are filtered.

Type of CCAI service service

Type of CCAI service providers

CCAI service services

The CCAI service project to be created.

Required. The nlu agent project of this CcaiProject. Format:

projects/<project_uuid>/agent

The created CCAI service project.

Error message if the creation is unsuccessful.

CCAI service project name with which to perform the call of the form

projects/<project_uuid>/project

Required. The nlu agent project of this CcaiProject. Format:

projects/<project_uuid>/agent

CCAI service project name with which to perform the call of the form

projects/<project_uuid>/project

error message if there are any.

Required. The nlu agent project of this CcaiProject. Format:

projects/<project_uuid>/agent

CCAI service project name with which to perform the call of the form

projects/<project_uuid>/project

Optional. Specify the view of the returned CcaiProject (full view by default)

Filter which services should be included in the returned CcaiProject

Required. The nlu agent project of this CcaiProject. Format:

projects/<project_uuid>/agent

Optional. The mask to control which fields gets returned.

CCAI service project name with which to perform the call of the form

projects/<project_uuid>/ccai/services/<service_uuid>

Required. The nlu agent project of this CcaiProject. Format:

projects/<project_uuid>/agent

Optional. The mask to control which fields gets returned.

Optional. Specify the view of the returned CcaiProject (full view by default)

Filter which services should be included in the CcaiProject

Optional. Field to define the sorting of the list of CCAI service projects in the response. If not specified, the default behavior is to have no sorting.

Optional. The next_page_token value returned from a previous list request. Example: "current_index-1--page_size-20" The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings:

• "" (empty string) - Retrieves the first page.
• "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
• "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.

• ""
• "current_index-0--page_size-20"
• "current_index-1--page_size-20"
• "current_index-10--page_size-20"

• "1"
• "current_index-0--page_size-20"
• "current_index--1--page_size-20"
• "current_index1--page_size-20"
• "current_index-1--page_size--20"

Required. The nlu agent project of this CcaiProject. Format:

projects/<project_uuid>/agent

Optional. The mask to control which fields gets returned.

The list of CCAI service projects returned in the response. Use the 'repeated' keyword to indicate that this field can contain multiple instances of CcaiProject.

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

The CcaiProject that should be updated

Filter which services should be updated in the CcaiProject

Optional. The mask to control which fields get updated.

Required. The nlu agent project of this CcaiProject. Format:

projects/<project_uuid>/agent

CCAI service project name with which to perform the call of the form

projects/<project_uuid>/project

error message if there are any.

List of notifications to be added.

List of notifications that have been added.

resource name of the comment

text of the comment

User id as resource name. Format:

projects/<project_uuid>/agent/users/<user_uuid>

name of the resource for which the comment is about. Format:

projects/<project_uuid>/agent/<resource_type>/<resource_uuid>/.../

The resource name of the parent comment. A parent comment is a reply to a certain comment. Format:

projects/<project_uuid>/agent/<resource_type>/<resource_uuid>/.../

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

The key of the key-value pair.

The integer value (if applicable).

The float value (if applicable).

The double value (if applicable).

The string value (if applicable).

The timestamp value (if applicable).

Optional filter to narrow the response down to specific notifications.

Optional. Token for pagination, obtained from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings:

• "" (empty string) - Retrieves the first page.
• "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
• "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.

• ""
• "current_index-0--page_size-20"
• "current_index-1--page_size-20"
• "current_index-10--page_size-20"

• "1"
• "current_index-0--page_size-20"
• "current_index--1--page_size-20"
• "current_index1--page_size-20"
• "current_index-1--page_size--20"

Optional. Mask to control which fields will be filled with data.
Example: path=["notification.user_names"]

List of notifications that meet the specified criteria.

resource name of the notification

User id as resource name. Format:

projects/<project_uuid>/agent/users/<user_uuid>

User id as resource name. Format:

projects/<project_uuid>/agent/users/<user_uuid>

A short notification text is displayed directly with max. 50 chars which is a truncated version of the long message

A long notification text

Has a notification been flagged by a specific user

When the user marked the notification as read

Has a notification been read by a specific user

When the user marked the notification as read, i.e. read the notification

The origin of a notification. A Notification origin can be from a product (service), e.g. ondewo-nlu, ondewo-s2t, ondewo-t2s, etc.

The name of resource of where the notification originated

language of the origin resource e.g. language of the nlu agent or language of the speech-to-text service

The type of notification

The visibility level of the notification

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Language codes of the projects for which notifications are filtered.

Origins of the notifications to filter.

Visibilities of the notifications to filter.

Flagged status of the notifications to filter.

Read status of the notifications to filter.

Filter notifications with a time range starting from the specified earliest time.

Filter notifications with a time range ending at the specified latest time.

Resource names of users to filter notifications for.

Resource names of the origin of the notification to filter notifications.

Names of notifications to set the flagged status for.

Flagged status to set for the specified notifications.

Names of notifications to set the read status for.

Read status to set for the specified notifications.

Response wrapper for the "Get<Stat>" endpoints

Required. The display name of the context (must be unique per session). Note: we are deviating from the dialogflow format projects/<project_uuid>/agent/sessions/<session_uuid>/contexts/<context_uuid>.

• DetectIntent only returns
  • the short display name in the "name" field in query_result.output_contexts
  • only expects the short display name in the "name" field in query_parameters.contexts
• Also inside the persisted session object only the short display name is used.
  • SessionStep.contexts only contains the short display name
  • SessionReviewStep.contexts only contains the short display name

Optional. The number of conversational query requests after which the context expires. If set to 0 (the default) the context expires immediately. Contexts expire automatically after 10 minutes even if there are no matching queries.

Optional. The collection of parameters associated with this context. Refer to this doc for syntax. Keys are the display names of context parameters.

Optional. The time span in seconds after which the context expires. By default it does not expire.

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

The name of the context parameter.

The display name of the context parameter.

The value(s) of the context parameter.

The original value(s) of the context parameter.

Creation date and time. Read-only field.

Modification date and time. Read-only field.

User id in form of a valid UUID.

User id in form of a valid UUID.

Required. The session to create a context for. Format:

projects/<project_uuid>/agent/sessions/<session_uuid>

Required. The context to create.

Required. The name of the session to delete all contexts from. Format:

projects/<project_uuid>/agent/sessions/<session_uuid>

Required. The name of the context to delete. Format: projects/<project_uuid>/agent/sessions/<session_uuid>/contexts/<context_uuid>.

Required. The name of the context. Format: projects/<project_uuid>/agent/sessions/<session_uuid>/contexts/<context_uuid>.

Required. The session to list all contexts from. Format:

projects/<project_uuid>/agent/sessions/<session_uuid>

Optional. The next_page_token value returned from a previous list request. The page token to support pagination. Pagination allows you to retrieve a large result set in smaller, more manageable portions. The page token is a string representing the current index and page size. Valid page token strings:

• "" (empty string) - Retrieves the first page.
• "current_index-0--page_size-20" - Retrieves the first page with a page size of 20.
• "current_index-1--page_size-20" - Retrieves the second page with a page size of 20.

• ""
• "current_index-0--page_size-20"
• "current_index-1--page_size-20"
• "current_index-10--page_size-20"

• "1"
• "current_index-0--page_size-20"
• "current_index--1--page_size-20"
• "current_index1--page_size-20"
• "current_index-1--page_size--20"

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

The next_page_token is used to retrieve the next page of a returned result, e.g. next_page_token is current_index-2

Required. The context to update.

Optional. The mask to control which fields get updated.