# Dialogflow API . projects . locations

## Instance Methods

Returns the agent Resource.

Returns the answerRecords Resource.

Returns the conversationProfiles Resource.

Returns the conversations Resource.

Returns the encryptionSpec Resource.

Returns the generators Resource.

Returns the knowledgeBases Resource.

Returns the operations Resource.

Returns the phoneNumbers Resource.

Returns the sipTrunks Resource.

Returns the statelessSuggestion Resource.

Returns the suggestions Resource.

Returns the tools Resource.

Close httplib2 connections.

Deletes the specified agent.

Gets information about a location.

Retrieves the specified agent.

Gets location-level encryption key specification.

Lists information about the supported locations for this service.

Retrieves the next page of results.

Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).

### Method Details

`close()`

    Close httplib2 connections.

`deleteAgent(parent, x__xgafv=None)`

    Deletes the specified agent.

    Args:
      parent: string, Required. The project that the agent to delete is associated with. Format: `projects/` or `projects//locations/`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
    }

`get(name, x__xgafv=None)`

    Gets information about a location.

    Args:
      name: string, Resource name for the location. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A resource that represents a Google Cloud location.
      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
        "a_key": "A String",
      },
      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
    }

`getAgent(parent, x__xgafv=None)`

    Retrieves the specified agent.

    Args:
      parent: string, Required. The project that the agent to fetch is associated with. Format: `projects/` or `projects//locations/`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
      "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
      "avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
      "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
      "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
      "description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
      "displayName": "A String", # Required. The name of this agent.
      "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
      "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
      "parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
      "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
        "A String",
      ],
      "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
      "timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
    }

`getEncryptionSpec(name, x__xgafv=None)`

    Gets location-level encryption key specification.

    Args:
      name: string, Required. The name of the encryption spec resource to get. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
      "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
      "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
    }

`list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists information about the supported locations for this service.

    Args:
      name: string, The resource that owns the locations collection, if applicable. (required)
      extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
      filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
      pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
      pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The response message for Locations.ListLocations.
      "locations": [ # A list of locations that matches the specified filter in the request.
        { # A resource that represents a Google Cloud location.
          "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
          "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
            "a_key": "A String",
          },
          "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
          "metadata": { # Service-specific metadata. For example the available capacity at the given location.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
        },
      ],
      "nextPageToken": "A String", # The standard List next-page token.
    }

`list_next()`

    Retrieves the next page of results.

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

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`setAgent(parent, body=None, updateMask=None, x__xgafv=None)`

    Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).

    Args:
      parent: string, Required. The project of this agent. Format: `projects/` or `projects//locations/` (required)
      body: object, The request body.
        The object takes the form of:

    { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
      "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
      "avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
      "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
      "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
      "description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
      "displayName": "A String", # Required. The name of this agent.
      "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
      "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
      "parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
      "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
        "A String",
      ],
      "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
      "timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
    }

      updateMask: string, Optional. The mask to control which fields get updated.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).
      "apiVersion": "A String", # Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.
      "avatarUri": "A String", # Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.
      "classificationThreshold": 3.14, # Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.
      "defaultLanguageCode": "A String", # Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.
      "description": "A String", # Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.
      "displayName": "A String", # Required. The name of this agent.
      "enableLogging": True or False, # Optional. Determines whether this agent should log conversation queries.
      "matchMode": "A String", # Optional. Determines how intents are detected from user queries.
      "parent": "A String", # Required. The project of this agent. Format: `projects/` or `projects//locations/`
      "supportedLanguageCodes": [ # Optional. The list of all languages supported by this agent (except for the `default_language_code`).
        "A String",
      ],
      "tier": "A String", # Optional. The agent tier. If not specified, TIER_STANDARD is assumed.
      "timeZone": "A String", # Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.
    }