Contact UsGet started

Talk Analytics API, gRPC: ProjectService.Create

Written by
Updated at November 26, 2024

rpc for creating speechsense project

gRPC request

rpc Create (CreateProjectRequest) returns (operation.Operation)

CreateProjectRequest

{
  "name": "string",
  "connection_id": "string",
  "description": "string",
  "filters": [
    {
      "key": "string",
      "field_value": "string"
    }
  ]
}

Field

Description

name

string

project name

connection_id

string

id of connection the project should belong too

description

string

project description

filters[]

FieldFilter

project filters

FieldFilter

simple filters to match talks based on their connection metadata

Field

Description

key

string

connection metadata field key

field_value

string

connection metadata field value

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "name": "string",
    "connection_id": "string",
    "description": "string",
    "created_by": "string",
    "created_at": "google.protobuf.Timestamp",
    "modified_by": "string",
    "modified_at": "google.protobuf.Timestamp",
    "filters": [
      {
        "key": "string",
        "field_value": "string"
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateProjectMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Project

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateProjectMetadata

Field

Description

id

string

Project

Field

Description

id

string

name

string

connection_id

string

description

string

created_by

string

created_at

google.protobuf.Timestamp

modified_by

string

modified_at

google.protobuf.Timestamp

filters[]

FieldFilter

FieldFilter

simple filters to match talks based on their connection metadata

Field

Description

key

string

connection metadata field key

field_value

string

connection metadata field value
Previous
Overview
Next
Overview