Console
    Contact Us Start free

    Class v2.PredictionServiceClient (1.1.6)

    Service for making recommendation prediction. v2

    Package

    @google-cloud/retail!

    Constructors

    (constructor)(opts)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of PredictionServiceClient.

    Parameter
    Name Description
    opts ClientOptions

    Properties

    apiEndpoint

      static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

    Property Value
    Type Description
    string

    auth

      auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;
    Property Value
    Type Description
    gax. GoogleAuth

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;
    Property Value
    Type Description
    Descriptors

    innerApiCalls

      innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: Function ; }

    pathTemplates

      pathTemplates 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 gax 
 . 
 PathTemplate 
 ; 
  
 };
    Property Value
    Type Description
    { [name: string]: gax. PathTemplate ; }

    port

      static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

    The port for this API service.

    Property Value
    Type Description
    number

    predictionServiceStub

      predictionServiceStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;
    Property Value
    Type Description
    Promise <{ [name: string]: Function ; }>

    scopes

      static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

    The scopes needed to make gRPC calls for every method defined in this service.

    Property Value
    Type Description
    string[]

    servicePath

      static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service.

    Property Value
    Type Description
    string

    warn

      warn 
 : 
  
 ( 
 code 
 : 
  
 string 
 , 
  
 message 
 : 
  
 string 
 , 
  
 warnType 
 ?: 
  
 string 
 ) 
  
 = 
>  
 void 
 ;
    Property Value
    Type Description
    (code: string, message: string, warnType?: string) => void

    Methods

    catalogPath(project, location, catalog)

      catalogPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 catalog 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified catalog resource name string.

    Parameters
    Name Description
    project string
    location string
    catalog string
    Returns
    Type Description
    string

    {string} Resource name string.

    close()

      close 
 () 
 : 
  
 Promise<void> 
 ;

    Terminate the gRPC channel and close the client.

    The client will no longer be usable and all future behavior is undefined.

    Returns
    Type Description
    Promise <void>

    {Promise} A promise that resolves when the client is closed.

    getProjectId()

      getProjectId 
 () 
 : 
  
 Promise<string> 
 ;
    Returns
    Type Description
    Promise <string>

    getProjectId(callback)

      getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameter
    Name Description
    callback Callback <string, undefined, undefined>
    Returns
    Type Description
    void

    initialize()

      initialize 
 () 
 : 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

    Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

    You can await on this method if you want to make sure the client is initialized.

    Returns
    Type Description
    Promise <{ [name: string]: Function ; }>

    {Promise} A promise that resolves to an authenticated service stub.

    matchBranchFromProductName(productName)

      matchBranchFromProductName 
 ( 
 productName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the branch from Product resource.

    Parameter
    Name Description
    productName string

    A fully-qualified path representing Product resource.
    Returns
    Type Description
    string | number

    {string} A string representing the branch.

    matchCatalogFromCatalogName(catalogName)

      matchCatalogFromCatalogName 
 ( 
 catalogName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the catalog from Catalog resource.

    Parameter
    Name Description
    catalogName string

    A fully-qualified path representing Catalog resource.
    Returns
    Type Description
    string | number

    {string} A string representing the catalog.

    matchCatalogFromProductName(productName)

      matchCatalogFromProductName 
 ( 
 productName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the catalog from Product resource.

    Parameter
    Name Description
    productName string

    A fully-qualified path representing Product resource.
    Returns
    Type Description
    string | number

    {string} A string representing the catalog.

    matchLocationFromCatalogName(catalogName)

      matchLocationFromCatalogName 
 ( 
 catalogName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the location from Catalog resource.

    Parameter
    Name Description
    catalogName string

    A fully-qualified path representing Catalog resource.
    Returns
    Type Description
    string | number

    {string} A string representing the location.

    matchLocationFromProductName(productName)

      matchLocationFromProductName 
 ( 
 productName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the location from Product resource.

    Parameter
    Name Description
    productName string

    A fully-qualified path representing Product resource.
    Returns
    Type Description
    string | number

    {string} A string representing the location.

    matchProductFromProductName(productName)

      matchProductFromProductName 
 ( 
 productName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the product from Product resource.

    Parameter
    Name Description
    productName string

    A fully-qualified path representing Product resource.
    Returns
    Type Description
    string | number

    {string} A string representing the product.

    matchProjectFromCatalogName(catalogName)

      matchProjectFromCatalogName 
 ( 
 catalogName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Catalog resource.

    Parameter
    Name Description
    catalogName string

    A fully-qualified path representing Catalog resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    matchProjectFromProductName(productName)

      matchProjectFromProductName 
 ( 
 productName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

    Parse the project from Product resource.

    Parameter
    Name Description
    productName string

    A fully-qualified path representing Product resource.
    Returns
    Type Description
    string | number

    {string} A string representing the project.

    predict(request, options)

      predict 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.retail.v2.IPredictRequest
    options CallOptions
    Returns
    Type Description
    Promise <[ protos. google.cloud.retail.v2.IPredictResponse , protos. google.cloud.retail.v2.IPredictRequest | undefined, {} | undefined ]>

    predict(request, options, callback)

      predict 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.retail.v2.IPredictRequest
    options CallOptions
    callback Callback <protos. google.cloud.retail.v2.IPredictResponse , protos. google.cloud.retail.v2.IPredictRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    predict(request, callback)

      predict 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IPredictRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.retail.v2.IPredictRequest
    callback Callback <protos. google.cloud.retail.v2.IPredictResponse , protos. google.cloud.retail.v2.IPredictRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    productPath(project, location, catalog, branch, product)

      productPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 catalog 
 : 
  
 string 
 , 
  
 branch 
 : 
  
 string 
 , 
  
 product 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

    Return a fully-qualified product resource name string.

    Parameters
    Name Description
    project string
    location string
    catalog string
    branch string
    product string
    Returns
    Type Description
    string

    {string} Resource name string.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: