Function defineCompatOpenAIModel

defineCompatOpenAIModel<CustomOptions extends z.ZodTypeAny = z.ZodTypeAny>(
    params: {
        client: OpenAI;
        modelRef?: ModelReference<CustomOptions>;
        name: string;
        pluginOptions?: PluginOptions;
        requestBuilder?: ModelRequestBuilder;
    },
): ModelAction
Method to define a new Genkit Model that is compatible with Open AI Chat Completions API.

These models are to be used to chat with a large language model.
Type Parameters
- CustomOptions extends z.ZodTypeAny = z.ZodTypeAny
Parameters
- params: {
      client: OpenAI;
      modelRef?: ModelReference<CustomOptions>;
      name: string;
      pluginOptions?: PluginOptions;
      requestBuilder?: ModelRequestBuilder;
  }
  An object containing parameters for defining the OpenAI Chat model.
  - client: OpenAI
    The OpenAI client instance.
  - OptionalmodelRef?: ModelReference<CustomOptions>
    Optional reference to the model's configuration and custom options.
  - name: string
    The name of the model.
  - OptionalpluginOptions?: PluginOptions
  - OptionalrequestBuilder?: ModelRequestBuilder
Returns ModelAction
the created ModelAction
- Defined in plugins/compat-oai/src/model.ts:661