-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add systemInstruction and toolConfig (#89)
- Loading branch information
Showing
26 changed files
with
424 additions
and
4 deletions.
There are no files selected for viewing
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.functioncallingconfig.allowedfunctionnames.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) > [allowedFunctionNames](./generative-ai.functioncallingconfig.allowedfunctionnames.md) | ||
|
||
## FunctionCallingConfig.allowedFunctionNames property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
allowedFunctionNames?: string[]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) | ||
|
||
## FunctionCallingConfig interface | ||
|
||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface FunctionCallingConfig | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [allowedFunctionNames?](./generative-ai.functioncallingconfig.allowedfunctionnames.md) | | string\[\] | _(Optional)_ | | ||
| [mode?](./generative-ai.functioncallingconfig.mode.md) | | [FunctionCallingMode](./generative-ai.functioncallingmode.md) | _(Optional)_ | | ||
|
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.functioncallingconfig.mode.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) > [mode](./generative-ai.functioncallingconfig.mode.md) | ||
|
||
## FunctionCallingConfig.mode property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
mode?: FunctionCallingMode; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FunctionCallingMode](./generative-ai.functioncallingmode.md) | ||
|
||
## FunctionCallingMode enum | ||
|
||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare enum FunctionCallingMode | ||
``` | ||
|
||
## Enumeration Members | ||
|
||
| Member | Value | Description | | ||
| --- | --- | --- | | ||
| ANY | <code>"ANY"</code> | | | ||
| AUTO | <code>"AUTO"</code> | | | ||
| MODE\_UNSPECIFIED | <code>"MODE_UNSPECIFIED"</code> | | | ||
| NONE | <code>"NONE"</code> | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.generatecontentrequest.systeminstruction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentRequest](./generative-ai.generatecontentrequest.md) > [systemInstruction](./generative-ai.generatecontentrequest.systeminstruction.md) | ||
|
||
## GenerateContentRequest.systemInstruction property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
systemInstruction?: Content; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.generatecontentrequest.toolconfig.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerateContentRequest](./generative-ai.generatecontentrequest.md) > [toolConfig](./generative-ai.generatecontentrequest.toolconfig.md) | ||
|
||
## GenerateContentRequest.toolConfig property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
toolConfig?: ToolConfig; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.generativemodel.systeminstruction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [systemInstruction](./generative-ai.generativemodel.systeminstruction.md) | ||
|
||
## GenerativeModel.systemInstruction property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
systemInstruction?: Content; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.generativemodel.toolconfig.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [GenerativeModel](./generative-ai.generativemodel.md) > [toolConfig](./generative-ai.generativemodel.toolconfig.md) | ||
|
||
## GenerativeModel.toolConfig property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
toolConfig?: ToolConfig; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.modelparams.systeminstruction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ModelParams](./generative-ai.modelparams.md) > [systemInstruction](./generative-ai.modelparams.systeminstruction.md) | ||
|
||
## ModelParams.systemInstruction property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
systemInstruction?: Content; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ModelParams](./generative-ai.modelparams.md) > [toolConfig](./generative-ai.modelparams.toolconfig.md) | ||
|
||
## ModelParams.toolConfig property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
toolConfig?: ToolConfig; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.startchatparams.systeminstruction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StartChatParams](./generative-ai.startchatparams.md) > [systemInstruction](./generative-ai.startchatparams.systeminstruction.md) | ||
|
||
## StartChatParams.systemInstruction property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
systemInstruction?: Content; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.startchatparams.toolconfig.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [StartChatParams](./generative-ai.startchatparams.md) > [toolConfig](./generative-ai.startchatparams.toolconfig.md) | ||
|
||
## StartChatParams.toolConfig property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
toolConfig?: ToolConfig; | ||
``` |
11 changes: 11 additions & 0 deletions
11
docs/reference/generative-ai.toolconfig.functioncallingconfig.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ToolConfig](./generative-ai.toolconfig.md) > [functionCallingConfig](./generative-ai.toolconfig.functioncallingconfig.md) | ||
|
||
## ToolConfig.functionCallingConfig property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
functionCallingConfig: FunctionCallingConfig; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ToolConfig](./generative-ai.toolconfig.md) | ||
|
||
## ToolConfig interface | ||
|
||
Tool config. This config is shared for all tools provided in the request. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface ToolConfig | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [functionCallingConfig](./generative-ai.toolconfig.functioncallingconfig.md) | | [FunctionCallingConfig](./generative-ai.functioncallingconfig.md) | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.