package mozolm.grpc

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetLMScores (GetContextRequest, LMScores)

  service.proto:55

  Returns the probs and normalization for given state.

  errors: invalid state;

• rpc GetNextState (GetContextRequest, NextState)

  service.proto:60

  Returns the next state for symbol from context.

  errors: none.

  message NextState

  service.proto:37

  Next available ID: 2

  • int64 next_state = 1

• rpc UpdateLMScores (UpdateLMScoresRequest, LMScores)

  service.proto:65

  Updates the count and normalization for given state and utf8_sym.

  errors: invalid utf8_sym or count <= 0.

  message UpdateLMScoresRequest

  service.proto:42

  Next available ID: 4

  • int64 state = 1

    State where count should be updated.

  • repeated int32 utf8_sym = 2

    String of symbols whose count should be updated at that state.

  • int32 count = 3

    Count to add to state and symbol.

Client authentication details: This message is supposed to be used in conjunction with the corresponding server authentication configuration defined in `ServerAuthConfig` message. Next available ID: 2

Used in: ClientConfig

• optional ClientAuthConfig.TlsConfig tls = 1

  TLS/TLS configuration for a secure gRPC channel. If not given, insecure connection is used.

Next available ID: 4

Used in: ClientAuthConfig

• string target_name_override = 1

  Target name override for TLS host name checking. This should *not* be used in production. Normally, the name of the target should match the Common Name (aka `CN`) that represents the server name protected by the TLS certificate. The certificate is valid only if the request hostname matches the certificate common name. The Subject Alternative Name (SAN) is an extension to the X.509 specification that allows users to specify additional host names for a single TLS certificate. This is replacing Common Name (CN) mechanism. Example: See `subjectAltName` key in `opentls.conf` under the `testdata/x509` directory.

• string client_cert = 2

  Public client certificate (PEM encoded).

• string client_key = 3

  Private client key for TLS (PEM encoded).

Next available ID: 9

• optional ServerConfig server = 1

  Server configuration. Several values in server configuration, such as endpoint configuration and authentication details, are needed to in order to successfully establish client connections.

• optional ClientAuthConfig auth = 2

  Client authentication details.

• ClientConfig.ClientRequestType request_type = 3

  Type of request client will be making to the server.

• int32 k_best = 5

  Number of items to return in k_best extraction.

• string context_string = 6

  Context string prior to k_best extraction or random generation.

• string test_corpus = 7

  Test corpus for calculating bits-per-character.

• double timeout_sec = 8

  Timeout when waiting for response from server specified in seconds.

Used in: ClientConfig

• NOT_SET = 0

  Client request type not set.

• K_BEST_ITEMS = 1

  Returns k-best items following context_string.

• RANDGEN = 2

  Randomly generates string.

• BITS_PER_CHAR_CALCULATION = 3

  Calculates bits-per-char on given test_corpus.

Used in: ServerAuthConfig

• CREDENTIAL_INSECURE = 0

  Not recommended for actual deployments when security and privacy are required.

• CREDENTIAL_TLS = 1

  https://en.wikipedia.org/wiki/Transport_Layer_Security

Next available ID: 3

Used as request type in: MozoLMService.GetLMScores, MozoLMService.GetNextState

• int64 state = 1

  Initial state for getting state information.

• string context = 2

  Context string (from initial state) for info.

Next available ID: 3

Used in: ServerConfig

• CredentialType credential_type = 1

  Type of authorization credentials used in client/server handshake.

• optional ServerAuthConfig.TlsConfig tls = 2

  TLS/TLS configuration for a secure gRPC channel. If not given, insecure connection is used.

Configuration for TLS/SSL server credentials. This and the corresponding client-side configuration in `client_config.proto` introduces the following PEM-encoded credentials: - server_ca_cert: The certificate authority who has signed the `server_cert`. - server_cert: The server certificate chain, verified by the client via `server_ca_cert`. - server_key: The private key of the server. - client_ca_cert: The certificate authority who has signed the `client_cert`. - client_cert: The client certificate chain, verified by the server via `client_ca_cert`. - client_key: The private key of the client. The certificate authorities `server_ca_cert` and `client_ca_cert` may or may not be the same. For mutual authentication all of the above are required. Next available ID: 5

Used in: ServerAuthConfig

• string server_key = 1

  Private server key for TLS (PEM encoded).

• string server_cert = 2

  Public server certificate (PEM encoded).

• string custom_ca_cert = 3

  Custom certificate authority (PEM encoded).

• bool client_verify = 4

  Whether a valid client certificate is required.

Next available ID: 6

Used in: ClientConfig

• optional ModelHubConfig model_hub_config = 1

  Model hub configuration.

• string address_uri = 2

  The address to try to bind to the server in URI form. If the scheme name is omitted, "dns:///" is assumed. To bind to any address, please use IPv6 any, i.e., [::]:<port>, which also accepts IPv4 connections. Valid values include `dns:///localhost:1234`, `192.168.1.1:31416`, `dns:///[::1]:27182`, etc. To use UNIX domain, rather than TCP, sockets (aka UDS) use the "unix:///" scheme. Example: `unix:///tmp/example.sock`. Ideally the socket should be removed upon shutting down.

• optional ServerAuthConfig auth = 3

  Configuration for authentication mechanisms.

• bool wait_for_clients = 4

  Whether the server will wait for client requests. Always enabled by default, only disabled for the testing.

• int32 async_pool_size = 5

  Number of threads for handling requests asynchronously.