문서 구절의 순위 재조정

REST API 요청 예

Copy link to section

이 예에서는 순위 재지정을 위해 5개의 구절만 제출되었습니다. 최대 1,000개의 입력을 지정할 수 있습니다. 그러나 지정하는 구절이 많을수록 교차 인코더 모델이 각 구절을 쿼리와 함께 차례로 처리하기 때문에 재랭크 프로세스가 더 오래 걸립니다.

제출하는 각 입력은 재랭커 모델에 정의된 최대 입력 토큰 한도를 준수해야 합니다.

구절에 모델에서 허용하는 것보다 많은 토큰이 있을 수 있는 경우를 해결하기 위해 이 예에서는 ' truncate_input_tokens 매개변수를 지정하여 줄을 강제로 잘라내도록 했습니다. 그렇지 않으면 요청이 실패할 수 있습니다.

이 예제에는 ' inputs 반환 옵션 매개변수가 포함되어 있어 원본 구절의 텍스트가 응답에 포함되므로 원본 구절의 순위가 어떻게 재조정되는지 더 쉽게 이해할 수 있습니다. 실제 워크플로에서는 ' inputs 매개변수를 포함할 필요가 없을 수도 있습니다.

텍스트 리랭커 메서드의 페이로드에 ' model_id '로 사용할 리랭커 모델을 지정합니다.

다음 예제에서{url}variable with the right value for your instance, such asus-south.ml.cloud.ibm.com 대체합니다. 고유한 무기명 토큰과 프로젝트 ID를 추가합니다.

curl -X POST \
  'https://{url}/ml/v1/text/rerank?version=2024-10-17' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer eyJraWQiOi...' \
  --data '{
      "inputs": [
        {
          "text": "A foundation model is a large-scale generative AI model that can be adapted to a wide range of downstream tasks."
        },
        {
          "text": "Generative AI is a class of AI algorithms that can produce various types of content including text, source code, imagery, audio, and synthetic data."
        },
        {
          "text": "Agentic AI is a generative AI flow that can decompose a prompt into multiple tasks, assign tasks to appropriate gen AI agents, and synthesize an answer without human intervention."
        },
        {
          "text": "AI ethics is a multidisciplinary field that studies how to optimize AI'\''s beneficial impact while reducing risks and adverse outcomes. Examples of AI ethics issues are data responsibility and privacy, fairness, explainability, robustness, transparency, environmental sustainability, inclusion, moral agency, value alignment, accountability, trust, and technology misuse."
        },
        {
          "text": "AI governance is an organization'\''s act of governing, through its corporate instructions, staff, processes and systems to direct, evaluate, monitor, and take corrective action throughout the AI lifecycle, to provide assurance that the AI system is operating as the organization intends, as its stakeholders expect, and as required by relevant regulation."
        }
      ],
      "query": "What is an agent-driven AI workflow?",
      "parameters":{
        "truncate_input_tokens": 512,
        "return_options":{
          "inputs":true
        }
      },
      "model_id": "cross-encoder/ms-marco-minilm-l-12-v2",
      "project_id": "51f3a990-4372-4ac3-9ddb-ed99d9b50840"
    }'
Copy to clipboard클립보드에 복사됨Show more

가장 높은 순위의 구절만 반환하려면 ' top_n 매개변수를 지정하면 됩니다. 다음 샘플은 모델에서 쿼리와 가장 관련성이 높은 한 구절만 반환하도록 지정하는 방법을 보여 줍니다:

"parameters":{
    "truncate_input_tokens": 512,
    "return_options":{
      "inputs":true,
      "top_n": 1
    }
}
Copy to clipboard클립보드에 복사됨

REST API 응답 예

Copy link to section

예제 요청에 대해 다음과 같은 응답이 반환됩니다. 몇 가지 주의해야 할 사항이 있습니다:

• 가장 높은 점수를 받은 구절이 먼저 표시되도록 구절의 순서가 변경됩니다.

  이 모델은 에이전트 중심 워크플로에 대한 질문과 가장 밀접한 관련이 있기 때문에 에이전트 AI에 대한 정의를 목록의 맨 위에 정확하게 반환합니다.

• 0-4 범위의 인덱스 값은 요청에 제출된 ' inputs 배열에 있는 구절의 원래 위치를 나타냅니다.

  예를 들어 에이전트 AI에 대한 구절은 목록에서 세 번째 구절이므로 색인 값은 ' 2' 입니다.

• ' input_token_count ' 필드에는 요청에 의해 처리된 총 토큰 수가 표시됩니다.

  토큰 계산 방법에 대한 자세한 내용은 청구 정보를 참조하세요.

{
  "model_id": "cross-encoder/ms-marco-minilm-l-12-v2",
  "created_at": "2024-10-17T14:01:47.322Z",
  "results": [
    {
      "index": 2,
      "score": 5.063366413116455,
      "input": {
        "text": "Agentic AI is a generative AI flow that can decompose a prompt into multiple tasks, assign tasks to appropriate gen AI agents, and synthesize an answer without human intervention."
      }
    },
    {
      "index": 4,
      "score": -0.992393970489502,
      "input": {
        "text": "AI governance is an organization's act of governing, through its corporate instructions, staff, processes and systems to direct, evaluate, monitor, and take corrective action throughout the AI lifecycle, to provide assurance that the AI system is operating as the organization intends, as its stakeholders expect, and as required by relevant regulation."
      }
    },
    {
      "index": 1,
      "score": -3.5372314453125,
      "input": {
        "text": "Generative AI is a class of AI algorithms that can produce various types of content including text, source code, imagery, audio, and synthetic data."
      }
    },
    {
      "index": 0,
      "score": -4.646212100982666,
      "input": {
        "text": "A foundation model is a large-scale generative AI model that can be adapted to a wide range of downstream tasks."
      }
    },
    {
      "index": 3,
      "score": -4.926990032196045,
      "input": {
        "text": "AI ethics is a multidisciplinary field that studies how to optimize AI's beneficial impact while reducing risks and adverse outcomes. Examples of AI ethics issues are data responsibility and privacy, fairness, explainability, robustness, transparency, environmental sustainability, inclusion, moral agency, value alignment, accountability, trust, and technology misuse."
      }
    }
  ],
  "input_token_count": 292,
  "system": {
    "warnings": [
      {
        "message": "This model is a Non-IBM Product governed by a third-party license that may impose use restrictions and other obligations. By using this model you agree to its terms as identified in the following URL.",
        "id": "disclaimer_warning",
        "more_info": "https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx"
      }
    ]
  }
}
Copy to clipboard클립보드에 복사됨Show more

이전 샘플과 같이 매개변수 객체에 ' "top_n": 1 '을 포함하면 응답은 다음과 같이 표시됩니다:

{
  "model_id": "cross-encoder/ms-marco-minilm-l-12-v2",
  "created_at": "2024-10-17T20:18:50.867Z",
  "results": [
    {
      "index": 2,
      "score": 5.063366413116455,
      "input": {
        "text": "Agentic AI is a generative AI flow that can decompose a prompt into multiple tasks, assign tasks to appropriate gen AI agents, and synthesize an answer without human intervention."
      }
    }
  ],
  "input_token_count": 292,
  "system": {
    "warnings": [
      {
        "message": "This model is a Non-IBM Product governed by a third-party license that may impose use restrictions and other obligations. By using this model you agree to its terms as identified in the following URL.",
        "id": "disclaimer_warning",
        "more_info": "https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx"
      }
    ]
  }
}
Copy to clipboard클립보드에 복사됨Show more