Method: projects.locations.conversations.ingestContextReferences

Data ingestion API. Ingests context references for an existing conversation.

HTTP request

POST https://{endpoint}/v2/{conversation=projects/*/locations/*/conversations/*}:ingestContextReferences

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
conversation

string

Required. Resource identifier of the conversation to ingest context information for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

Authorization requires the following IAM permission on the specified resource conversation:

  • dialogflow.conversations.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "contextReferences": {
    string: {
      object (ContextReference)
    },
    ...
  }
}
Fields
contextReferences

map (key: string, value: object (ContextReference))

Required. The context references to ingest. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Response body

The response message for [ConversationsService.IngestContextReferences][].

If successful, the response body contains data with the following structure:

JSON representation 
{
  "ingestedContextReferences": {
    string: {
      object (ContextReference)
    },
    ...
  }
}
Fields
ingestedContextReferences

map (key: string, value: object (ContextReference))

All context references ingested.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.