TypeScript
```typescript
import type { UserPromptSubmittedHookInput, HookInvocation, UserPromptSubmittedHookOutput } from "@github/copilot-sdk";
type UserPromptSubmittedHandler = (
input: UserPromptSubmittedHookInput,
invocation: HookInvocation
) => Promise
;
```
```typescript
type UserPromptSubmittedHandler = (
input: UserPromptSubmittedHookInput,
invocation: HookInvocation
) => Promise;
```
Python
```python
from copilot.session import UserPromptSubmittedHookInput, UserPromptSubmittedHookOutput
from typing import Callable, Awaitable
UserPromptSubmittedHandler = Callable[
[UserPromptSubmittedHookInput, dict[str, str]],
Awaitable[UserPromptSubmittedHookOutput | None]
]
```
```python
UserPromptSubmittedHandler = Callable[
[UserPromptSubmittedHookInput, dict[str, str]],
Awaitable[UserPromptSubmittedHookOutput | None]
]
```
Go
```golang
package main
import copilot "github.com/github/copilot-sdk/go"
type UserPromptSubmittedHandler func(
input copilot.UserPromptSubmittedHookInput,
invocation copilot.HookInvocation,
) (*copilot.UserPromptSubmittedHookOutput, error)
func main() {}
```
```golang
type UserPromptSubmittedHandler func(
input UserPromptSubmittedHookInput,
invocation HookInvocation,
) (*UserPromptSubmittedHookOutput, error)
```
.NET
```csharp
using GitHub.Copilot;
public delegate Task
UserPromptSubmittedHandler(
UserPromptSubmittedHookInput input,
HookInvocation invocation);
```
```csharp
public delegate Task UserPromptSubmittedHandler(
UserPromptSubmittedHookInput input,
HookInvocation invocation);
```
Java
```java
import com.github.copilot.rpc.*;
import java.util.concurrent.CompletableFuture;
public class UserPromptSubmittedSignature {
UserPromptSubmittedHandler handler = (UserPromptSubmittedHookInput input, HookInvocation invocation) ->
CompletableFuture.completedFuture(null);
public static void main(String[] args) {}
}
```
```java
@FunctionalInterface
public interface UserPromptSubmittedHandler {
CompletableFuture
handle(
UserPromptSubmittedHookInput input,
HookInvocation invocation);
}
```
## 入力
| フィールド | タイプ | 説明 |
| ----------- | ------ | --------------------------- |
| `timestamp` | number | フックがトリガーされたときの Unix タイムスタンプ |
| `cwd` | 文字列 | 現在の作業ディレクトリ |
| `prompt` | 文字列 | ユーザーが送信したプロンプト |
## アウトプット
プロンプトを変更せずに使用するには、 `null` または `undefined` を返します。 それ以外の場合は、次のいずれかのフィールドを持つオブジェクトを返します。
| フィールド | タイプ | 説明 |
| ------------------- | ------- | ----------------------------- |
| `modifiedPrompt` | 文字列 | 元のプロンプトの代わりに使用するように変更されたプロンプト |
| `additionalContext` | 文字列 | 会話に追加された追加のコンテキスト |
| `suppressOutput` | boolean | trueは、アシスタントの応答出力を抑制します |
## Examples
### すべてのユーザー プロンプトをログに記録する
TypeScript
```typescript
const session = await client.createSession({
hooks: {
onUserPromptSubmitted: async (input, invocation) => {
console.log(`[${invocation.sessionId}] User: ${input.prompt}`);
return null; // Pass through unchanged
},
},
});
```
Python
```python
from copilot.session import PermissionHandler
async def on_user_prompt_submitted(input_data, invocation):
print(f"[{invocation['session_id']}] User: {input_data['prompt']}")
return None
session = await client.create_session(on_permission_request=PermissionHandler.approve_all, hooks={"on_user_prompt_submitted": on_user_prompt_submitted})
```
Go
```golang
package main
import (
"context"
"fmt"
copilot "github.com/github/copilot-sdk/go"
)
func main() {
client := copilot.NewClient(nil)
session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{
OnPermissionRequest: copilot.PermissionHandler.ApproveAll,
Hooks: &copilot.SessionHooks{
OnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, inv copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {
fmt.Printf("[%s] User: %s\n", inv.SessionID, input.Prompt)
return nil, nil
},
},
})
_ = session
}
```
```golang
session, _ := client.CreateSession(context.Background(), &copilot.SessionConfig{
Hooks: &copilot.SessionHooks{
OnUserPromptSubmitted: func(input copilot.UserPromptSubmittedHookInput, inv copilot.HookInvocation) (*copilot.UserPromptSubmittedHookOutput, error) {
fmt.Printf("[%s] User: %s\n", inv.SessionID, input.Prompt)
return nil, nil
},
},
})
```
.NET
```csharp
using GitHub.Copilot;
public static class UserPromptSubmittedExample
{
public static async Task Main()
{
await using var client = new CopilotClient();
var session = await client.CreateSessionAsync(new SessionConfig
{
Hooks = new SessionHooks
{
OnUserPromptSubmitted = (input, invocation) =>
{
Console.WriteLine($"[{invocation.SessionId}] User: {input.Prompt}");
return Task.FromResult
(null);
},
},
});
}
}
```
```csharp
var session = await client.CreateSessionAsync(new SessionConfig
{
Hooks = new SessionHooks
{
OnUserPromptSubmitted = (input, invocation) =>
{
Console.WriteLine($"[{invocation.SessionId}] User: {input.Prompt}");
return Task.FromResult(null);
},
},
});
```
Java
```java
import com.github.copilot.*;
import com.github.copilot.rpc.*;
import java.util.concurrent.CompletableFuture;
var hooks = new SessionHooks()
.setOnUserPromptSubmitted((input, invocation) -> {
System.out.println("[" + invocation.getSessionId() + "] User: " + input.prompt());
return CompletableFuture.completedFuture(null);
});
var session = client.createSession(
new SessionConfig()
.setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
.setHooks(hooks)
).get();
```
### プロジェクト コンテキストを追加する
```typescript
const session = await client.createSession({
hooks: {
onUserPromptSubmitted: async (input) => {
const projectInfo = await getProjectInfo();
return {
additionalContext: `
Project: ${projectInfo.name}
Language: ${projectInfo.language}
Framework: ${projectInfo.framework}
`.trim(),
};
},
},
});
```
### 省略形コマンドを展開する
```typescript
const SHORTCUTS: Record