Class PhraseSet (4.8.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 4.8.0keyboard_arrow_down  
  
 
    
    
    
      
  
  
  
    
public   final   class  PhraseSet   extends   GeneratedMessageV3   implements   PhraseSetOrBuilder  
   Provides "hints" to the speech recognizer to favor specific words and phrases
 in the results.
 Protobuf type google.cloud.speech.v1.PhraseSet
Static Fields
   
  BOOST_FIELD_NUMBER 
  
    
public   static   final   int   BOOST_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  NAME_FIELD_NUMBER 
  
    
public   static   final   int   NAME_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  PHRASES_FIELD_NUMBER 
  
    
public   static   final   int   PHRASES_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   PhraseSet   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   PhraseSet . Builder   newBuilder ()  
  
  newBuilder(PhraseSet prototype) 
  
    
public   static   PhraseSet . Builder   newBuilder ( PhraseSet   prototype )  
  
    
      
        Parameter  
      
        Name Description  
      
        prototypePhraseSet  
     
  
  
  
    
public   static   PhraseSet   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   PhraseSet   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   PhraseSet   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   PhraseSet   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   PhraseSet   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   PhraseSet   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   PhraseSet   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   PhraseSet   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   PhraseSet   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   PhraseSet   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   PhraseSet   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   PhraseSet   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<PhraseSet>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getBoost() 
  
   Hint Boost. Positive value will increase the probability that a specific
 phrase will be recognized over other similar sounding phrases. The higher
 the boost, the higher the chance of false positive recognition as well.
 Negative boost values would correspond to anti-biasing. Anti-biasing is not
 enabled, so negative boost will simply be ignored. Though boost can
 accept a wide range of positive values, most use cases are best served with
 values between 0 (exclusive) and 20. We recommend using a binary search
 approach to finding the optimal value for your use case as well as adding
 phrases both with and without boost to your requests.
 float boost = 4;
    
      
        Returns  
      
        Type Description  
      
        float The boost.
 
     
  
  getDefaultInstanceForType() 
  
    
public   PhraseSet   getDefaultInstanceForType ()  
  
  getName() 
  
   The resource name of the phrase set.
 string name = 1;
    
      
        Returns  
      
        Type Description  
      
        String The name.
 
     
  
  getNameBytes() 
  
    
public   ByteString   getNameBytes ()  
   The resource name of the phrase set.
 string name = 1;
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for name.
 
     
  
  getParserForType() 
  
    
public   Parser<PhraseSet>   getParserForType ()  
  
  Overrides 
  
  getPhrases(int index) 
  
    
public   PhraseSet . Phrase   getPhrases ( int   index )  
   A list of word and phrases.
 repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
    
      
        Parameter  
      
        Name Description  
      
        indexint  
     
  
  
  getPhrasesCount() 
  
    
public   int   getPhrasesCount ()  
   A list of word and phrases.
 repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  getPhrasesList() 
  
    
public   List<PhraseSet . Phrase >  getPhrasesList ()  
   A list of word and phrases.
 repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
getPhrasesOrBuilder(int index) 
  
    
public   PhraseSet . PhraseOrBuilder   getPhrasesOrBuilder ( int   index )  
   A list of word and phrases.
 repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
    
      
        Parameter  
      
        Name Description  
      
        indexint  
     
  
  
  getPhrasesOrBuilderList() 
  
    
public   List <?   extends   PhraseSet . PhraseOrBuilder >  getPhrasesOrBuilderList ()  
   A list of word and phrases.
 repeated .google.cloud.speech.v1.PhraseSet.Phrase phrases = 2;
    
      
        Returns  
      
        Type Description  
      
        List <? extends com.google.cloud.speech.v1.PhraseSet.PhraseOrBuilder > 
     
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  getUnknownFields() 
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
  
  Overrides 
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   PhraseSet . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   PhraseSet . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   PhraseSet . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]